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"""
617
return os.path.getsize(self.id2abspath(file_id))
619
if e.errno != errno.ENOENT:
625
def get_file_sha1(self, file_id, path=None, stat_value=None):
627
path = self._inventory.id2path(file_id)
628
return self._hashcache.get_sha1(path, stat_value)
630
def get_file_mtime(self, file_id, path=None):
632
path = self.inventory.id2path(file_id)
633
return os.lstat(self.abspath(path)).st_mtime
635
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
636
file_id = self.path2id(path)
637
return self._inventory[file_id].executable
639
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
640
mode = stat_result.st_mode
641
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
643
if not supports_executable():
644
def is_executable(self, file_id, path=None):
645
return self._inventory[file_id].executable
647
_is_executable_from_path_and_stat = \
648
_is_executable_from_path_and_stat_from_basis
650
def is_executable(self, file_id, path=None):
652
path = self.id2path(file_id)
653
mode = os.lstat(self.abspath(path)).st_mode
654
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
656
_is_executable_from_path_and_stat = \
657
_is_executable_from_path_and_stat_from_stat
659
@needs_tree_write_lock
660
def _add(self, files, ids, kinds):
661
"""See MutableTree._add."""
662
# TODO: Re-adding a file that is removed in the working copy
663
# should probably put it back with the previous ID.
664
# the read and write working inventory should not occur in this
665
# function - they should be part of lock_write and unlock.
667
for f, file_id, kind in zip(files, ids, kinds):
669
inv.add_path(f, kind=kind)
671
inv.add_path(f, kind=kind, file_id=file_id)
672
self._inventory_is_modified = True
674
@needs_tree_write_lock
675
def _gather_kinds(self, files, kinds):
676
"""See MutableTree._gather_kinds."""
677
for pos, f in enumerate(files):
678
if kinds[pos] is None:
679
fullpath = normpath(self.abspath(f))
681
kinds[pos] = file_kind(fullpath)
683
if e.errno == errno.ENOENT:
684
raise errors.NoSuchFile(fullpath)
687
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
688
"""Add revision_id as a parent.
690
This is equivalent to retrieving the current list of parent ids
691
and setting the list to its value plus revision_id.
693
:param revision_id: The revision id to add to the parent list. It may
694
be a ghost revision as long as its not the first parent to be added,
695
or the allow_leftmost_as_ghost parameter is set True.
696
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
698
parents = self.get_parent_ids() + [revision_id]
699
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
700
or allow_leftmost_as_ghost)
702
@needs_tree_write_lock
703
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
704
"""Add revision_id, tree tuple as a parent.
706
This is equivalent to retrieving the current list of parent trees
707
and setting the list to its value plus parent_tuple. See also
708
add_parent_tree_id - if you only have a parent id available it will be
709
simpler to use that api. If you have the parent already available, using
710
this api is preferred.
712
:param parent_tuple: The (revision id, tree) to add to the parent list.
713
If the revision_id is a ghost, pass None for the tree.
714
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
716
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
717
if len(parent_ids) > 1:
718
# the leftmost may have already been a ghost, preserve that if it
720
allow_leftmost_as_ghost = True
721
self.set_parent_ids(parent_ids,
722
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
724
@needs_tree_write_lock
725
def add_pending_merge(self, *revision_ids):
726
# TODO: Perhaps should check at this point that the
727
# history of the revision is actually present?
728
parents = self.get_parent_ids()
730
for rev_id in revision_ids:
731
if rev_id in parents:
733
parents.append(rev_id)
736
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
738
def path_content_summary(self, path, _lstat=os.lstat,
739
_mapper=osutils.file_kind_from_stat_mode):
740
"""See Tree.path_content_summary."""
741
abspath = self.abspath(path)
743
stat_result = _lstat(abspath)
745
if getattr(e, 'errno', None) == errno.ENOENT:
747
return ('missing', None, None, None)
748
# propagate other errors
750
kind = _mapper(stat_result.st_mode)
752
size = stat_result.st_size
753
# try for a stat cache lookup
754
executable = self._is_executable_from_path_and_stat(path, stat_result)
755
return (kind, size, executable, self._sha_from_stat(
757
elif kind == 'directory':
758
# perhaps it looks like a plain directory, but it's really a
760
if self._directory_is_tree_reference(path):
761
kind = 'tree-reference'
762
return kind, None, None, None
763
elif kind == 'symlink':
764
target = osutils.readlink(abspath)
765
return ('symlink', None, None, target)
767
return (kind, None, None, None)
769
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
770
"""Common ghost checking functionality from set_parent_*.
772
This checks that the left hand-parent exists if there are any
775
if len(revision_ids) > 0:
776
leftmost_id = revision_ids[0]
777
if (not allow_leftmost_as_ghost and not
778
self.branch.repository.has_revision(leftmost_id)):
779
raise errors.GhostRevisionUnusableHere(leftmost_id)
781
def _set_merges_from_parent_ids(self, parent_ids):
782
merges = parent_ids[1:]
783
self._transport.put_bytes('pending-merges', '\n'.join(merges),
784
mode=self.bzrdir._get_file_mode())
786
def _filter_parent_ids_by_ancestry(self, revision_ids):
787
"""Check that all merged revisions are proper 'heads'.
789
This will always return the first revision_id, and any merged revisions
792
if len(revision_ids) == 0:
794
graph = self.branch.repository.get_graph()
795
heads = graph.heads(revision_ids)
796
new_revision_ids = revision_ids[:1]
797
for revision_id in revision_ids[1:]:
798
if revision_id in heads and revision_id not in new_revision_ids:
799
new_revision_ids.append(revision_id)
800
if new_revision_ids != revision_ids:
801
trace.mutter('requested to set revision_ids = %s,'
802
' but filtered to %s', revision_ids, new_revision_ids)
803
return new_revision_ids
805
@needs_tree_write_lock
806
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
807
"""Set the parent ids to revision_ids.
809
See also set_parent_trees. This api will try to retrieve the tree data
810
for each element of revision_ids from the trees repository. If you have
811
tree data already available, it is more efficient to use
812
set_parent_trees rather than set_parent_ids. set_parent_ids is however
813
an easier API to use.
815
:param revision_ids: The revision_ids to set as the parent ids of this
816
working tree. Any of these may be ghosts.
818
self._check_parents_for_ghosts(revision_ids,
819
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
820
for revision_id in revision_ids:
821
_mod_revision.check_not_reserved_id(revision_id)
823
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
825
if len(revision_ids) > 0:
826
self.set_last_revision(revision_ids[0])
828
self.set_last_revision(_mod_revision.NULL_REVISION)
830
self._set_merges_from_parent_ids(revision_ids)
832
@needs_tree_write_lock
833
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
834
"""See MutableTree.set_parent_trees."""
835
parent_ids = [rev for (rev, tree) in parents_list]
836
for revision_id in parent_ids:
837
_mod_revision.check_not_reserved_id(revision_id)
839
self._check_parents_for_ghosts(parent_ids,
840
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
842
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
844
if len(parent_ids) == 0:
845
leftmost_parent_id = _mod_revision.NULL_REVISION
846
leftmost_parent_tree = None
848
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
850
if self._change_last_revision(leftmost_parent_id):
851
if leftmost_parent_tree is None:
852
# If we don't have a tree, fall back to reading the
853
# parent tree from the repository.
854
self._cache_basis_inventory(leftmost_parent_id)
856
inv = leftmost_parent_tree.inventory
857
xml = self._create_basis_xml_from_inventory(
858
leftmost_parent_id, inv)
859
self._write_basis_inventory(xml)
860
self._set_merges_from_parent_ids(parent_ids)
862
@needs_tree_write_lock
863
def set_pending_merges(self, rev_list):
864
parents = self.get_parent_ids()
865
leftmost = parents[:1]
866
new_parents = leftmost + rev_list
867
self.set_parent_ids(new_parents)
869
@needs_tree_write_lock
870
def set_merge_modified(self, modified_hashes):
872
for file_id, hash in modified_hashes.iteritems():
873
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
874
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
876
def _sha_from_stat(self, path, stat_result):
877
"""Get a sha digest from the tree's stat cache.
879
The default implementation assumes no stat cache is present.
881
:param path: The path.
882
:param stat_result: The stat result being looked up.
886
def _put_rio(self, filename, stanzas, header):
887
self._must_be_locked()
888
my_file = rio_file(stanzas, header)
889
self._transport.put_file(filename, my_file,
890
mode=self.bzrdir._get_file_mode())
892
@needs_write_lock # because merge pulls data into the branch.
893
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
895
"""Merge from a branch into this working tree.
897
:param branch: The branch to merge from.
898
:param to_revision: If non-None, the merge will merge to to_revision,
899
but not beyond it. to_revision does not need to be in the history
900
of the branch when it is supplied. If None, to_revision defaults to
901
branch.last_revision().
903
from bzrlib.merge import Merger, Merge3Merger
904
pb = ui.ui_factory.nested_progress_bar()
906
merger = Merger(self.branch, this_tree=self, pb=pb)
907
merger.pp = ProgressPhase("Merge phase", 5, pb)
908
merger.pp.next_phase()
909
# check that there are no
911
merger.check_basis(check_clean=True, require_commits=False)
912
if to_revision is None:
913
to_revision = _mod_revision.ensure_null(branch.last_revision())
914
merger.other_rev_id = to_revision
915
if _mod_revision.is_null(merger.other_rev_id):
916
raise errors.NoCommits(branch)
917
self.branch.fetch(branch, last_revision=merger.other_rev_id)
918
merger.other_basis = merger.other_rev_id
919
merger.other_tree = self.branch.repository.revision_tree(
921
merger.other_branch = branch
922
merger.pp.next_phase()
923
if from_revision is None:
926
merger.set_base_revision(from_revision, branch)
927
if merger.base_rev_id == merger.other_rev_id:
928
raise errors.PointlessMerge
929
merger.backup_files = False
930
if merge_type is None:
931
merger.merge_type = Merge3Merger
933
merger.merge_type = merge_type
934
merger.set_interesting_files(None)
935
merger.show_base = False
936
merger.reprocess = False
937
conflicts = merger.do_merge()
944
def merge_modified(self):
945
"""Return a dictionary of files modified by a merge.
947
The list is initialized by WorkingTree.set_merge_modified, which is
948
typically called after we make some automatic updates to the tree
951
This returns a map of file_id->sha1, containing only files which are
952
still in the working inventory and have that text hash.
955
hashfile = self._transport.get('merge-hashes')
956
except errors.NoSuchFile:
961
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
962
raise errors.MergeModifiedFormatError()
963
except StopIteration:
964
raise errors.MergeModifiedFormatError()
965
for s in RioReader(hashfile):
966
# RioReader reads in Unicode, so convert file_ids back to utf8
967
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
968
if file_id not in self.inventory:
970
text_hash = s.get("hash")
971
if text_hash == self.get_file_sha1(file_id):
972
merge_hashes[file_id] = text_hash
978
def mkdir(self, path, file_id=None):
979
"""See MutableTree.mkdir()."""
981
file_id = generate_ids.gen_file_id(os.path.basename(path))
982
os.mkdir(self.abspath(path))
983
self.add(path, file_id, 'directory')
986
def get_symlink_target(self, file_id):
987
abspath = self.id2abspath(file_id)
988
target = osutils.readlink(abspath)
992
def subsume(self, other_tree):
993
def add_children(inventory, entry):
994
for child_entry in entry.children.values():
995
inventory._byid[child_entry.file_id] = child_entry
996
if child_entry.kind == 'directory':
997
add_children(inventory, child_entry)
998
if other_tree.get_root_id() == self.get_root_id():
999
raise errors.BadSubsumeSource(self, other_tree,
1000
'Trees have the same root')
1002
other_tree_path = self.relpath(other_tree.basedir)
1003
except errors.PathNotChild:
1004
raise errors.BadSubsumeSource(self, other_tree,
1005
'Tree is not contained by the other')
1006
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1007
if new_root_parent is None:
1008
raise errors.BadSubsumeSource(self, other_tree,
1009
'Parent directory is not versioned.')
1010
# We need to ensure that the result of a fetch will have a
1011
# versionedfile for the other_tree root, and only fetching into
1012
# RepositoryKnit2 guarantees that.
1013
if not self.branch.repository.supports_rich_root():
1014
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1015
other_tree.lock_tree_write()
1017
new_parents = other_tree.get_parent_ids()
1018
other_root = other_tree.inventory.root
1019
other_root.parent_id = new_root_parent
1020
other_root.name = osutils.basename(other_tree_path)
1021
self.inventory.add(other_root)
1022
add_children(self.inventory, other_root)
1023
self._write_inventory(self.inventory)
1024
# normally we don't want to fetch whole repositories, but i think
1025
# here we really do want to consolidate the whole thing.
1026
for parent_id in other_tree.get_parent_ids():
1027
self.branch.fetch(other_tree.branch, parent_id)
1028
self.add_parent_tree_id(parent_id)
1031
other_tree.bzrdir.retire_bzrdir()
1033
def _setup_directory_is_tree_reference(self):
1034
if self._branch.repository._format.supports_tree_reference:
1035
self._directory_is_tree_reference = \
1036
self._directory_may_be_tree_reference
1038
self._directory_is_tree_reference = \
1039
self._directory_is_never_tree_reference
1041
def _directory_is_never_tree_reference(self, relpath):
1044
def _directory_may_be_tree_reference(self, relpath):
1045
# as a special case, if a directory contains control files then
1046
# it's a tree reference, except that the root of the tree is not
1047
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1048
# TODO: We could ask all the control formats whether they
1049
# recognize this directory, but at the moment there's no cheap api
1050
# to do that. Since we probably can only nest bzr checkouts and
1051
# they always use this name it's ok for now. -- mbp 20060306
1053
# FIXME: There is an unhandled case here of a subdirectory
1054
# containing .bzr but not a branch; that will probably blow up
1055
# when you try to commit it. It might happen if there is a
1056
# checkout in a subdirectory. This can be avoided by not adding
1059
@needs_tree_write_lock
1060
def extract(self, file_id, format=None):
1061
"""Extract a subtree from this tree.
1063
A new branch will be created, relative to the path for this tree.
1067
segments = osutils.splitpath(path)
1068
transport = self.branch.bzrdir.root_transport
1069
for name in segments:
1070
transport = transport.clone(name)
1071
transport.ensure_base()
1074
sub_path = self.id2path(file_id)
1075
branch_transport = mkdirs(sub_path)
1077
format = self.bzrdir.cloning_metadir()
1078
branch_transport.ensure_base()
1079
branch_bzrdir = format.initialize_on_transport(branch_transport)
1081
repo = branch_bzrdir.find_repository()
1082
except errors.NoRepositoryPresent:
1083
repo = branch_bzrdir.create_repository()
1084
if not repo.supports_rich_root():
1085
raise errors.RootNotRich()
1086
new_branch = branch_bzrdir.create_branch()
1087
new_branch.pull(self.branch)
1088
for parent_id in self.get_parent_ids():
1089
new_branch.fetch(self.branch, parent_id)
1090
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1091
if tree_transport.base != branch_transport.base:
1092
tree_bzrdir = format.initialize_on_transport(tree_transport)
1093
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1095
tree_bzrdir = branch_bzrdir
1096
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1097
wt.set_parent_ids(self.get_parent_ids())
1098
my_inv = self.inventory
1099
child_inv = inventory.Inventory(root_id=None)
1100
new_root = my_inv[file_id]
1101
my_inv.remove_recursive_id(file_id)
1102
new_root.parent_id = None
1103
child_inv.add(new_root)
1104
self._write_inventory(my_inv)
1105
wt._write_inventory(child_inv)
1108
def _serialize(self, inventory, out_file):
1109
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1112
def _deserialize(selt, in_file):
1113
return xml5.serializer_v5.read_inventory(in_file)
1116
"""Write the in memory inventory to disk."""
1117
# TODO: Maybe this should only write on dirty ?
1118
if self._control_files._lock_mode != 'w':
1119
raise errors.NotWriteLocked(self)
1121
self._serialize(self._inventory, sio)
1123
self._transport.put_file('inventory', sio,
1124
mode=self.bzrdir._get_file_mode())
1125
self._inventory_is_modified = False
1127
def _kind(self, relpath):
1128
return osutils.file_kind(self.abspath(relpath))
1130
def list_files(self, include_root=False, from_dir=None, recursive=True):
1131
"""List all files as (path, class, kind, id, entry).
1133
Lists, but does not descend into unversioned directories.
1134
This does not include files that have been deleted in this
1135
tree. Skips the control directory.
1137
:param include_root: if True, do not return an entry for the root
1138
:param from_dir: start from this directory or None for the root
1139
:param recursive: whether to recurse into subdirectories or not
1141
# list_files is an iterator, so @needs_read_lock doesn't work properly
1142
# with it. So callers should be careful to always read_lock the tree.
1143
if not self.is_locked():
1144
raise errors.ObjectNotLocked(self)
1146
inv = self.inventory
1147
if from_dir is None and include_root is True:
1148
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1149
# Convert these into local objects to save lookup times
1150
pathjoin = osutils.pathjoin
1151
file_kind = self._kind
1153
# transport.base ends in a slash, we want the piece
1154
# between the last two slashes
1155
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1157
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1159
# directory file_id, relative path, absolute path, reverse sorted children
1160
if from_dir is not None:
1161
from_dir_id = inv.path2id(from_dir)
1162
if from_dir_id is None:
1163
# Directory not versioned
1165
from_dir_abspath = pathjoin(self.basedir, from_dir)
1167
from_dir_id = inv.root.file_id
1168
from_dir_abspath = self.basedir
1169
children = os.listdir(from_dir_abspath)
1171
# jam 20060527 The kernel sized tree seems equivalent whether we
1172
# use a deque and popleft to keep them sorted, or if we use a plain
1173
# list and just reverse() them.
1174
children = collections.deque(children)
1175
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1177
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1180
f = children.popleft()
1181
## TODO: If we find a subdirectory with its own .bzr
1182
## directory, then that is a separate tree and we
1183
## should exclude it.
1185
# the bzrdir for this tree
1186
if transport_base_dir == f:
1189
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1190
# and 'f' doesn't begin with one, we can do a string op, rather
1191
# than the checks of pathjoin(), all relative paths will have an extra slash
1193
fp = from_dir_relpath + '/' + f
1196
fap = from_dir_abspath + '/' + f
1198
f_ie = inv.get_child(from_dir_id, f)
1201
elif self.is_ignored(fp[1:]):
1204
# we may not have found this file, because of a unicode issue
1205
f_norm, can_access = osutils.normalized_filename(f)
1206
if f == f_norm or not can_access:
1207
# No change, so treat this file normally
1210
# this file can be accessed by a normalized path
1211
# check again if it is versioned
1212
# these lines are repeated here for performance
1214
fp = from_dir_relpath + '/' + f
1215
fap = from_dir_abspath + '/' + f
1216
f_ie = inv.get_child(from_dir_id, f)
1219
elif self.is_ignored(fp[1:]):
1226
# make a last minute entry
1228
yield fp[1:], c, fk, f_ie.file_id, f_ie
1231
yield fp[1:], c, fk, None, fk_entries[fk]()
1233
yield fp[1:], c, fk, None, TreeEntry()
1236
if fk != 'directory':
1239
# But do this child first if recursing down
1241
new_children = os.listdir(fap)
1243
new_children = collections.deque(new_children)
1244
stack.append((f_ie.file_id, fp, fap, new_children))
1245
# Break out of inner loop,
1246
# so that we start outer loop with child
1249
# if we finished all children, pop it off the stack
1252
@needs_tree_write_lock
1253
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1256
to_dir must exist in the inventory.
1258
If to_dir exists and is a directory, the files are moved into
1259
it, keeping their old names.
1261
Note that to_dir is only the last component of the new name;
1262
this doesn't change the directory.
1264
For each entry in from_paths the move mode will be determined
1267
The first mode moves the file in the filesystem and updates the
1268
inventory. The second mode only updates the inventory without
1269
touching the file on the filesystem. This is the new mode introduced
1272
move uses the second mode if 'after == True' and the target is not
1273
versioned but present in the working tree.
1275
move uses the second mode if 'after == False' and the source is
1276
versioned but no longer in the working tree, and the target is not
1277
versioned but present in the working tree.
1279
move uses the first mode if 'after == False' and the source is
1280
versioned and present in the working tree, and the target is not
1281
versioned and not present in the working tree.
1283
Everything else results in an error.
1285
This returns a list of (from_path, to_path) pairs for each
1286
entry that is moved.
1291
# check for deprecated use of signature
1293
to_dir = kwargs.get('to_name', None)
1295
raise TypeError('You must supply a target directory')
1297
symbol_versioning.warn('The parameter to_name was deprecated'
1298
' in version 0.13. Use to_dir instead',
1301
# check destination directory
1302
if isinstance(from_paths, basestring):
1304
inv = self.inventory
1305
to_abs = self.abspath(to_dir)
1306
if not isdir(to_abs):
1307
raise errors.BzrMoveFailedError('',to_dir,
1308
errors.NotADirectory(to_abs))
1309
if not self.has_filename(to_dir):
1310
raise errors.BzrMoveFailedError('',to_dir,
1311
errors.NotInWorkingDirectory(to_dir))
1312
to_dir_id = inv.path2id(to_dir)
1313
if to_dir_id is None:
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotVersionedError(path=str(to_dir)))
1317
to_dir_ie = inv[to_dir_id]
1318
if to_dir_ie.kind != 'directory':
1319
raise errors.BzrMoveFailedError('',to_dir,
1320
errors.NotADirectory(to_abs))
1322
# create rename entries and tuples
1323
for from_rel in from_paths:
1324
from_tail = splitpath(from_rel)[-1]
1325
from_id = inv.path2id(from_rel)
1327
raise errors.BzrMoveFailedError(from_rel,to_dir,
1328
errors.NotVersionedError(path=str(from_rel)))
1330
from_entry = inv[from_id]
1331
from_parent_id = from_entry.parent_id
1332
to_rel = pathjoin(to_dir, from_tail)
1333
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1335
from_tail=from_tail,
1336
from_parent_id=from_parent_id,
1337
to_rel=to_rel, to_tail=from_tail,
1338
to_parent_id=to_dir_id)
1339
rename_entries.append(rename_entry)
1340
rename_tuples.append((from_rel, to_rel))
1342
# determine which move mode to use. checks also for movability
1343
rename_entries = self._determine_mv_mode(rename_entries, after)
1345
original_modified = self._inventory_is_modified
1348
self._inventory_is_modified = True
1349
self._move(rename_entries)
1351
# restore the inventory on error
1352
self._inventory_is_modified = original_modified
1354
self._write_inventory(inv)
1355
return rename_tuples
1357
def _determine_mv_mode(self, rename_entries, after=False):
1358
"""Determines for each from-to pair if both inventory and working tree
1359
or only the inventory has to be changed.
1361
Also does basic plausability tests.
1363
inv = self.inventory
1365
for rename_entry in rename_entries:
1366
# store to local variables for easier reference
1367
from_rel = rename_entry.from_rel
1368
from_id = rename_entry.from_id
1369
to_rel = rename_entry.to_rel
1370
to_id = inv.path2id(to_rel)
1371
only_change_inv = False
1373
# check the inventory for source and destination
1375
raise errors.BzrMoveFailedError(from_rel,to_rel,
1376
errors.NotVersionedError(path=str(from_rel)))
1377
if to_id is not None:
1378
raise errors.BzrMoveFailedError(from_rel,to_rel,
1379
errors.AlreadyVersionedError(path=str(to_rel)))
1381
# try to determine the mode for rename (only change inv or change
1382
# inv and file system)
1384
if not self.has_filename(to_rel):
1385
raise errors.BzrMoveFailedError(from_id,to_rel,
1386
errors.NoSuchFile(path=str(to_rel),
1387
extra="New file has not been created yet"))
1388
only_change_inv = True
1389
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1390
only_change_inv = True
1391
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1392
only_change_inv = False
1393
elif (not self.case_sensitive
1394
and from_rel.lower() == to_rel.lower()
1395
and self.has_filename(from_rel)):
1396
only_change_inv = False
1398
# something is wrong, so lets determine what exactly
1399
if not self.has_filename(from_rel) and \
1400
not self.has_filename(to_rel):
1401
raise errors.BzrRenameFailedError(from_rel,to_rel,
1402
errors.PathsDoNotExist(paths=(str(from_rel),
1405
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1406
rename_entry.only_change_inv = only_change_inv
1407
return rename_entries
1409
def _move(self, rename_entries):
1410
"""Moves a list of files.
1412
Depending on the value of the flag 'only_change_inv', the
1413
file will be moved on the file system or not.
1415
inv = self.inventory
1418
for entry in rename_entries:
1420
self._move_entry(entry)
1422
self._rollback_move(moved)
1426
def _rollback_move(self, moved):
1427
"""Try to rollback a previous move in case of an filesystem error."""
1428
inv = self.inventory
1431
self._move_entry(WorkingTree._RenameEntry(
1432
entry.to_rel, entry.from_id,
1433
entry.to_tail, entry.to_parent_id, entry.from_rel,
1434
entry.from_tail, entry.from_parent_id,
1435
entry.only_change_inv))
1436
except errors.BzrMoveFailedError, e:
1437
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1438
" The working tree is in an inconsistent state."
1439
" Please consider doing a 'bzr revert'."
1440
" Error message is: %s" % e)
1442
def _move_entry(self, entry):
1443
inv = self.inventory
1444
from_rel_abs = self.abspath(entry.from_rel)
1445
to_rel_abs = self.abspath(entry.to_rel)
1446
if from_rel_abs == to_rel_abs:
1447
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1448
"Source and target are identical.")
1450
if not entry.only_change_inv:
1452
osutils.rename(from_rel_abs, to_rel_abs)
1454
raise errors.BzrMoveFailedError(entry.from_rel,
1456
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1458
@needs_tree_write_lock
1459
def rename_one(self, from_rel, to_rel, after=False):
1462
This can change the directory or the filename or both.
1464
rename_one has several 'modes' to work. First, it can rename a physical
1465
file and change the file_id. That is the normal mode. Second, it can
1466
only change the file_id without touching any physical file. This is
1467
the new mode introduced in version 0.15.
1469
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1470
versioned but present in the working tree.
1472
rename_one uses the second mode if 'after == False' and 'from_rel' is
1473
versioned but no longer in the working tree, and 'to_rel' is not
1474
versioned but present in the working tree.
1476
rename_one uses the first mode if 'after == False' and 'from_rel' is
1477
versioned and present in the working tree, and 'to_rel' is not
1478
versioned and not present in the working tree.
1480
Everything else results in an error.
1482
inv = self.inventory
1485
# create rename entries and tuples
1486
from_tail = splitpath(from_rel)[-1]
1487
from_id = inv.path2id(from_rel)
1489
# if file is missing in the inventory maybe it's in the basis_tree
1490
basis_tree = self.branch.basis_tree()
1491
from_id = basis_tree.path2id(from_rel)
1493
raise errors.BzrRenameFailedError(from_rel,to_rel,
1494
errors.NotVersionedError(path=str(from_rel)))
1495
# put entry back in the inventory so we can rename it
1496
from_entry = basis_tree.inventory[from_id].copy()
1499
from_entry = inv[from_id]
1500
from_parent_id = from_entry.parent_id
1501
to_dir, to_tail = os.path.split(to_rel)
1502
to_dir_id = inv.path2id(to_dir)
1503
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1505
from_tail=from_tail,
1506
from_parent_id=from_parent_id,
1507
to_rel=to_rel, to_tail=to_tail,
1508
to_parent_id=to_dir_id)
1509
rename_entries.append(rename_entry)
1511
# determine which move mode to use. checks also for movability
1512
rename_entries = self._determine_mv_mode(rename_entries, after)
1514
# check if the target changed directory and if the target directory is
1516
if to_dir_id is None:
1517
raise errors.BzrMoveFailedError(from_rel,to_rel,
1518
errors.NotVersionedError(path=str(to_dir)))
1520
# all checks done. now we can continue with our actual work
1521
mutter('rename_one:\n'
1526
' to_dir_id {%s}\n',
1527
from_id, from_rel, to_rel, to_dir, to_dir_id)
1529
self._move(rename_entries)
1530
self._write_inventory(inv)
1532
class _RenameEntry(object):
1533
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1534
to_rel, to_tail, to_parent_id, only_change_inv=False):
1535
self.from_rel = from_rel
1536
self.from_id = from_id
1537
self.from_tail = from_tail
1538
self.from_parent_id = from_parent_id
1539
self.to_rel = to_rel
1540
self.to_tail = to_tail
1541
self.to_parent_id = to_parent_id
1542
self.only_change_inv = only_change_inv
1546
"""Return all unknown files.
1548
These are files in the working directory that are not versioned or
1549
control files or ignored.
1551
# force the extras method to be fully executed before returning, to
1552
# prevent race conditions with the lock
1554
[subp for subp in self.extras() if not self.is_ignored(subp)])
1556
@needs_tree_write_lock
1557
def unversion(self, file_ids):
1558
"""Remove the file ids in file_ids from the current versioned set.
1560
When a file_id is unversioned, all of its children are automatically
1563
:param file_ids: The file ids to stop versioning.
1564
:raises: NoSuchId if any fileid is not currently versioned.
1566
for file_id in file_ids:
1567
if file_id not in self._inventory:
1568
raise errors.NoSuchId(self, file_id)
1569
for file_id in file_ids:
1570
if self._inventory.has_id(file_id):
1571
self._inventory.remove_recursive_id(file_id)
1573
# in the future this should just set a dirty bit to wait for the
1574
# final unlock. However, until all methods of workingtree start
1575
# with the current in -memory inventory rather than triggering
1576
# a read, it is more complex - we need to teach read_inventory
1577
# to know when to read, and when to not read first... and possibly
1578
# to save first when the in memory one may be corrupted.
1579
# so for now, we just only write it if it is indeed dirty.
1581
self._write_inventory(self._inventory)
1583
def _iter_conflicts(self):
1585
for info in self.list_files():
1587
stem = get_conflicted_stem(path)
1590
if stem not in conflicted:
1591
conflicted.add(stem)
1595
def pull(self, source, overwrite=False, stop_revision=None,
1596
change_reporter=None, possible_transports=None, local=False):
1597
top_pb = ui.ui_factory.nested_progress_bar()
1600
pp = ProgressPhase("Pull phase", 2, top_pb)
1602
old_revision_info = self.branch.last_revision_info()
1603
basis_tree = self.basis_tree()
1604
count = self.branch.pull(source, overwrite, stop_revision,
1605
possible_transports=possible_transports,
1607
new_revision_info = self.branch.last_revision_info()
1608
if new_revision_info != old_revision_info:
1610
repository = self.branch.repository
1611
pb = ui.ui_factory.nested_progress_bar()
1612
basis_tree.lock_read()
1614
new_basis_tree = self.branch.basis_tree()
1621
change_reporter=change_reporter)
1622
if (basis_tree.inventory.root is None and
1623
new_basis_tree.inventory.root is not None):
1624
self.set_root_id(new_basis_tree.get_root_id())
1628
# TODO - dedup parents list with things merged by pull ?
1629
# reuse the revisiontree we merged against to set the new
1631
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1632
# we have to pull the merge trees out again, because
1633
# merge_inner has set the ids. - this corner is not yet
1634
# layered well enough to prevent double handling.
1635
# XXX TODO: Fix the double handling: telling the tree about
1636
# the already known parent data is wasteful.
1637
merges = self.get_parent_ids()[1:]
1638
parent_trees.extend([
1639
(parent, repository.revision_tree(parent)) for
1641
self.set_parent_trees(parent_trees)
1648
def put_file_bytes_non_atomic(self, file_id, bytes):
1649
"""See MutableTree.put_file_bytes_non_atomic."""
1650
stream = file(self.id2abspath(file_id), 'wb')
1655
# TODO: update the hashcache here ?
1658
"""Yield all unversioned files in this WorkingTree.
1660
If there are any unversioned directories then only the directory is
1661
returned, not all its children. But if there are unversioned files
1662
under a versioned subdirectory, they are returned.
1664
Currently returned depth-first, sorted by name within directories.
1665
This is the same order used by 'osutils.walkdirs'.
1667
## TODO: Work from given directory downwards
1668
for path, dir_entry in self.inventory.directories():
1669
# mutter("search for unknowns in %r", path)
1670
dirabs = self.abspath(path)
1671
if not isdir(dirabs):
1672
# e.g. directory deleted
1676
for subf in os.listdir(dirabs):
1677
if self.bzrdir.is_control_filename(subf):
1679
if subf not in dir_entry.children:
1682
can_access) = osutils.normalized_filename(subf)
1683
except UnicodeDecodeError:
1684
path_os_enc = path.encode(osutils._fs_enc)
1685
relpath = path_os_enc + '/' + subf
1686
raise errors.BadFilenameEncoding(relpath,
1688
if subf_norm != subf and can_access:
1689
if subf_norm not in dir_entry.children:
1690
fl.append(subf_norm)
1696
subp = pathjoin(path, subf)
1699
def ignored_files(self):
1700
"""Yield list of PATH, IGNORE_PATTERN"""
1701
for subp in self.extras():
1702
pat = self.is_ignored(subp)
1706
def get_ignore_list(self):
1707
"""Return list of ignore patterns.
1709
Cached in the Tree object after the first call.
1711
ignoreset = getattr(self, '_ignoreset', None)
1712
if ignoreset is not None:
1715
ignore_globs = set()
1716
ignore_globs.update(ignores.get_runtime_ignores())
1717
ignore_globs.update(ignores.get_user_ignores())
1718
if self.has_filename(bzrlib.IGNORE_FILENAME):
1719
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1721
ignore_globs.update(ignores.parse_ignore_file(f))
1724
self._ignoreset = ignore_globs
1727
def _flush_ignore_list_cache(self):
1728
"""Resets the cached ignore list to force a cache rebuild."""
1729
self._ignoreset = None
1730
self._ignoreglobster = None
1732
def is_ignored(self, filename):
1733
r"""Check whether the filename matches an ignore pattern.
1735
Patterns containing '/' or '\' need to match the whole path;
1736
others match against only the last component.
1738
If the file is ignored, returns the pattern which caused it to
1739
be ignored, otherwise None. So this can simply be used as a
1740
boolean if desired."""
1741
if getattr(self, '_ignoreglobster', None) is None:
1742
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1743
return self._ignoreglobster.match(filename)
1745
def kind(self, file_id):
1746
return file_kind(self.id2abspath(file_id))
1748
def stored_kind(self, file_id):
1749
"""See Tree.stored_kind"""
1750
return self.inventory[file_id].kind
1752
def _comparison_data(self, entry, path):
1753
abspath = self.abspath(path)
1755
stat_value = os.lstat(abspath)
1757
if getattr(e, 'errno', None) == errno.ENOENT:
1764
mode = stat_value.st_mode
1765
kind = osutils.file_kind_from_stat_mode(mode)
1766
if not supports_executable():
1767
executable = entry is not None and entry.executable
1769
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1770
return kind, executable, stat_value
1772
def _file_size(self, entry, stat_value):
1773
return stat_value.st_size
1775
def last_revision(self):
1776
"""Return the last revision of the branch for this tree.
1778
This format tree does not support a separate marker for last-revision
1779
compared to the branch.
1781
See MutableTree.last_revision
1783
return self._last_revision()
1786
def _last_revision(self):
1787
"""helper for get_parent_ids."""
1788
return _mod_revision.ensure_null(self.branch.last_revision())
1790
def is_locked(self):
1791
return self._control_files.is_locked()
1793
def _must_be_locked(self):
1794
if not self.is_locked():
1795
raise errors.ObjectNotLocked(self)
1797
def lock_read(self):
1798
"""See Branch.lock_read, and WorkingTree.unlock."""
1799
if not self.is_locked():
1801
self.branch.lock_read()
1803
return self._control_files.lock_read()
1805
self.branch.unlock()
1808
def lock_tree_write(self):
1809
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1810
if not self.is_locked():
1812
self.branch.lock_read()
1814
return self._control_files.lock_write()
1816
self.branch.unlock()
1819
def lock_write(self):
1820
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1821
if not self.is_locked():
1823
self.branch.lock_write()
1825
return self._control_files.lock_write()
1827
self.branch.unlock()
1830
def get_physical_lock_status(self):
1831
return self._control_files.get_physical_lock_status()
1833
def _basis_inventory_name(self):
1834
return 'basis-inventory-cache'
1836
def _reset_data(self):
1837
"""Reset transient data that cannot be revalidated."""
1838
self._inventory_is_modified = False
1839
result = self._deserialize(self._transport.get('inventory'))
1840
self._set_inventory(result, dirty=False)
1842
@needs_tree_write_lock
1843
def set_last_revision(self, new_revision):
1844
"""Change the last revision in the working tree."""
1845
if self._change_last_revision(new_revision):
1846
self._cache_basis_inventory(new_revision)
1848
def _change_last_revision(self, new_revision):
1849
"""Template method part of set_last_revision to perform the change.
1851
This is used to allow WorkingTree3 instances to not affect branch
1852
when their last revision is set.
1854
if _mod_revision.is_null(new_revision):
1855
self.branch.set_revision_history([])
1858
self.branch.generate_revision_history(new_revision)
1859
except errors.NoSuchRevision:
1860
# not present in the repo - dont try to set it deeper than the tip
1861
self.branch.set_revision_history([new_revision])
1864
def _write_basis_inventory(self, xml):
1865
"""Write the basis inventory XML to the basis-inventory file"""
1866
path = self._basis_inventory_name()
1868
self._transport.put_file(path, sio,
1869
mode=self.bzrdir._get_file_mode())
1871
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1872
"""Create the text that will be saved in basis-inventory"""
1873
inventory.revision_id = revision_id
1874
return xml7.serializer_v7.write_inventory_to_string(inventory)
1876
def _cache_basis_inventory(self, new_revision):
1877
"""Cache new_revision as the basis inventory."""
1878
# TODO: this should allow the ready-to-use inventory to be passed in,
1879
# as commit already has that ready-to-use [while the format is the
1882
# this double handles the inventory - unpack and repack -
1883
# but is easier to understand. We can/should put a conditional
1884
# in here based on whether the inventory is in the latest format
1885
# - perhaps we should repack all inventories on a repository
1887
# the fast path is to copy the raw xml from the repository. If the
1888
# xml contains 'revision_id="', then we assume the right
1889
# revision_id is set. We must check for this full string, because a
1890
# root node id can legitimately look like 'revision_id' but cannot
1892
xml = self.branch.repository.get_inventory_xml(new_revision)
1893
firstline = xml.split('\n', 1)[0]
1894
if (not 'revision_id="' in firstline or
1895
'format="7"' not in firstline):
1896
inv = self.branch.repository._serializer.read_inventory_from_string(
1898
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1899
self._write_basis_inventory(xml)
1900
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1903
def read_basis_inventory(self):
1904
"""Read the cached basis inventory."""
1905
path = self._basis_inventory_name()
1906
return self._transport.get_bytes(path)
1909
def read_working_inventory(self):
1910
"""Read the working inventory.
1912
:raises errors.InventoryModified: read_working_inventory will fail
1913
when the current in memory inventory has been modified.
1915
# conceptually this should be an implementation detail of the tree.
1916
# XXX: Deprecate this.
1917
# ElementTree does its own conversion from UTF-8, so open in
1919
if self._inventory_is_modified:
1920
raise errors.InventoryModified(self)
1921
result = self._deserialize(self._transport.get('inventory'))
1922
self._set_inventory(result, dirty=False)
1925
@needs_tree_write_lock
1926
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1928
"""Remove nominated files from the working inventory.
1930
:files: File paths relative to the basedir.
1931
:keep_files: If true, the files will also be kept.
1932
:force: Delete files and directories, even if they are changed and
1933
even if the directories are not empty.
1935
if isinstance(files, basestring):
1941
unknown_nested_files=set()
1943
def recurse_directory_to_add_files(directory):
1944
# Recurse directory and add all files
1945
# so we can check if they have changed.
1946
for parent_info, file_infos in\
1947
self.walkdirs(directory):
1948
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1949
# Is it versioned or ignored?
1950
if self.path2id(relpath) or self.is_ignored(relpath):
1951
# Add nested content for deletion.
1952
new_files.add(relpath)
1954
# Files which are not versioned and not ignored
1955
# should be treated as unknown.
1956
unknown_nested_files.add((relpath, None, kind))
1958
for filename in files:
1959
# Get file name into canonical form.
1960
abspath = self.abspath(filename)
1961
filename = self.relpath(abspath)
1962
if len(filename) > 0:
1963
new_files.add(filename)
1964
recurse_directory_to_add_files(filename)
1966
files = list(new_files)
1969
return # nothing to do
1971
# Sort needed to first handle directory content before the directory
1972
files.sort(reverse=True)
1974
# Bail out if we are going to delete files we shouldn't
1975
if not keep_files and not force:
1976
has_changed_files = len(unknown_nested_files) > 0
1977
if not has_changed_files:
1978
for (file_id, path, content_change, versioned, parent_id, name,
1979
kind, executable) in self.iter_changes(self.basis_tree(),
1980
include_unchanged=True, require_versioned=False,
1981
want_unversioned=True, specific_files=files):
1982
if versioned == (False, False):
1983
# The record is unknown ...
1984
if not self.is_ignored(path[1]):
1985
# ... but not ignored
1986
has_changed_files = True
1988
elif content_change and (kind[1] is not None):
1989
# Versioned and changed, but not deleted
1990
has_changed_files = True
1993
if has_changed_files:
1994
# Make delta show ALL applicable changes in error message.
1995
tree_delta = self.changes_from(self.basis_tree(),
1996
require_versioned=False, want_unversioned=True,
1997
specific_files=files)
1998
for unknown_file in unknown_nested_files:
1999
if unknown_file not in tree_delta.unversioned:
2000
tree_delta.unversioned.extend((unknown_file,))
2001
raise errors.BzrRemoveChangedFilesError(tree_delta)
2003
# Build inv_delta and delete files where applicable,
2004
# do this before any modifications to inventory.
2006
fid = self.path2id(f)
2009
message = "%s is not versioned." % (f,)
2012
# having removed it, it must be either ignored or unknown
2013
if self.is_ignored(f):
2017
textui.show_status(new_status, self.kind(fid), f,
2020
inv_delta.append((f, None, fid, None))
2021
message = "removed %s" % (f,)
2024
abs_path = self.abspath(f)
2025
if osutils.lexists(abs_path):
2026
if (osutils.isdir(abs_path) and
2027
len(os.listdir(abs_path)) > 0):
2029
osutils.rmtree(abs_path)
2031
message = "%s is not an empty directory "\
2032
"and won't be deleted." % (f,)
2034
osutils.delete_any(abs_path)
2035
message = "deleted %s" % (f,)
2036
elif message is not None:
2037
# Only care if we haven't done anything yet.
2038
message = "%s does not exist." % (f,)
2040
# Print only one message (if any) per file.
2041
if message is not None:
2043
self.apply_inventory_delta(inv_delta)
2045
@needs_tree_write_lock
2046
def revert(self, filenames=None, old_tree=None, backups=True,
2047
pb=DummyProgress(), report_changes=False):
2048
from bzrlib.conflicts import resolve
2051
symbol_versioning.warn('Using [] to revert all files is deprecated'
2052
' as of bzr 0.91. Please use None (the default) instead.',
2053
DeprecationWarning, stacklevel=2)
2054
if old_tree is None:
2055
basis_tree = self.basis_tree()
2056
basis_tree.lock_read()
2057
old_tree = basis_tree
2061
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2063
if filenames is None and len(self.get_parent_ids()) > 1:
2065
last_revision = self.last_revision()
2066
if last_revision != _mod_revision.NULL_REVISION:
2067
if basis_tree is None:
2068
basis_tree = self.basis_tree()
2069
basis_tree.lock_read()
2070
parent_trees.append((last_revision, basis_tree))
2071
self.set_parent_trees(parent_trees)
2074
resolve(self, filenames, ignore_misses=True, recursive=True)
2076
if basis_tree is not None:
2080
def revision_tree(self, revision_id):
2081
"""See Tree.revision_tree.
2083
WorkingTree can supply revision_trees for the basis revision only
2084
because there is only one cached inventory in the bzr directory.
2086
if revision_id == self.last_revision():
2088
xml = self.read_basis_inventory()
2089
except errors.NoSuchFile:
2093
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2094
# dont use the repository revision_tree api because we want
2095
# to supply the inventory.
2096
if inv.revision_id == revision_id:
2097
return revisiontree.RevisionTree(self.branch.repository,
2099
except errors.BadInventoryFormat:
2101
# raise if there was no inventory, or if we read the wrong inventory.
2102
raise errors.NoSuchRevisionInTree(self, revision_id)
2104
# XXX: This method should be deprecated in favour of taking in a proper
2105
# new Inventory object.
2106
@needs_tree_write_lock
2107
def set_inventory(self, new_inventory_list):
2108
from bzrlib.inventory import (Inventory,
2112
inv = Inventory(self.get_root_id())
2113
for path, file_id, parent, kind in new_inventory_list:
2114
name = os.path.basename(path)
2117
# fixme, there should be a factory function inv,add_??
2118
if kind == 'directory':
2119
inv.add(InventoryDirectory(file_id, name, parent))
2120
elif kind == 'file':
2121
inv.add(InventoryFile(file_id, name, parent))
2122
elif kind == 'symlink':
2123
inv.add(InventoryLink(file_id, name, parent))
2125
raise errors.BzrError("unknown kind %r" % kind)
2126
self._write_inventory(inv)
2128
@needs_tree_write_lock
2129
def set_root_id(self, file_id):
2130
"""Set the root id for this tree."""
2134
'WorkingTree.set_root_id with fileid=None')
2135
file_id = osutils.safe_file_id(file_id)
2136
self._set_root_id(file_id)
2138
def _set_root_id(self, file_id):
2139
"""Set the root id for this tree, in a format specific manner.
2141
:param file_id: The file id to assign to the root. It must not be
2142
present in the current inventory or an error will occur. It must
2143
not be None, but rather a valid file id.
2145
inv = self._inventory
2146
orig_root_id = inv.root.file_id
2147
# TODO: it might be nice to exit early if there was nothing
2148
# to do, saving us from trigger a sync on unlock.
2149
self._inventory_is_modified = True
2150
# we preserve the root inventory entry object, but
2151
# unlinkit from the byid index
2152
del inv._byid[inv.root.file_id]
2153
inv.root.file_id = file_id
2154
# and link it into the index with the new changed id.
2155
inv._byid[inv.root.file_id] = inv.root
2156
# and finally update all children to reference the new id.
2157
# XXX: this should be safe to just look at the root.children
2158
# list, not the WHOLE INVENTORY.
2161
if entry.parent_id == orig_root_id:
2162
entry.parent_id = inv.root.file_id
2165
"""See Branch.unlock.
2167
WorkingTree locking just uses the Branch locking facilities.
2168
This is current because all working trees have an embedded branch
2169
within them. IF in the future, we were to make branch data shareable
2170
between multiple working trees, i.e. via shared storage, then we
2171
would probably want to lock both the local tree, and the branch.
2173
raise NotImplementedError(self.unlock)
2175
def update(self, change_reporter=None, possible_transports=None):
2176
"""Update a working tree along its branch.
2178
This will update the branch if its bound too, which means we have
2179
multiple trees involved:
2181
- The new basis tree of the master.
2182
- The old basis tree of the branch.
2183
- The old basis tree of the working tree.
2184
- The current working tree state.
2186
Pathologically, all three may be different, and non-ancestors of each
2187
other. Conceptually we want to:
2189
- Preserve the wt.basis->wt.state changes
2190
- Transform the wt.basis to the new master basis.
2191
- Apply a merge of the old branch basis to get any 'local' changes from
2193
- Restore the wt.basis->wt.state changes.
2195
There isn't a single operation at the moment to do that, so we:
2196
- Merge current state -> basis tree of the master w.r.t. the old tree
2198
- Do a 'normal' merge of the old branch basis if it is relevant.
2200
if self.branch.get_bound_location() is not None:
2202
update_branch = True
2204
self.lock_tree_write()
2205
update_branch = False
2208
old_tip = self.branch.update(possible_transports)
2211
return self._update_tree(old_tip, change_reporter)
2215
@needs_tree_write_lock
2216
def _update_tree(self, old_tip=None, change_reporter=None):
2217
"""Update a tree to the master branch.
2219
:param old_tip: if supplied, the previous tip revision the branch,
2220
before it was changed to the master branch's tip.
2222
# here if old_tip is not None, it is the old tip of the branch before
2223
# it was updated from the master branch. This should become a pending
2224
# merge in the working tree to preserve the user existing work. we
2225
# cant set that until we update the working trees last revision to be
2226
# one from the new branch, because it will just get absorbed by the
2227
# parent de-duplication logic.
2229
# We MUST save it even if an error occurs, because otherwise the users
2230
# local work is unreferenced and will appear to have been lost.
2234
last_rev = self.get_parent_ids()[0]
2236
last_rev = _mod_revision.NULL_REVISION
2237
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2238
# merge tree state up to new branch tip.
2239
basis = self.basis_tree()
2242
to_tree = self.branch.basis_tree()
2243
if basis.inventory.root is None:
2244
self.set_root_id(to_tree.get_root_id())
2246
result += merge.merge_inner(
2251
change_reporter=change_reporter)
2254
# TODO - dedup parents list with things merged by pull ?
2255
# reuse the tree we've updated to to set the basis:
2256
parent_trees = [(self.branch.last_revision(), to_tree)]
2257
merges = self.get_parent_ids()[1:]
2258
# Ideally we ask the tree for the trees here, that way the working
2259
# tree can decide whether to give us the entire tree or give us a
2260
# lazy initialised tree. dirstate for instance will have the trees
2261
# in ram already, whereas a last-revision + basis-inventory tree
2262
# will not, but also does not need them when setting parents.
2263
for parent in merges:
2264
parent_trees.append(
2265
(parent, self.branch.repository.revision_tree(parent)))
2266
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2267
parent_trees.append(
2268
(old_tip, self.branch.repository.revision_tree(old_tip)))
2269
self.set_parent_trees(parent_trees)
2270
last_rev = parent_trees[0][0]
2272
# the working tree had the same last-revision as the master
2273
# branch did. We may still have pivot local work from the local
2274
# branch into old_tip:
2275
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2276
self.add_parent_tree_id(old_tip)
2277
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2278
and old_tip != last_rev):
2279
# our last revision was not the prior branch last revision
2280
# and we have converted that last revision to a pending merge.
2281
# base is somewhere between the branch tip now
2282
# and the now pending merge
2284
# Since we just modified the working tree and inventory, flush out
2285
# the current state, before we modify it again.
2286
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2287
# requires it only because TreeTransform directly munges the
2288
# inventory and calls tree._write_inventory(). Ultimately we
2289
# should be able to remove this extra flush.
2291
graph = self.branch.repository.get_graph()
2292
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2294
base_tree = self.branch.repository.revision_tree(base_rev_id)
2295
other_tree = self.branch.repository.revision_tree(old_tip)
2296
result += merge.merge_inner(
2301
change_reporter=change_reporter)
2304
def _write_hashcache_if_dirty(self):
2305
"""Write out the hashcache if it is dirty."""
2306
if self._hashcache.needs_write:
2308
self._hashcache.write()
2310
if e.errno not in (errno.EPERM, errno.EACCES):
2312
# TODO: jam 20061219 Should this be a warning? A single line
2313
# warning might be sufficient to let the user know what
2315
mutter('Could not write hashcache for %s\nError: %s',
2316
self._hashcache.cache_file_name(), e)
2318
@needs_tree_write_lock
2319
def _write_inventory(self, inv):
2320
"""Write inventory as the current inventory."""
2321
self._set_inventory(inv, dirty=True)
2324
def set_conflicts(self, arg):
2325
raise errors.UnsupportedOperation(self.set_conflicts, self)
2327
def add_conflicts(self, arg):
2328
raise errors.UnsupportedOperation(self.add_conflicts, self)
2331
def conflicts(self):
2332
conflicts = _mod_conflicts.ConflictList()
2333
for conflicted in self._iter_conflicts():
2336
if file_kind(self.abspath(conflicted)) != "file":
2338
except errors.NoSuchFile:
2341
for suffix in ('.THIS', '.OTHER'):
2343
kind = file_kind(self.abspath(conflicted+suffix))
2346
except errors.NoSuchFile:
2350
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2351
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2353
file_id=self.path2id(conflicted)))
2356
def walkdirs(self, prefix=""):
2357
"""Walk the directories of this tree.
2359
returns a generator which yields items in the form:
2360
((curren_directory_path, fileid),
2361
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2364
This API returns a generator, which is only valid during the current
2365
tree transaction - within a single lock_read or lock_write duration.
2367
If the tree is not locked, it may cause an error to be raised,
2368
depending on the tree implementation.
2370
disk_top = self.abspath(prefix)
2371
if disk_top.endswith('/'):
2372
disk_top = disk_top[:-1]
2373
top_strip_len = len(disk_top) + 1
2374
inventory_iterator = self._walkdirs(prefix)
2375
disk_iterator = osutils.walkdirs(disk_top, prefix)
2377
current_disk = disk_iterator.next()
2378
disk_finished = False
2380
if not (e.errno == errno.ENOENT or
2381
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2384
disk_finished = True
2386
current_inv = inventory_iterator.next()
2387
inv_finished = False
2388
except StopIteration:
2391
while not inv_finished or not disk_finished:
2393
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2394
cur_disk_dir_content) = current_disk
2396
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2397
cur_disk_dir_content) = ((None, None), None)
2398
if not disk_finished:
2399
# strip out .bzr dirs
2400
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2401
len(cur_disk_dir_content) > 0):
2402
# osutils.walkdirs can be made nicer -
2403
# yield the path-from-prefix rather than the pathjoined
2405
bzrdir_loc = bisect_left(cur_disk_dir_content,
2407
if (bzrdir_loc < len(cur_disk_dir_content)
2408
and self.bzrdir.is_control_filename(
2409
cur_disk_dir_content[bzrdir_loc][0])):
2410
# we dont yield the contents of, or, .bzr itself.
2411
del cur_disk_dir_content[bzrdir_loc]
2413
# everything is unknown
2416
# everything is missing
2419
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2421
# disk is before inventory - unknown
2422
dirblock = [(relpath, basename, kind, stat, None, None) for
2423
relpath, basename, kind, stat, top_path in
2424
cur_disk_dir_content]
2425
yield (cur_disk_dir_relpath, None), dirblock
2427
current_disk = disk_iterator.next()
2428
except StopIteration:
2429
disk_finished = True
2431
# inventory is before disk - missing.
2432
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2433
for relpath, basename, dkind, stat, fileid, kind in
2435
yield (current_inv[0][0], current_inv[0][1]), dirblock
2437
current_inv = inventory_iterator.next()
2438
except StopIteration:
2441
# versioned present directory
2442
# merge the inventory and disk data together
2444
for relpath, subiterator in itertools.groupby(sorted(
2445
current_inv[1] + cur_disk_dir_content,
2446
key=operator.itemgetter(0)), operator.itemgetter(1)):
2447
path_elements = list(subiterator)
2448
if len(path_elements) == 2:
2449
inv_row, disk_row = path_elements
2450
# versioned, present file
2451
dirblock.append((inv_row[0],
2452
inv_row[1], disk_row[2],
2453
disk_row[3], inv_row[4],
2455
elif len(path_elements[0]) == 5:
2457
dirblock.append((path_elements[0][0],
2458
path_elements[0][1], path_elements[0][2],
2459
path_elements[0][3], None, None))
2460
elif len(path_elements[0]) == 6:
2461
# versioned, absent file.
2462
dirblock.append((path_elements[0][0],
2463
path_elements[0][1], 'unknown', None,
2464
path_elements[0][4], path_elements[0][5]))
2466
raise NotImplementedError('unreachable code')
2467
yield current_inv[0], dirblock
2469
current_inv = inventory_iterator.next()
2470
except StopIteration:
2473
current_disk = disk_iterator.next()
2474
except StopIteration:
2475
disk_finished = True
2477
def _walkdirs(self, prefix=""):
2478
"""Walk the directories of this tree.
2480
:prefix: is used as the directrory to start with.
2481
returns a generator which yields items in the form:
2482
((curren_directory_path, fileid),
2483
[(file1_path, file1_name, file1_kind, None, file1_id,
2486
_directory = 'directory'
2487
# get the root in the inventory
2488
inv = self.inventory
2489
top_id = inv.path2id(prefix)
2493
pending = [(prefix, '', _directory, None, top_id, None)]
2496
currentdir = pending.pop()
2497
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2498
top_id = currentdir[4]
2500
relroot = currentdir[0] + '/'
2503
# FIXME: stash the node in pending
2505
if entry.kind == 'directory':
2506
for name, child in entry.sorted_children():
2507
dirblock.append((relroot + name, name, child.kind, None,
2508
child.file_id, child.kind
2510
yield (currentdir[0], entry.file_id), dirblock
2511
# push the user specified dirs from dirblock
2512
for dir in reversed(dirblock):
2513
if dir[2] == _directory:
2516
@needs_tree_write_lock
2517
def auto_resolve(self):
2518
"""Automatically resolve text conflicts according to contents.
2520
Only text conflicts are auto_resolvable. Files with no conflict markers
2521
are considered 'resolved', because bzr always puts conflict markers
2522
into files that have text conflicts. The corresponding .THIS .BASE and
2523
.OTHER files are deleted, as per 'resolve'.
2524
:return: a tuple of ConflictLists: (un_resolved, resolved).
2526
un_resolved = _mod_conflicts.ConflictList()
2527
resolved = _mod_conflicts.ConflictList()
2528
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2529
for conflict in self.conflicts():
2530
if (conflict.typestring != 'text conflict' or
2531
self.kind(conflict.file_id) != 'file'):
2532
un_resolved.append(conflict)
2534
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2536
for line in my_file:
2537
if conflict_re.search(line):
2538
un_resolved.append(conflict)
2541
resolved.append(conflict)
2544
resolved.remove_files(self)
2545
self.set_conflicts(un_resolved)
2546
return un_resolved, resolved
2549
def _check(self, references):
2550
"""Check the tree for consistency.
2552
:param references: A dict with keys matching the items returned by
2553
self._get_check_refs(), and values from looking those keys up in
2556
tree_basis = self.basis_tree()
2557
tree_basis.lock_read()
2559
repo_basis = references[('trees', self.last_revision())]
2560
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2561
raise errors.BzrCheckError(
2562
"Mismatched basis inventory content.")
2567
def _validate(self):
2568
"""Validate internal structures.
2570
This is meant mostly for the test suite. To give it a chance to detect
2571
corruption after actions have occurred. The default implementation is a
2574
:return: None. An exception should be raised if there is an error.
2579
def _get_rules_searcher(self, default_searcher):
2580
"""See Tree._get_rules_searcher."""
2581
if self._rules_searcher is None:
2582
self._rules_searcher = super(WorkingTree,
2583
self)._get_rules_searcher(default_searcher)
2584
return self._rules_searcher
2586
def get_shelf_manager(self):
2587
"""Return the ShelfManager for this WorkingTree."""
2588
from bzrlib.shelf import ShelfManager
2589
return ShelfManager(self, self._transport)
2592
class WorkingTree2(WorkingTree):
2593
"""This is the Format 2 working tree.
2595
This was the first weave based working tree.
2596
- uses os locks for locking.
2597
- uses the branch last-revision.
2600
def __init__(self, *args, **kwargs):
2601
super(WorkingTree2, self).__init__(*args, **kwargs)
2602
# WorkingTree2 has more of a constraint that self._inventory must
2603
# exist. Because this is an older format, we don't mind the overhead
2604
# caused by the extra computation here.
2606
# Newer WorkingTree's should only have self._inventory set when they
2608
if self._inventory is None:
2609
self.read_working_inventory()
2611
def _get_check_refs(self):
2612
"""Return the references needed to perform a check of this tree."""
2613
return [('trees', self.last_revision())]
2615
def lock_tree_write(self):
2616
"""See WorkingTree.lock_tree_write().
2618
In Format2 WorkingTrees we have a single lock for the branch and tree
2619
so lock_tree_write() degrades to lock_write().
2621
self.branch.lock_write()
2623
return self._control_files.lock_write()
2625
self.branch.unlock()
2629
# do non-implementation specific cleanup
2632
# we share control files:
2633
if self._control_files._lock_count == 3:
2634
# _inventory_is_modified is always False during a read lock.
2635
if self._inventory_is_modified:
2637
self._write_hashcache_if_dirty()
2639
# reverse order of locking.
2641
return self._control_files.unlock()
2643
self.branch.unlock()
2646
class WorkingTree3(WorkingTree):
2647
"""This is the Format 3 working tree.
2649
This differs from the base WorkingTree by:
2650
- having its own file lock
2651
- having its own last-revision property.
2653
This is new in bzr 0.8
2657
def _last_revision(self):
2658
"""See Mutable.last_revision."""
2660
return self._transport.get_bytes('last-revision')
2661
except errors.NoSuchFile:
2662
return _mod_revision.NULL_REVISION
2664
def _change_last_revision(self, revision_id):
2665
"""See WorkingTree._change_last_revision."""
2666
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2668
self._transport.delete('last-revision')
2669
except errors.NoSuchFile:
2673
self._transport.put_bytes('last-revision', revision_id,
2674
mode=self.bzrdir._get_file_mode())
2677
def _get_check_refs(self):
2678
"""Return the references needed to perform a check of this tree."""
2679
return [('trees', self.last_revision())]
2681
@needs_tree_write_lock
2682
def set_conflicts(self, conflicts):
2683
self._put_rio('conflicts', conflicts.to_stanzas(),
2686
@needs_tree_write_lock
2687
def add_conflicts(self, new_conflicts):
2688
conflict_set = set(self.conflicts())
2689
conflict_set.update(set(list(new_conflicts)))
2690
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2691
key=_mod_conflicts.Conflict.sort_key)))
2694
def conflicts(self):
2696
confile = self._transport.get('conflicts')
2697
except errors.NoSuchFile:
2698
return _mod_conflicts.ConflictList()
2701
if confile.next() != CONFLICT_HEADER_1 + '\n':
2702
raise errors.ConflictFormatError()
2703
except StopIteration:
2704
raise errors.ConflictFormatError()
2705
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2710
# do non-implementation specific cleanup
2712
if self._control_files._lock_count == 1:
2713
# _inventory_is_modified is always False during a read lock.
2714
if self._inventory_is_modified:
2716
self._write_hashcache_if_dirty()
2717
# reverse order of locking.
2719
return self._control_files.unlock()
2721
self.branch.unlock()
2724
def get_conflicted_stem(path):
2725
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2726
if path.endswith(suffix):
2727
return path[:-len(suffix)]
2730
class WorkingTreeFormat(object):
2731
"""An encapsulation of the initialization and open routines for a format.
2733
Formats provide three things:
2734
* An initialization routine,
2738
Formats are placed in an dict by their format string for reference
2739
during workingtree opening. Its not required that these be instances, they
2740
can be classes themselves with class methods - it simply depends on
2741
whether state is needed for a given format or not.
2743
Once a format is deprecated, just deprecate the initialize and open
2744
methods on the format class. Do not deprecate the object, as the
2745
object will be created every time regardless.
2748
_default_format = None
2749
"""The default format used for new trees."""
2752
"""The known formats."""
2754
requires_rich_root = False
2756
upgrade_recommended = False
2759
def find_format(klass, a_bzrdir):
2760
"""Return the format for the working tree object in a_bzrdir."""
2762
transport = a_bzrdir.get_workingtree_transport(None)
2763
format_string = transport.get("format").read()
2764
return klass._formats[format_string]
2765
except errors.NoSuchFile:
2766
raise errors.NoWorkingTree(base=transport.base)
2768
raise errors.UnknownFormatError(format=format_string,
2769
kind="working tree")
2771
def __eq__(self, other):
2772
return self.__class__ is other.__class__
2774
def __ne__(self, other):
2775
return not (self == other)
2778
def get_default_format(klass):
2779
"""Return the current default format."""
2780
return klass._default_format
2782
def get_format_string(self):
2783
"""Return the ASCII format string that identifies this format."""
2784
raise NotImplementedError(self.get_format_string)
2786
def get_format_description(self):
2787
"""Return the short description for this format."""
2788
raise NotImplementedError(self.get_format_description)
2790
def is_supported(self):
2791
"""Is this format supported?
2793
Supported formats can be initialized and opened.
2794
Unsupported formats may not support initialization or committing or
2795
some other features depending on the reason for not being supported.
2799
def supports_content_filtering(self):
2800
"""True if this format supports content filtering."""
2803
def supports_views(self):
2804
"""True if this format supports stored views."""
2808
def register_format(klass, format):
2809
klass._formats[format.get_format_string()] = format
2812
def set_default_format(klass, format):
2813
klass._default_format = format
2816
def unregister_format(klass, format):
2817
del klass._formats[format.get_format_string()]
2820
class WorkingTreeFormat2(WorkingTreeFormat):
2821
"""The second working tree format.
2823
This format modified the hash cache from the format 1 hash cache.
2826
upgrade_recommended = True
2828
def get_format_description(self):
2829
"""See WorkingTreeFormat.get_format_description()."""
2830
return "Working tree format 2"
2832
def _stub_initialize_on_transport(self, transport, file_mode):
2833
"""Workaround: create control files for a remote working tree.
2835
This ensures that it can later be updated and dealt with locally,
2836
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2837
no working tree. (See bug #43064).
2840
inv = inventory.Inventory()
2841
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2843
transport.put_file('inventory', sio, file_mode)
2844
transport.put_bytes('pending-merges', '', file_mode)
2846
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2847
accelerator_tree=None, hardlink=False):
2848
"""See WorkingTreeFormat.initialize()."""
2849
if not isinstance(a_bzrdir.transport, LocalTransport):
2850
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2851
if from_branch is not None:
2852
branch = from_branch
2854
branch = a_bzrdir.open_branch()
2855
if revision_id is None:
2856
revision_id = _mod_revision.ensure_null(branch.last_revision())
2859
branch.generate_revision_history(revision_id)
2862
inv = inventory.Inventory()
2863
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2869
basis_tree = branch.repository.revision_tree(revision_id)
2870
if basis_tree.inventory.root is not None:
2871
wt.set_root_id(basis_tree.get_root_id())
2872
# set the parent list and cache the basis tree.
2873
if _mod_revision.is_null(revision_id):
2876
parent_trees = [(revision_id, basis_tree)]
2877
wt.set_parent_trees(parent_trees)
2878
transform.build_tree(basis_tree, wt)
2882
super(WorkingTreeFormat2, self).__init__()
2883
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2885
def open(self, a_bzrdir, _found=False):
2886
"""Return the WorkingTree object for a_bzrdir
2888
_found is a private parameter, do not use it. It is used to indicate
2889
if format probing has already been done.
2892
# we are being called directly and must probe.
2893
raise NotImplementedError
2894
if not isinstance(a_bzrdir.transport, LocalTransport):
2895
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2896
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2902
class WorkingTreeFormat3(WorkingTreeFormat):
2903
"""The second working tree format updated to record a format marker.
2906
- exists within a metadir controlling .bzr
2907
- includes an explicit version marker for the workingtree control
2908
files, separate from the BzrDir format
2909
- modifies the hash cache format
2911
- uses a LockDir to guard access for writes.
2914
upgrade_recommended = True
2916
def get_format_string(self):
2917
"""See WorkingTreeFormat.get_format_string()."""
2918
return "Bazaar-NG Working Tree format 3"
2920
def get_format_description(self):
2921
"""See WorkingTreeFormat.get_format_description()."""
2922
return "Working tree format 3"
2924
_lock_file_name = 'lock'
2925
_lock_class = LockDir
2927
_tree_class = WorkingTree3
2929
def __get_matchingbzrdir(self):
2930
return bzrdir.BzrDirMetaFormat1()
2932
_matchingbzrdir = property(__get_matchingbzrdir)
2934
def _open_control_files(self, a_bzrdir):
2935
transport = a_bzrdir.get_workingtree_transport(None)
2936
return LockableFiles(transport, self._lock_file_name,
2939
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2940
accelerator_tree=None, hardlink=False):
2941
"""See WorkingTreeFormat.initialize().
2943
:param revision_id: if supplied, create a working tree at a different
2944
revision than the branch is at.
2945
:param accelerator_tree: A tree which can be used for retrieving file
2946
contents more quickly than the revision tree, i.e. a workingtree.
2947
The revision tree will be used for cases where accelerator_tree's
2948
content is different.
2949
:param hardlink: If true, hard-link files from accelerator_tree,
2952
if not isinstance(a_bzrdir.transport, LocalTransport):
2953
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2954
transport = a_bzrdir.get_workingtree_transport(self)
2955
control_files = self._open_control_files(a_bzrdir)
2956
control_files.create_lock()
2957
control_files.lock_write()
2958
transport.put_bytes('format', self.get_format_string(),
2959
mode=a_bzrdir._get_file_mode())
2960
if from_branch is not None:
2961
branch = from_branch
2963
branch = a_bzrdir.open_branch()
2964
if revision_id is None:
2965
revision_id = _mod_revision.ensure_null(branch.last_revision())
2966
# WorkingTree3 can handle an inventory which has a unique root id.
2967
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2968
# those trees. And because there isn't a format bump inbetween, we
2969
# are maintaining compatibility with older clients.
2970
# inv = Inventory(root_id=gen_root_id())
2971
inv = self._initial_inventory()
2972
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2978
_control_files=control_files)
2979
wt.lock_tree_write()
2981
basis_tree = branch.repository.revision_tree(revision_id)
2982
# only set an explicit root id if there is one to set.
2983
if basis_tree.inventory.root is not None:
2984
wt.set_root_id(basis_tree.get_root_id())
2985
if revision_id == _mod_revision.NULL_REVISION:
2986
wt.set_parent_trees([])
2988
wt.set_parent_trees([(revision_id, basis_tree)])
2989
transform.build_tree(basis_tree, wt)
2991
# Unlock in this order so that the unlock-triggers-flush in
2992
# WorkingTree is given a chance to fire.
2993
control_files.unlock()
2997
def _initial_inventory(self):
2998
return inventory.Inventory()
3001
super(WorkingTreeFormat3, self).__init__()
3003
def open(self, a_bzrdir, _found=False):
3004
"""Return the WorkingTree object for a_bzrdir
3006
_found is a private parameter, do not use it. It is used to indicate
3007
if format probing has already been done.
3010
# we are being called directly and must probe.
3011
raise NotImplementedError
3012
if not isinstance(a_bzrdir.transport, LocalTransport):
3013
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3014
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3017
def _open(self, a_bzrdir, control_files):
3018
"""Open the tree itself.
3020
:param a_bzrdir: the dir for the tree.
3021
:param control_files: the control files for the tree.
3023
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3027
_control_files=control_files)
3030
return self.get_format_string()
3033
__default_format = WorkingTreeFormat6()
3034
WorkingTreeFormat.register_format(__default_format)
3035
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3036
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3037
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3038
WorkingTreeFormat.set_default_format(__default_format)
3039
# formats which have no format string are not discoverable
3040
# and not independently creatable, so are not registered.
3041
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
