1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.filters import filtered_input_file
106
from bzrlib.trace import mutter, note
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
110
from bzrlib.rio import RioReader, rio_file, Stanza
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
124
class TreeEntry(object):
125
"""An entry that implements the minimum interface used by commands.
127
This needs further inspection, it may be better to have
128
InventoryEntries without ids - though that seems wrong. For now,
129
this is a parallel hierarchy to InventoryEntry, and needs to become
130
one of several things: decorates to that hierarchy, children of, or
132
Another note is that these objects are currently only used when there is
133
no InventoryEntry available - i.e. for unversioned objects.
134
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
137
def __eq__(self, other):
138
# yes, this us ugly, TODO: best practice __eq__ style.
139
return (isinstance(other, TreeEntry)
140
and other.__class__ == self.__class__)
142
def kind_character(self):
146
class TreeDirectory(TreeEntry):
147
"""See TreeEntry. This is a directory in a working tree."""
149
def __eq__(self, other):
150
return (isinstance(other, TreeDirectory)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeFile(TreeEntry):
158
"""See TreeEntry. This is a regular file in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeFile)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeLink(TreeEntry):
169
"""See TreeEntry. This is a symlink in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeLink)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class WorkingTree(bzrlib.mutabletree.MutableTree):
180
"""Working copy tree.
182
The inventory is held in the `Branch` working-inventory, and the
183
files are in a directory on disk.
185
It is possible for a `WorkingTree` to have a filename which is
186
not listed in the Inventory and vice versa.
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
lambda path, file_id: self._content_filter_stack(path, file_id))
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
253
def _detect_case_handling(self):
254
wt_trans = self.bzrdir.get_workingtree_transport(None)
256
wt_trans.stat("FoRMaT")
257
except errors.NoSuchFile:
258
self.case_sensitive = True
260
self.case_sensitive = False
262
self._setup_directory_is_tree_reference()
265
fget=lambda self: self._branch,
266
doc="""The branch this WorkingTree is connected to.
268
This cannot be set - it is reflective of the actual disk structure
269
the working tree has been constructed from.
272
def break_lock(self):
273
"""Break a lock if one is present from another instance.
275
Uses the ui factory to ask for confirmation if the lock may be from
278
This will probe the repository for its lock as well.
280
self._control_files.break_lock()
281
self.branch.break_lock()
283
def requires_rich_root(self):
284
return self._format.requires_rich_root
286
def supports_tree_reference(self):
289
def _set_inventory(self, inv, dirty):
290
"""Set the internal cached inventory.
292
:param inv: The inventory to set.
293
:param dirty: A boolean indicating whether the inventory is the same
294
logical inventory as whats on disk. If True the inventory is not
295
the same and should be written to disk or data will be lost, if
296
False then the inventory is the same as that on disk and any
297
serialisation would be unneeded overhead.
299
self._inventory = inv
300
self._inventory_is_modified = dirty
303
def open(path=None, _unsupported=False):
304
"""Open an existing working tree at path.
308
path = osutils.getcwd()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
313
def open_containing(path=None):
314
"""Open an existing working tree which has its root about path.
316
This probes for a working tree at path and searches upwards from there.
318
Basically we keep looking up until we find the control directory or
319
run into /. If there isn't one, raises NotBranchError.
320
TODO: give this a new exception.
321
If there is one, it is returned, along with the unused portion of path.
323
:return: The WorkingTree that contains 'path', and the rest of path
326
path = osutils.getcwd()
327
control, relpath = bzrdir.BzrDir.open_containing(path)
329
return control.open_workingtree(), relpath
332
def open_downlevel(path=None):
333
"""Open an unsupported working tree.
335
Only intended for advanced situations like upgrading part of a bzrdir.
337
return WorkingTree.open(path, _unsupported=True)
340
def find_trees(location):
341
def list_current(transport):
342
return [d for d in transport.list_dir('') if d != '.bzr']
343
def evaluate(bzrdir):
345
tree = bzrdir.open_workingtree()
346
except errors.NoWorkingTree:
350
transport = get_transport(location)
351
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
352
list_current=list_current)
353
return [t for t in iterator if t is not None]
355
# should be deprecated - this is slow and in any case treating them as a
356
# container is (we now know) bad style -- mbp 20070302
357
## @deprecated_method(zero_fifteen)
359
"""Iterate through file_ids for this tree.
361
file_ids are in a WorkingTree if they are in the working inventory
362
and the working file exists.
364
inv = self._inventory
365
for path, ie in inv.iter_entries():
366
if osutils.lexists(self.abspath(path)):
369
def all_file_ids(self):
370
"""See Tree.iter_all_file_ids"""
371
return set(self.inventory)
374
return "<%s of %s>" % (self.__class__.__name__,
375
getattr(self, 'basedir', None))
377
def abspath(self, filename):
378
return pathjoin(self.basedir, filename)
380
def basis_tree(self):
381
"""Return RevisionTree for the current last revision.
383
If the left most parent is a ghost then the returned tree will be an
384
empty tree - one obtained by calling
385
repository.revision_tree(NULL_REVISION).
388
revision_id = self.get_parent_ids()[0]
390
# no parents, return an empty revision tree.
391
# in the future this should return the tree for
392
# 'empty:' - the implicit root empty tree.
393
return self.branch.repository.revision_tree(
394
_mod_revision.NULL_REVISION)
396
return self.revision_tree(revision_id)
397
except errors.NoSuchRevision:
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except (errors.RevisionNotPresent, errors.NoSuchRevision):
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(
412
_mod_revision.NULL_REVISION)
415
self._flush_ignore_list_cache()
417
def relpath(self, path):
418
"""Return the local path portion from a given path.
420
The path may be absolute or relative. If its a relative path it is
421
interpreted relative to the python current working directory.
423
return osutils.relpath(self.basedir, path)
425
def has_filename(self, filename):
426
return osutils.lexists(self.abspath(filename))
428
def get_file(self, file_id, path=None, filtered=True):
430
path = self.id2path(file_id)
431
return self.get_file_byname(path, filtered=filtered)
433
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
434
"""See MutableTree.get_file_with_stat."""
436
path = self.id2path(file_id)
437
file_obj = self.get_file_byname(path, filtered=False)
438
return (file_obj, _fstat(file_obj.fileno()))
440
def get_file_text(self, file_id, path=None, filtered=True):
441
return self.get_file(file_id, path=path, filtered=filtered).read()
443
def get_file_byname(self, filename, filtered=True):
444
path = self.abspath(filename)
447
filters = self._content_filter_stack(filename)
448
return filtered_input_file(f, filters)
452
def get_file_lines(self, file_id, path=None):
453
"""See Tree.get_file_lines()"""
454
file = self.get_file(file_id, path)
456
return file.readlines()
461
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
462
"""See Tree.annotate_iter
464
This implementation will use the basis tree implementation if possible.
465
Lines not in the basis are attributed to CURRENT_REVISION
467
If there are pending merges, lines added by those merges will be
468
incorrectly attributed to CURRENT_REVISION (but after committing, the
469
attribution will be correct).
471
basis = self.basis_tree()
474
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
475
require_versioned=True).next()
476
changed_content, kind = changes[2], changes[6]
477
if not changed_content:
478
return basis.annotate_iter(file_id)
482
if kind[0] != 'file':
485
old_lines = list(basis.annotate_iter(file_id))
487
for tree in self.branch.repository.revision_trees(
488
self.get_parent_ids()[1:]):
489
if file_id not in tree:
491
old.append(list(tree.annotate_iter(file_id)))
492
return annotate.reannotate(old, self.get_file(file_id).readlines(),
497
def _get_ancestors(self, default_revision):
498
ancestors = set([default_revision])
499
for parent_id in self.get_parent_ids():
500
ancestors.update(self.branch.repository.get_ancestry(
501
parent_id, topo_sorted=False))
504
def get_parent_ids(self):
505
"""See Tree.get_parent_ids.
507
This implementation reads the pending merges list and last_revision
508
value and uses that to decide what the parents list should be.
510
last_rev = _mod_revision.ensure_null(self._last_revision())
511
if _mod_revision.NULL_REVISION == last_rev:
516
merges_file = self._transport.get('pending-merges')
517
except errors.NoSuchFile:
520
for l in merges_file.readlines():
521
revision_id = l.rstrip('\n')
522
parents.append(revision_id)
526
def get_root_id(self):
527
"""Return the id of this trees root"""
528
return self._inventory.root.file_id
530
def _get_store_filename(self, file_id):
531
## XXX: badly named; this is not in the store at all
532
return self.abspath(self.id2path(file_id))
535
def clone(self, to_bzrdir, revision_id=None):
536
"""Duplicate this working tree into to_bzr, including all state.
538
Specifically modified files are kept as modified, but
539
ignored and unknown files are discarded.
541
If you want to make a new line of development, see bzrdir.sprout()
544
If not None, the cloned tree will have its last revision set to
545
revision, and and difference between the source trees last revision
546
and this one merged in.
548
# assumes the target bzr dir format is compatible.
549
result = to_bzrdir.create_workingtree()
550
self.copy_content_into(result, revision_id)
554
def copy_content_into(self, tree, revision_id=None):
555
"""Copy the current content and user files of this tree into tree."""
556
tree.set_root_id(self.get_root_id())
557
if revision_id is None:
558
merge.transform_tree(tree, self)
560
# TODO now merge from tree.last_revision to revision (to preserve
561
# user local changes)
562
merge.transform_tree(tree, self)
563
tree.set_parent_ids([revision_id])
565
def id2abspath(self, file_id):
566
return self.abspath(self.id2path(file_id))
568
def has_id(self, file_id):
569
# files that have been deleted are excluded
571
if not inv.has_id(file_id):
573
path = inv.id2path(file_id)
574
return osutils.lexists(self.abspath(path))
576
def has_or_had_id(self, file_id):
577
if file_id == self.inventory.root.file_id:
579
return self.inventory.has_id(file_id)
581
__contains__ = has_id
583
def get_file_size(self, file_id):
584
"""See Tree.get_file_size"""
586
return os.path.getsize(self.id2abspath(file_id))
588
if e.errno != errno.ENOENT:
594
def get_file_sha1(self, file_id, path=None, stat_value=None):
596
path = self._inventory.id2path(file_id)
597
return self._hashcache.get_sha1(path, stat_value)
599
def get_file_mtime(self, file_id, path=None):
601
path = self.inventory.id2path(file_id)
602
return os.lstat(self.abspath(path)).st_mtime
604
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
605
file_id = self.path2id(path)
606
return self._inventory[file_id].executable
608
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
609
mode = stat_result.st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
612
if not supports_executable():
613
def is_executable(self, file_id, path=None):
614
return self._inventory[file_id].executable
616
_is_executable_from_path_and_stat = \
617
_is_executable_from_path_and_stat_from_basis
619
def is_executable(self, file_id, path=None):
621
path = self.id2path(file_id)
622
mode = os.lstat(self.abspath(path)).st_mode
623
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
625
_is_executable_from_path_and_stat = \
626
_is_executable_from_path_and_stat_from_stat
628
@needs_tree_write_lock
629
def _add(self, files, ids, kinds):
630
"""See MutableTree._add."""
631
# TODO: Re-adding a file that is removed in the working copy
632
# should probably put it back with the previous ID.
633
# the read and write working inventory should not occur in this
634
# function - they should be part of lock_write and unlock.
636
for f, file_id, kind in zip(files, ids, kinds):
638
inv.add_path(f, kind=kind)
640
inv.add_path(f, kind=kind, file_id=file_id)
641
self._inventory_is_modified = True
643
@needs_tree_write_lock
644
def _gather_kinds(self, files, kinds):
645
"""See MutableTree._gather_kinds."""
646
for pos, f in enumerate(files):
647
if kinds[pos] is None:
648
fullpath = normpath(self.abspath(f))
650
kinds[pos] = file_kind(fullpath)
652
if e.errno == errno.ENOENT:
653
raise errors.NoSuchFile(fullpath)
656
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
657
"""Add revision_id as a parent.
659
This is equivalent to retrieving the current list of parent ids
660
and setting the list to its value plus revision_id.
662
:param revision_id: The revision id to add to the parent list. It may
663
be a ghost revision as long as its not the first parent to be added,
664
or the allow_leftmost_as_ghost parameter is set True.
665
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
667
parents = self.get_parent_ids() + [revision_id]
668
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
669
or allow_leftmost_as_ghost)
671
@needs_tree_write_lock
672
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
673
"""Add revision_id, tree tuple as a parent.
675
This is equivalent to retrieving the current list of parent trees
676
and setting the list to its value plus parent_tuple. See also
677
add_parent_tree_id - if you only have a parent id available it will be
678
simpler to use that api. If you have the parent already available, using
679
this api is preferred.
681
:param parent_tuple: The (revision id, tree) to add to the parent list.
682
If the revision_id is a ghost, pass None for the tree.
683
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
685
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
686
if len(parent_ids) > 1:
687
# the leftmost may have already been a ghost, preserve that if it
689
allow_leftmost_as_ghost = True
690
self.set_parent_ids(parent_ids,
691
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
693
@needs_tree_write_lock
694
def add_pending_merge(self, *revision_ids):
695
# TODO: Perhaps should check at this point that the
696
# history of the revision is actually present?
697
parents = self.get_parent_ids()
699
for rev_id in revision_ids:
700
if rev_id in parents:
702
parents.append(rev_id)
705
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
707
def path_content_summary(self, path, _lstat=os.lstat,
708
_mapper=osutils.file_kind_from_stat_mode):
709
"""See Tree.path_content_summary."""
710
abspath = self.abspath(path)
712
stat_result = _lstat(abspath)
714
if getattr(e, 'errno', None) == errno.ENOENT:
716
return ('missing', None, None, None)
717
# propagate other errors
719
kind = _mapper(stat_result.st_mode)
721
size = stat_result.st_size
722
# try for a stat cache lookup
723
executable = self._is_executable_from_path_and_stat(path, stat_result)
724
return (kind, size, executable, self._sha_from_stat(
726
elif kind == 'directory':
727
# perhaps it looks like a plain directory, but it's really a
729
if self._directory_is_tree_reference(path):
730
kind = 'tree-reference'
731
return kind, None, None, None
732
elif kind == 'symlink':
733
return ('symlink', None, None, os.readlink(abspath))
735
return (kind, None, None, None)
737
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
738
"""Common ghost checking functionality from set_parent_*.
740
This checks that the left hand-parent exists if there are any
743
if len(revision_ids) > 0:
744
leftmost_id = revision_ids[0]
745
if (not allow_leftmost_as_ghost and not
746
self.branch.repository.has_revision(leftmost_id)):
747
raise errors.GhostRevisionUnusableHere(leftmost_id)
749
def _set_merges_from_parent_ids(self, parent_ids):
750
merges = parent_ids[1:]
751
self._transport.put_bytes('pending-merges', '\n'.join(merges),
752
mode=self._control_files._file_mode)
754
def _filter_parent_ids_by_ancestry(self, revision_ids):
755
"""Check that all merged revisions are proper 'heads'.
757
This will always return the first revision_id, and any merged revisions
760
if len(revision_ids) == 0:
762
graph = self.branch.repository.get_graph()
763
heads = graph.heads(revision_ids)
764
new_revision_ids = revision_ids[:1]
765
for revision_id in revision_ids[1:]:
766
if revision_id in heads and revision_id not in new_revision_ids:
767
new_revision_ids.append(revision_id)
768
if new_revision_ids != revision_ids:
769
trace.mutter('requested to set revision_ids = %s,'
770
' but filtered to %s', revision_ids, new_revision_ids)
771
return new_revision_ids
773
@needs_tree_write_lock
774
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
775
"""Set the parent ids to revision_ids.
777
See also set_parent_trees. This api will try to retrieve the tree data
778
for each element of revision_ids from the trees repository. If you have
779
tree data already available, it is more efficient to use
780
set_parent_trees rather than set_parent_ids. set_parent_ids is however
781
an easier API to use.
783
:param revision_ids: The revision_ids to set as the parent ids of this
784
working tree. Any of these may be ghosts.
786
self._check_parents_for_ghosts(revision_ids,
787
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
788
for revision_id in revision_ids:
789
_mod_revision.check_not_reserved_id(revision_id)
791
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
793
if len(revision_ids) > 0:
794
self.set_last_revision(revision_ids[0])
796
self.set_last_revision(_mod_revision.NULL_REVISION)
798
self._set_merges_from_parent_ids(revision_ids)
800
@needs_tree_write_lock
801
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
802
"""See MutableTree.set_parent_trees."""
803
parent_ids = [rev for (rev, tree) in parents_list]
804
for revision_id in parent_ids:
805
_mod_revision.check_not_reserved_id(revision_id)
807
self._check_parents_for_ghosts(parent_ids,
808
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
810
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
812
if len(parent_ids) == 0:
813
leftmost_parent_id = _mod_revision.NULL_REVISION
814
leftmost_parent_tree = None
816
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
818
if self._change_last_revision(leftmost_parent_id):
819
if leftmost_parent_tree is None:
820
# If we don't have a tree, fall back to reading the
821
# parent tree from the repository.
822
self._cache_basis_inventory(leftmost_parent_id)
824
inv = leftmost_parent_tree.inventory
825
xml = self._create_basis_xml_from_inventory(
826
leftmost_parent_id, inv)
827
self._write_basis_inventory(xml)
828
self._set_merges_from_parent_ids(parent_ids)
830
@needs_tree_write_lock
831
def set_pending_merges(self, rev_list):
832
parents = self.get_parent_ids()
833
leftmost = parents[:1]
834
new_parents = leftmost + rev_list
835
self.set_parent_ids(new_parents)
837
@needs_tree_write_lock
838
def set_merge_modified(self, modified_hashes):
840
for file_id, hash in modified_hashes.iteritems():
841
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
842
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
844
def _sha_from_stat(self, path, stat_result):
845
"""Get a sha digest from the tree's stat cache.
847
The default implementation assumes no stat cache is present.
849
:param path: The path.
850
:param stat_result: The stat result being looked up.
854
def _put_rio(self, filename, stanzas, header):
855
self._must_be_locked()
856
my_file = rio_file(stanzas, header)
857
self._transport.put_file(filename, my_file,
858
mode=self._control_files._file_mode)
860
@needs_write_lock # because merge pulls data into the branch.
861
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
863
"""Merge from a branch into this working tree.
865
:param branch: The branch to merge from.
866
:param to_revision: If non-None, the merge will merge to to_revision,
867
but not beyond it. to_revision does not need to be in the history
868
of the branch when it is supplied. If None, to_revision defaults to
869
branch.last_revision().
871
from bzrlib.merge import Merger, Merge3Merger
872
pb = bzrlib.ui.ui_factory.nested_progress_bar()
874
merger = Merger(self.branch, this_tree=self, pb=pb)
875
merger.pp = ProgressPhase("Merge phase", 5, pb)
876
merger.pp.next_phase()
877
# check that there are no
879
merger.check_basis(check_clean=True, require_commits=False)
880
if to_revision is None:
881
to_revision = _mod_revision.ensure_null(branch.last_revision())
882
merger.other_rev_id = to_revision
883
if _mod_revision.is_null(merger.other_rev_id):
884
raise errors.NoCommits(branch)
885
self.branch.fetch(branch, last_revision=merger.other_rev_id)
886
merger.other_basis = merger.other_rev_id
887
merger.other_tree = self.branch.repository.revision_tree(
889
merger.other_branch = branch
890
merger.pp.next_phase()
891
if from_revision is None:
894
merger.set_base_revision(from_revision, branch)
895
if merger.base_rev_id == merger.other_rev_id:
896
raise errors.PointlessMerge
897
merger.backup_files = False
898
if merge_type is None:
899
merger.merge_type = Merge3Merger
901
merger.merge_type = merge_type
902
merger.set_interesting_files(None)
903
merger.show_base = False
904
merger.reprocess = False
905
conflicts = merger.do_merge()
912
def merge_modified(self):
913
"""Return a dictionary of files modified by a merge.
915
The list is initialized by WorkingTree.set_merge_modified, which is
916
typically called after we make some automatic updates to the tree
919
This returns a map of file_id->sha1, containing only files which are
920
still in the working inventory and have that text hash.
923
hashfile = self._transport.get('merge-hashes')
924
except errors.NoSuchFile:
929
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
930
raise errors.MergeModifiedFormatError()
931
except StopIteration:
932
raise errors.MergeModifiedFormatError()
933
for s in RioReader(hashfile):
934
# RioReader reads in Unicode, so convert file_ids back to utf8
935
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
936
if file_id not in self.inventory:
938
text_hash = s.get("hash")
939
if text_hash == self.get_file_sha1(file_id):
940
merge_hashes[file_id] = text_hash
946
def mkdir(self, path, file_id=None):
947
"""See MutableTree.mkdir()."""
949
file_id = generate_ids.gen_file_id(os.path.basename(path))
950
os.mkdir(self.abspath(path))
951
self.add(path, file_id, 'directory')
954
def get_symlink_target(self, file_id):
955
return os.readlink(self.id2abspath(file_id))
958
def subsume(self, other_tree):
959
def add_children(inventory, entry):
960
for child_entry in entry.children.values():
961
inventory._byid[child_entry.file_id] = child_entry
962
if child_entry.kind == 'directory':
963
add_children(inventory, child_entry)
964
if other_tree.get_root_id() == self.get_root_id():
965
raise errors.BadSubsumeSource(self, other_tree,
966
'Trees have the same root')
968
other_tree_path = self.relpath(other_tree.basedir)
969
except errors.PathNotChild:
970
raise errors.BadSubsumeSource(self, other_tree,
971
'Tree is not contained by the other')
972
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
973
if new_root_parent is None:
974
raise errors.BadSubsumeSource(self, other_tree,
975
'Parent directory is not versioned.')
976
# We need to ensure that the result of a fetch will have a
977
# versionedfile for the other_tree root, and only fetching into
978
# RepositoryKnit2 guarantees that.
979
if not self.branch.repository.supports_rich_root():
980
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
981
other_tree.lock_tree_write()
983
new_parents = other_tree.get_parent_ids()
984
other_root = other_tree.inventory.root
985
other_root.parent_id = new_root_parent
986
other_root.name = osutils.basename(other_tree_path)
987
self.inventory.add(other_root)
988
add_children(self.inventory, other_root)
989
self._write_inventory(self.inventory)
990
# normally we don't want to fetch whole repositories, but i think
991
# here we really do want to consolidate the whole thing.
992
for parent_id in other_tree.get_parent_ids():
993
self.branch.fetch(other_tree.branch, parent_id)
994
self.add_parent_tree_id(parent_id)
997
other_tree.bzrdir.retire_bzrdir()
999
def _setup_directory_is_tree_reference(self):
1000
if self._branch.repository._format.supports_tree_reference:
1001
self._directory_is_tree_reference = \
1002
self._directory_may_be_tree_reference
1004
self._directory_is_tree_reference = \
1005
self._directory_is_never_tree_reference
1007
def _directory_is_never_tree_reference(self, relpath):
1010
def _directory_may_be_tree_reference(self, relpath):
1011
# as a special case, if a directory contains control files then
1012
# it's a tree reference, except that the root of the tree is not
1013
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1014
# TODO: We could ask all the control formats whether they
1015
# recognize this directory, but at the moment there's no cheap api
1016
# to do that. Since we probably can only nest bzr checkouts and
1017
# they always use this name it's ok for now. -- mbp 20060306
1019
# FIXME: There is an unhandled case here of a subdirectory
1020
# containing .bzr but not a branch; that will probably blow up
1021
# when you try to commit it. It might happen if there is a
1022
# checkout in a subdirectory. This can be avoided by not adding
1025
@needs_tree_write_lock
1026
def extract(self, file_id, format=None):
1027
"""Extract a subtree from this tree.
1029
A new branch will be created, relative to the path for this tree.
1033
segments = osutils.splitpath(path)
1034
transport = self.branch.bzrdir.root_transport
1035
for name in segments:
1036
transport = transport.clone(name)
1037
transport.ensure_base()
1040
sub_path = self.id2path(file_id)
1041
branch_transport = mkdirs(sub_path)
1043
format = self.bzrdir.cloning_metadir()
1044
branch_transport.ensure_base()
1045
branch_bzrdir = format.initialize_on_transport(branch_transport)
1047
repo = branch_bzrdir.find_repository()
1048
except errors.NoRepositoryPresent:
1049
repo = branch_bzrdir.create_repository()
1050
if not repo.supports_rich_root():
1051
raise errors.RootNotRich()
1052
new_branch = branch_bzrdir.create_branch()
1053
new_branch.pull(self.branch)
1054
for parent_id in self.get_parent_ids():
1055
new_branch.fetch(self.branch, parent_id)
1056
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1057
if tree_transport.base != branch_transport.base:
1058
tree_bzrdir = format.initialize_on_transport(tree_transport)
1059
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1061
tree_bzrdir = branch_bzrdir
1062
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1063
wt.set_parent_ids(self.get_parent_ids())
1064
my_inv = self.inventory
1065
child_inv = Inventory(root_id=None)
1066
new_root = my_inv[file_id]
1067
my_inv.remove_recursive_id(file_id)
1068
new_root.parent_id = None
1069
child_inv.add(new_root)
1070
self._write_inventory(my_inv)
1071
wt._write_inventory(child_inv)
1074
def _serialize(self, inventory, out_file):
1075
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1078
def _deserialize(selt, in_file):
1079
return xml5.serializer_v5.read_inventory(in_file)
1082
"""Write the in memory inventory to disk."""
1083
# TODO: Maybe this should only write on dirty ?
1084
if self._control_files._lock_mode != 'w':
1085
raise errors.NotWriteLocked(self)
1087
self._serialize(self._inventory, sio)
1089
self._transport.put_file('inventory', sio,
1090
mode=self._control_files._file_mode)
1091
self._inventory_is_modified = False
1093
def _kind(self, relpath):
1094
return osutils.file_kind(self.abspath(relpath))
1096
def list_files(self, include_root=False):
1097
"""Recursively list all files as (path, class, kind, id, entry).
1099
Lists, but does not descend into unversioned directories.
1101
This does not include files that have been deleted in this
1104
Skips the control directory.
1106
# list_files is an iterator, so @needs_read_lock doesn't work properly
1107
# with it. So callers should be careful to always read_lock the tree.
1108
if not self.is_locked():
1109
raise errors.ObjectNotLocked(self)
1111
inv = self.inventory
1112
if include_root is True:
1113
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1114
# Convert these into local objects to save lookup times
1115
pathjoin = osutils.pathjoin
1116
file_kind = self._kind
1118
# transport.base ends in a slash, we want the piece
1119
# between the last two slashes
1120
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1122
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1124
# directory file_id, relative path, absolute path, reverse sorted children
1125
children = os.listdir(self.basedir)
1127
# jam 20060527 The kernel sized tree seems equivalent whether we
1128
# use a deque and popleft to keep them sorted, or if we use a plain
1129
# list and just reverse() them.
1130
children = collections.deque(children)
1131
stack = [(inv.root.file_id, u'', self.basedir, children)]
1133
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1136
f = children.popleft()
1137
## TODO: If we find a subdirectory with its own .bzr
1138
## directory, then that is a separate tree and we
1139
## should exclude it.
1141
# the bzrdir for this tree
1142
if transport_base_dir == f:
1145
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1146
# and 'f' doesn't begin with one, we can do a string op, rather
1147
# than the checks of pathjoin(), all relative paths will have an extra slash
1149
fp = from_dir_relpath + '/' + f
1152
fap = from_dir_abspath + '/' + f
1154
f_ie = inv.get_child(from_dir_id, f)
1157
elif self.is_ignored(fp[1:]):
1160
# we may not have found this file, because of a unicode issue
1161
f_norm, can_access = osutils.normalized_filename(f)
1162
if f == f_norm or not can_access:
1163
# No change, so treat this file normally
1166
# this file can be accessed by a normalized path
1167
# check again if it is versioned
1168
# these lines are repeated here for performance
1170
fp = from_dir_relpath + '/' + f
1171
fap = from_dir_abspath + '/' + f
1172
f_ie = inv.get_child(from_dir_id, f)
1175
elif self.is_ignored(fp[1:]):
1182
# make a last minute entry
1184
yield fp[1:], c, fk, f_ie.file_id, f_ie
1187
yield fp[1:], c, fk, None, fk_entries[fk]()
1189
yield fp[1:], c, fk, None, TreeEntry()
1192
if fk != 'directory':
1195
# But do this child first
1196
new_children = os.listdir(fap)
1198
new_children = collections.deque(new_children)
1199
stack.append((f_ie.file_id, fp, fap, new_children))
1200
# Break out of inner loop,
1201
# so that we start outer loop with child
1204
# if we finished all children, pop it off the stack
1207
@needs_tree_write_lock
1208
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1211
to_dir must exist in the inventory.
1213
If to_dir exists and is a directory, the files are moved into
1214
it, keeping their old names.
1216
Note that to_dir is only the last component of the new name;
1217
this doesn't change the directory.
1219
For each entry in from_paths the move mode will be determined
1222
The first mode moves the file in the filesystem and updates the
1223
inventory. The second mode only updates the inventory without
1224
touching the file on the filesystem. This is the new mode introduced
1227
move uses the second mode if 'after == True' and the target is not
1228
versioned but present in the working tree.
1230
move uses the second mode if 'after == False' and the source is
1231
versioned but no longer in the working tree, and the target is not
1232
versioned but present in the working tree.
1234
move uses the first mode if 'after == False' and the source is
1235
versioned and present in the working tree, and the target is not
1236
versioned and not present in the working tree.
1238
Everything else results in an error.
1240
This returns a list of (from_path, to_path) pairs for each
1241
entry that is moved.
1246
# check for deprecated use of signature
1248
to_dir = kwargs.get('to_name', None)
1250
raise TypeError('You must supply a target directory')
1252
symbol_versioning.warn('The parameter to_name was deprecated'
1253
' in version 0.13. Use to_dir instead',
1256
# check destination directory
1257
if isinstance(from_paths, basestring):
1259
inv = self.inventory
1260
to_abs = self.abspath(to_dir)
1261
if not isdir(to_abs):
1262
raise errors.BzrMoveFailedError('',to_dir,
1263
errors.NotADirectory(to_abs))
1264
if not self.has_filename(to_dir):
1265
raise errors.BzrMoveFailedError('',to_dir,
1266
errors.NotInWorkingDirectory(to_dir))
1267
to_dir_id = inv.path2id(to_dir)
1268
if to_dir_id is None:
1269
raise errors.BzrMoveFailedError('',to_dir,
1270
errors.NotVersionedError(path=str(to_dir)))
1272
to_dir_ie = inv[to_dir_id]
1273
if to_dir_ie.kind != 'directory':
1274
raise errors.BzrMoveFailedError('',to_dir,
1275
errors.NotADirectory(to_abs))
1277
# create rename entries and tuples
1278
for from_rel in from_paths:
1279
from_tail = splitpath(from_rel)[-1]
1280
from_id = inv.path2id(from_rel)
1282
raise errors.BzrMoveFailedError(from_rel,to_dir,
1283
errors.NotVersionedError(path=str(from_rel)))
1285
from_entry = inv[from_id]
1286
from_parent_id = from_entry.parent_id
1287
to_rel = pathjoin(to_dir, from_tail)
1288
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1290
from_tail=from_tail,
1291
from_parent_id=from_parent_id,
1292
to_rel=to_rel, to_tail=from_tail,
1293
to_parent_id=to_dir_id)
1294
rename_entries.append(rename_entry)
1295
rename_tuples.append((from_rel, to_rel))
1297
# determine which move mode to use. checks also for movability
1298
rename_entries = self._determine_mv_mode(rename_entries, after)
1300
original_modified = self._inventory_is_modified
1303
self._inventory_is_modified = True
1304
self._move(rename_entries)
1306
# restore the inventory on error
1307
self._inventory_is_modified = original_modified
1309
self._write_inventory(inv)
1310
return rename_tuples
1312
def _determine_mv_mode(self, rename_entries, after=False):
1313
"""Determines for each from-to pair if both inventory and working tree
1314
or only the inventory has to be changed.
1316
Also does basic plausability tests.
1318
inv = self.inventory
1320
for rename_entry in rename_entries:
1321
# store to local variables for easier reference
1322
from_rel = rename_entry.from_rel
1323
from_id = rename_entry.from_id
1324
to_rel = rename_entry.to_rel
1325
to_id = inv.path2id(to_rel)
1326
only_change_inv = False
1328
# check the inventory for source and destination
1330
raise errors.BzrMoveFailedError(from_rel,to_rel,
1331
errors.NotVersionedError(path=str(from_rel)))
1332
if to_id is not None:
1333
raise errors.BzrMoveFailedError(from_rel,to_rel,
1334
errors.AlreadyVersionedError(path=str(to_rel)))
1336
# try to determine the mode for rename (only change inv or change
1337
# inv and file system)
1339
if not self.has_filename(to_rel):
1340
raise errors.BzrMoveFailedError(from_id,to_rel,
1341
errors.NoSuchFile(path=str(to_rel),
1342
extra="New file has not been created yet"))
1343
only_change_inv = True
1344
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1345
only_change_inv = True
1346
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1347
only_change_inv = False
1348
elif (not self.case_sensitive
1349
and from_rel.lower() == to_rel.lower()
1350
and self.has_filename(from_rel)):
1351
only_change_inv = False
1353
# something is wrong, so lets determine what exactly
1354
if not self.has_filename(from_rel) and \
1355
not self.has_filename(to_rel):
1356
raise errors.BzrRenameFailedError(from_rel,to_rel,
1357
errors.PathsDoNotExist(paths=(str(from_rel),
1360
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1361
rename_entry.only_change_inv = only_change_inv
1362
return rename_entries
1364
def _move(self, rename_entries):
1365
"""Moves a list of files.
1367
Depending on the value of the flag 'only_change_inv', the
1368
file will be moved on the file system or not.
1370
inv = self.inventory
1373
for entry in rename_entries:
1375
self._move_entry(entry)
1377
self._rollback_move(moved)
1381
def _rollback_move(self, moved):
1382
"""Try to rollback a previous move in case of an filesystem error."""
1383
inv = self.inventory
1386
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1387
entry.to_tail, entry.to_parent_id, entry.from_rel,
1388
entry.from_tail, entry.from_parent_id,
1389
entry.only_change_inv))
1390
except errors.BzrMoveFailedError, e:
1391
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1392
" The working tree is in an inconsistent state."
1393
" Please consider doing a 'bzr revert'."
1394
" Error message is: %s" % e)
1396
def _move_entry(self, entry):
1397
inv = self.inventory
1398
from_rel_abs = self.abspath(entry.from_rel)
1399
to_rel_abs = self.abspath(entry.to_rel)
1400
if from_rel_abs == to_rel_abs:
1401
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1402
"Source and target are identical.")
1404
if not entry.only_change_inv:
1406
osutils.rename(from_rel_abs, to_rel_abs)
1408
raise errors.BzrMoveFailedError(entry.from_rel,
1410
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1412
@needs_tree_write_lock
1413
def rename_one(self, from_rel, to_rel, after=False):
1416
This can change the directory or the filename or both.
1418
rename_one has several 'modes' to work. First, it can rename a physical
1419
file and change the file_id. That is the normal mode. Second, it can
1420
only change the file_id without touching any physical file. This is
1421
the new mode introduced in version 0.15.
1423
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1424
versioned but present in the working tree.
1426
rename_one uses the second mode if 'after == False' and 'from_rel' is
1427
versioned but no longer in the working tree, and 'to_rel' is not
1428
versioned but present in the working tree.
1430
rename_one uses the first mode if 'after == False' and 'from_rel' is
1431
versioned and present in the working tree, and 'to_rel' is not
1432
versioned and not present in the working tree.
1434
Everything else results in an error.
1436
inv = self.inventory
1439
# create rename entries and tuples
1440
from_tail = splitpath(from_rel)[-1]
1441
from_id = inv.path2id(from_rel)
1443
raise errors.BzrRenameFailedError(from_rel,to_rel,
1444
errors.NotVersionedError(path=str(from_rel)))
1445
from_entry = inv[from_id]
1446
from_parent_id = from_entry.parent_id
1447
to_dir, to_tail = os.path.split(to_rel)
1448
to_dir_id = inv.path2id(to_dir)
1449
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1451
from_tail=from_tail,
1452
from_parent_id=from_parent_id,
1453
to_rel=to_rel, to_tail=to_tail,
1454
to_parent_id=to_dir_id)
1455
rename_entries.append(rename_entry)
1457
# determine which move mode to use. checks also for movability
1458
rename_entries = self._determine_mv_mode(rename_entries, after)
1460
# check if the target changed directory and if the target directory is
1462
if to_dir_id is None:
1463
raise errors.BzrMoveFailedError(from_rel,to_rel,
1464
errors.NotVersionedError(path=str(to_dir)))
1466
# all checks done. now we can continue with our actual work
1467
mutter('rename_one:\n'
1472
' to_dir_id {%s}\n',
1473
from_id, from_rel, to_rel, to_dir, to_dir_id)
1475
self._move(rename_entries)
1476
self._write_inventory(inv)
1478
class _RenameEntry(object):
1479
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1480
to_rel, to_tail, to_parent_id, only_change_inv=False):
1481
self.from_rel = from_rel
1482
self.from_id = from_id
1483
self.from_tail = from_tail
1484
self.from_parent_id = from_parent_id
1485
self.to_rel = to_rel
1486
self.to_tail = to_tail
1487
self.to_parent_id = to_parent_id
1488
self.only_change_inv = only_change_inv
1492
"""Return all unknown files.
1494
These are files in the working directory that are not versioned or
1495
control files or ignored.
1497
# force the extras method to be fully executed before returning, to
1498
# prevent race conditions with the lock
1500
[subp for subp in self.extras() if not self.is_ignored(subp)])
1502
@needs_tree_write_lock
1503
def unversion(self, file_ids):
1504
"""Remove the file ids in file_ids from the current versioned set.
1506
When a file_id is unversioned, all of its children are automatically
1509
:param file_ids: The file ids to stop versioning.
1510
:raises: NoSuchId if any fileid is not currently versioned.
1512
for file_id in file_ids:
1513
if self._inventory.has_id(file_id):
1514
self._inventory.remove_recursive_id(file_id)
1516
raise errors.NoSuchId(self, file_id)
1518
# in the future this should just set a dirty bit to wait for the
1519
# final unlock. However, until all methods of workingtree start
1520
# with the current in -memory inventory rather than triggering
1521
# a read, it is more complex - we need to teach read_inventory
1522
# to know when to read, and when to not read first... and possibly
1523
# to save first when the in memory one may be corrupted.
1524
# so for now, we just only write it if it is indeed dirty.
1526
self._write_inventory(self._inventory)
1528
def _iter_conflicts(self):
1530
for info in self.list_files():
1532
stem = get_conflicted_stem(path)
1535
if stem not in conflicted:
1536
conflicted.add(stem)
1540
def pull(self, source, overwrite=False, stop_revision=None,
1541
change_reporter=None, possible_transports=None):
1542
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1545
pp = ProgressPhase("Pull phase", 2, top_pb)
1547
old_revision_info = self.branch.last_revision_info()
1548
basis_tree = self.basis_tree()
1549
count = self.branch.pull(source, overwrite, stop_revision,
1550
possible_transports=possible_transports)
1551
new_revision_info = self.branch.last_revision_info()
1552
if new_revision_info != old_revision_info:
1554
repository = self.branch.repository
1555
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1556
basis_tree.lock_read()
1558
new_basis_tree = self.branch.basis_tree()
1565
change_reporter=change_reporter)
1566
if (basis_tree.inventory.root is None and
1567
new_basis_tree.inventory.root is not None):
1568
self.set_root_id(new_basis_tree.get_root_id())
1572
# TODO - dedup parents list with things merged by pull ?
1573
# reuse the revisiontree we merged against to set the new
1575
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1576
# we have to pull the merge trees out again, because
1577
# merge_inner has set the ids. - this corner is not yet
1578
# layered well enough to prevent double handling.
1579
# XXX TODO: Fix the double handling: telling the tree about
1580
# the already known parent data is wasteful.
1581
merges = self.get_parent_ids()[1:]
1582
parent_trees.extend([
1583
(parent, repository.revision_tree(parent)) for
1585
self.set_parent_trees(parent_trees)
1592
def put_file_bytes_non_atomic(self, file_id, bytes):
1593
"""See MutableTree.put_file_bytes_non_atomic."""
1594
stream = file(self.id2abspath(file_id), 'wb')
1599
# TODO: update the hashcache here ?
1602
"""Yield all unversioned files in this WorkingTree.
1604
If there are any unversioned directories then only the directory is
1605
returned, not all its children. But if there are unversioned files
1606
under a versioned subdirectory, they are returned.
1608
Currently returned depth-first, sorted by name within directories.
1609
This is the same order used by 'osutils.walkdirs'.
1611
## TODO: Work from given directory downwards
1612
for path, dir_entry in self.inventory.directories():
1613
# mutter("search for unknowns in %r", path)
1614
dirabs = self.abspath(path)
1615
if not isdir(dirabs):
1616
# e.g. directory deleted
1620
for subf in os.listdir(dirabs):
1623
if subf not in dir_entry.children:
1626
can_access) = osutils.normalized_filename(subf)
1627
except UnicodeDecodeError:
1628
path_os_enc = path.encode(osutils._fs_enc)
1629
relpath = path_os_enc + '/' + subf
1630
raise errors.BadFilenameEncoding(relpath,
1632
if subf_norm != subf and can_access:
1633
if subf_norm not in dir_entry.children:
1634
fl.append(subf_norm)
1640
subp = pathjoin(path, subf)
1643
def ignored_files(self):
1644
"""Yield list of PATH, IGNORE_PATTERN"""
1645
for subp in self.extras():
1646
pat = self.is_ignored(subp)
1650
def get_ignore_list(self):
1651
"""Return list of ignore patterns.
1653
Cached in the Tree object after the first call.
1655
ignoreset = getattr(self, '_ignoreset', None)
1656
if ignoreset is not None:
1659
ignore_globs = set()
1660
ignore_globs.update(ignores.get_runtime_ignores())
1661
ignore_globs.update(ignores.get_user_ignores())
1662
if self.has_filename(bzrlib.IGNORE_FILENAME):
1663
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1665
ignore_globs.update(ignores.parse_ignore_file(f))
1668
self._ignoreset = ignore_globs
1671
def _flush_ignore_list_cache(self):
1672
"""Resets the cached ignore list to force a cache rebuild."""
1673
self._ignoreset = None
1674
self._ignoreglobster = None
1676
def is_ignored(self, filename):
1677
r"""Check whether the filename matches an ignore pattern.
1679
Patterns containing '/' or '\' need to match the whole path;
1680
others match against only the last component.
1682
If the file is ignored, returns the pattern which caused it to
1683
be ignored, otherwise None. So this can simply be used as a
1684
boolean if desired."""
1685
if getattr(self, '_ignoreglobster', None) is None:
1686
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1687
return self._ignoreglobster.match(filename)
1689
def kind(self, file_id):
1690
return file_kind(self.id2abspath(file_id))
1692
def stored_kind(self, file_id):
1693
"""See Tree.stored_kind"""
1694
return self.inventory[file_id].kind
1696
def _comparison_data(self, entry, path):
1697
abspath = self.abspath(path)
1699
stat_value = os.lstat(abspath)
1701
if getattr(e, 'errno', None) == errno.ENOENT:
1708
mode = stat_value.st_mode
1709
kind = osutils.file_kind_from_stat_mode(mode)
1710
if not supports_executable():
1711
executable = entry is not None and entry.executable
1713
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1714
return kind, executable, stat_value
1716
def _file_size(self, entry, stat_value):
1717
return stat_value.st_size
1719
def last_revision(self):
1720
"""Return the last revision of the branch for this tree.
1722
This format tree does not support a separate marker for last-revision
1723
compared to the branch.
1725
See MutableTree.last_revision
1727
return self._last_revision()
1730
def _last_revision(self):
1731
"""helper for get_parent_ids."""
1732
return _mod_revision.ensure_null(self.branch.last_revision())
1734
def is_locked(self):
1735
return self._control_files.is_locked()
1737
def _must_be_locked(self):
1738
if not self.is_locked():
1739
raise errors.ObjectNotLocked(self)
1741
def lock_read(self):
1742
"""See Branch.lock_read, and WorkingTree.unlock."""
1743
if not self.is_locked():
1745
self.branch.lock_read()
1747
return self._control_files.lock_read()
1749
self.branch.unlock()
1752
def lock_tree_write(self):
1753
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1754
if not self.is_locked():
1756
self.branch.lock_read()
1758
return self._control_files.lock_write()
1760
self.branch.unlock()
1763
def lock_write(self):
1764
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1765
if not self.is_locked():
1767
self.branch.lock_write()
1769
return self._control_files.lock_write()
1771
self.branch.unlock()
1774
def get_physical_lock_status(self):
1775
return self._control_files.get_physical_lock_status()
1777
def _basis_inventory_name(self):
1778
return 'basis-inventory-cache'
1780
def _reset_data(self):
1781
"""Reset transient data that cannot be revalidated."""
1782
self._inventory_is_modified = False
1783
result = self._deserialize(self._transport.get('inventory'))
1784
self._set_inventory(result, dirty=False)
1786
@needs_tree_write_lock
1787
def set_last_revision(self, new_revision):
1788
"""Change the last revision in the working tree."""
1789
if self._change_last_revision(new_revision):
1790
self._cache_basis_inventory(new_revision)
1792
def _change_last_revision(self, new_revision):
1793
"""Template method part of set_last_revision to perform the change.
1795
This is used to allow WorkingTree3 instances to not affect branch
1796
when their last revision is set.
1798
if _mod_revision.is_null(new_revision):
1799
self.branch.set_revision_history([])
1802
self.branch.generate_revision_history(new_revision)
1803
except errors.NoSuchRevision:
1804
# not present in the repo - dont try to set it deeper than the tip
1805
self.branch.set_revision_history([new_revision])
1808
def _write_basis_inventory(self, xml):
1809
"""Write the basis inventory XML to the basis-inventory file"""
1810
path = self._basis_inventory_name()
1812
self._transport.put_file(path, sio,
1813
mode=self._control_files._file_mode)
1815
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1816
"""Create the text that will be saved in basis-inventory"""
1817
inventory.revision_id = revision_id
1818
return xml7.serializer_v7.write_inventory_to_string(inventory)
1820
def _cache_basis_inventory(self, new_revision):
1821
"""Cache new_revision as the basis inventory."""
1822
# TODO: this should allow the ready-to-use inventory to be passed in,
1823
# as commit already has that ready-to-use [while the format is the
1826
# this double handles the inventory - unpack and repack -
1827
# but is easier to understand. We can/should put a conditional
1828
# in here based on whether the inventory is in the latest format
1829
# - perhaps we should repack all inventories on a repository
1831
# the fast path is to copy the raw xml from the repository. If the
1832
# xml contains 'revision_id="', then we assume the right
1833
# revision_id is set. We must check for this full string, because a
1834
# root node id can legitimately look like 'revision_id' but cannot
1836
xml = self.branch.repository.get_inventory_xml(new_revision)
1837
firstline = xml.split('\n', 1)[0]
1838
if (not 'revision_id="' in firstline or
1839
'format="7"' not in firstline):
1840
inv = self.branch.repository.deserialise_inventory(
1842
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1843
self._write_basis_inventory(xml)
1844
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1847
def read_basis_inventory(self):
1848
"""Read the cached basis inventory."""
1849
path = self._basis_inventory_name()
1850
return self._transport.get_bytes(path)
1853
def read_working_inventory(self):
1854
"""Read the working inventory.
1856
:raises errors.InventoryModified: read_working_inventory will fail
1857
when the current in memory inventory has been modified.
1859
# conceptually this should be an implementation detail of the tree.
1860
# XXX: Deprecate this.
1861
# ElementTree does its own conversion from UTF-8, so open in
1863
if self._inventory_is_modified:
1864
raise errors.InventoryModified(self)
1865
result = self._deserialize(self._transport.get('inventory'))
1866
self._set_inventory(result, dirty=False)
1869
@needs_tree_write_lock
1870
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1872
"""Remove nominated files from the working inventory.
1874
:files: File paths relative to the basedir.
1875
:keep_files: If true, the files will also be kept.
1876
:force: Delete files and directories, even if they are changed and
1877
even if the directories are not empty.
1879
if isinstance(files, basestring):
1885
unknown_nested_files=set()
1887
def recurse_directory_to_add_files(directory):
1888
# Recurse directory and add all files
1889
# so we can check if they have changed.
1890
for parent_info, file_infos in\
1891
self.walkdirs(directory):
1892
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1893
# Is it versioned or ignored?
1894
if self.path2id(relpath) or self.is_ignored(relpath):
1895
# Add nested content for deletion.
1896
new_files.add(relpath)
1898
# Files which are not versioned and not ignored
1899
# should be treated as unknown.
1900
unknown_nested_files.add((relpath, None, kind))
1902
for filename in files:
1903
# Get file name into canonical form.
1904
abspath = self.abspath(filename)
1905
filename = self.relpath(abspath)
1906
if len(filename) > 0:
1907
new_files.add(filename)
1908
recurse_directory_to_add_files(filename)
1910
files = list(new_files)
1913
return # nothing to do
1915
# Sort needed to first handle directory content before the directory
1916
files.sort(reverse=True)
1918
# Bail out if we are going to delete files we shouldn't
1919
if not keep_files and not force:
1920
has_changed_files = len(unknown_nested_files) > 0
1921
if not has_changed_files:
1922
for (file_id, path, content_change, versioned, parent_id, name,
1923
kind, executable) in self.iter_changes(self.basis_tree(),
1924
include_unchanged=True, require_versioned=False,
1925
want_unversioned=True, specific_files=files):
1926
if versioned == (False, False):
1927
# The record is unknown ...
1928
if not self.is_ignored(path[1]):
1929
# ... but not ignored
1930
has_changed_files = True
1932
elif content_change and (kind[1] is not None):
1933
# Versioned and changed, but not deleted
1934
has_changed_files = True
1937
if has_changed_files:
1938
# Make delta show ALL applicable changes in error message.
1939
tree_delta = self.changes_from(self.basis_tree(),
1940
require_versioned=False, want_unversioned=True,
1941
specific_files=files)
1942
for unknown_file in unknown_nested_files:
1943
if unknown_file not in tree_delta.unversioned:
1944
tree_delta.unversioned.extend((unknown_file,))
1945
raise errors.BzrRemoveChangedFilesError(tree_delta)
1947
# Build inv_delta and delete files where applicaple,
1948
# do this before any modifications to inventory.
1950
fid = self.path2id(f)
1953
message = "%s is not versioned." % (f,)
1956
# having removed it, it must be either ignored or unknown
1957
if self.is_ignored(f):
1961
textui.show_status(new_status, self.kind(fid), f,
1964
inv_delta.append((f, None, fid, None))
1965
message = "removed %s" % (f,)
1968
abs_path = self.abspath(f)
1969
if osutils.lexists(abs_path):
1970
if (osutils.isdir(abs_path) and
1971
len(os.listdir(abs_path)) > 0):
1973
osutils.rmtree(abs_path)
1975
message = "%s is not an empty directory "\
1976
"and won't be deleted." % (f,)
1978
osutils.delete_any(abs_path)
1979
message = "deleted %s" % (f,)
1980
elif message is not None:
1981
# Only care if we haven't done anything yet.
1982
message = "%s does not exist." % (f,)
1984
# Print only one message (if any) per file.
1985
if message is not None:
1987
self.apply_inventory_delta(inv_delta)
1989
@needs_tree_write_lock
1990
def revert(self, filenames=None, old_tree=None, backups=True,
1991
pb=DummyProgress(), report_changes=False):
1992
from bzrlib.conflicts import resolve
1995
symbol_versioning.warn('Using [] to revert all files is deprecated'
1996
' as of bzr 0.91. Please use None (the default) instead.',
1997
DeprecationWarning, stacklevel=2)
1998
if old_tree is None:
1999
basis_tree = self.basis_tree()
2000
basis_tree.lock_read()
2001
old_tree = basis_tree
2005
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2007
if filenames is None and len(self.get_parent_ids()) > 1:
2009
last_revision = self.last_revision()
2010
if last_revision != NULL_REVISION:
2011
if basis_tree is None:
2012
basis_tree = self.basis_tree()
2013
basis_tree.lock_read()
2014
parent_trees.append((last_revision, basis_tree))
2015
self.set_parent_trees(parent_trees)
2018
resolve(self, filenames, ignore_misses=True, recursive=True)
2020
if basis_tree is not None:
2024
def revision_tree(self, revision_id):
2025
"""See Tree.revision_tree.
2027
WorkingTree can supply revision_trees for the basis revision only
2028
because there is only one cached inventory in the bzr directory.
2030
if revision_id == self.last_revision():
2032
xml = self.read_basis_inventory()
2033
except errors.NoSuchFile:
2037
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2038
# dont use the repository revision_tree api because we want
2039
# to supply the inventory.
2040
if inv.revision_id == revision_id:
2041
return revisiontree.RevisionTree(self.branch.repository,
2043
except errors.BadInventoryFormat:
2045
# raise if there was no inventory, or if we read the wrong inventory.
2046
raise errors.NoSuchRevisionInTree(self, revision_id)
2048
# XXX: This method should be deprecated in favour of taking in a proper
2049
# new Inventory object.
2050
@needs_tree_write_lock
2051
def set_inventory(self, new_inventory_list):
2052
from bzrlib.inventory import (Inventory,
2057
inv = Inventory(self.get_root_id())
2058
for path, file_id, parent, kind in new_inventory_list:
2059
name = os.path.basename(path)
2062
# fixme, there should be a factory function inv,add_??
2063
if kind == 'directory':
2064
inv.add(InventoryDirectory(file_id, name, parent))
2065
elif kind == 'file':
2066
inv.add(InventoryFile(file_id, name, parent))
2067
elif kind == 'symlink':
2068
inv.add(InventoryLink(file_id, name, parent))
2070
raise errors.BzrError("unknown kind %r" % kind)
2071
self._write_inventory(inv)
2073
@needs_tree_write_lock
2074
def set_root_id(self, file_id):
2075
"""Set the root id for this tree."""
2079
'WorkingTree.set_root_id with fileid=None')
2080
file_id = osutils.safe_file_id(file_id)
2081
self._set_root_id(file_id)
2083
def _set_root_id(self, file_id):
2084
"""Set the root id for this tree, in a format specific manner.
2086
:param file_id: The file id to assign to the root. It must not be
2087
present in the current inventory or an error will occur. It must
2088
not be None, but rather a valid file id.
2090
inv = self._inventory
2091
orig_root_id = inv.root.file_id
2092
# TODO: it might be nice to exit early if there was nothing
2093
# to do, saving us from trigger a sync on unlock.
2094
self._inventory_is_modified = True
2095
# we preserve the root inventory entry object, but
2096
# unlinkit from the byid index
2097
del inv._byid[inv.root.file_id]
2098
inv.root.file_id = file_id
2099
# and link it into the index with the new changed id.
2100
inv._byid[inv.root.file_id] = inv.root
2101
# and finally update all children to reference the new id.
2102
# XXX: this should be safe to just look at the root.children
2103
# list, not the WHOLE INVENTORY.
2106
if entry.parent_id == orig_root_id:
2107
entry.parent_id = inv.root.file_id
2110
"""See Branch.unlock.
2112
WorkingTree locking just uses the Branch locking facilities.
2113
This is current because all working trees have an embedded branch
2114
within them. IF in the future, we were to make branch data shareable
2115
between multiple working trees, i.e. via shared storage, then we
2116
would probably want to lock both the local tree, and the branch.
2118
raise NotImplementedError(self.unlock)
2120
def update(self, change_reporter=None, possible_transports=None):
2121
"""Update a working tree along its branch.
2123
This will update the branch if its bound too, which means we have
2124
multiple trees involved:
2126
- The new basis tree of the master.
2127
- The old basis tree of the branch.
2128
- The old basis tree of the working tree.
2129
- The current working tree state.
2131
Pathologically, all three may be different, and non-ancestors of each
2132
other. Conceptually we want to:
2134
- Preserve the wt.basis->wt.state changes
2135
- Transform the wt.basis to the new master basis.
2136
- Apply a merge of the old branch basis to get any 'local' changes from
2138
- Restore the wt.basis->wt.state changes.
2140
There isn't a single operation at the moment to do that, so we:
2141
- Merge current state -> basis tree of the master w.r.t. the old tree
2143
- Do a 'normal' merge of the old branch basis if it is relevant.
2145
if self.branch.get_bound_location() is not None:
2147
update_branch = True
2149
self.lock_tree_write()
2150
update_branch = False
2153
old_tip = self.branch.update(possible_transports)
2156
return self._update_tree(old_tip, change_reporter)
2160
@needs_tree_write_lock
2161
def _update_tree(self, old_tip=None, change_reporter=None):
2162
"""Update a tree to the master branch.
2164
:param old_tip: if supplied, the previous tip revision the branch,
2165
before it was changed to the master branch's tip.
2167
# here if old_tip is not None, it is the old tip of the branch before
2168
# it was updated from the master branch. This should become a pending
2169
# merge in the working tree to preserve the user existing work. we
2170
# cant set that until we update the working trees last revision to be
2171
# one from the new branch, because it will just get absorbed by the
2172
# parent de-duplication logic.
2174
# We MUST save it even if an error occurs, because otherwise the users
2175
# local work is unreferenced and will appear to have been lost.
2179
last_rev = self.get_parent_ids()[0]
2181
last_rev = _mod_revision.NULL_REVISION
2182
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2183
# merge tree state up to new branch tip.
2184
basis = self.basis_tree()
2187
to_tree = self.branch.basis_tree()
2188
if basis.inventory.root is None:
2189
self.set_root_id(to_tree.get_root_id())
2191
result += merge.merge_inner(
2196
change_reporter=change_reporter)
2199
# TODO - dedup parents list with things merged by pull ?
2200
# reuse the tree we've updated to to set the basis:
2201
parent_trees = [(self.branch.last_revision(), to_tree)]
2202
merges = self.get_parent_ids()[1:]
2203
# Ideally we ask the tree for the trees here, that way the working
2204
# tree can decide whether to give us teh entire tree or give us a
2205
# lazy initialised tree. dirstate for instance will have the trees
2206
# in ram already, whereas a last-revision + basis-inventory tree
2207
# will not, but also does not need them when setting parents.
2208
for parent in merges:
2209
parent_trees.append(
2210
(parent, self.branch.repository.revision_tree(parent)))
2211
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2212
parent_trees.append(
2213
(old_tip, self.branch.repository.revision_tree(old_tip)))
2214
self.set_parent_trees(parent_trees)
2215
last_rev = parent_trees[0][0]
2217
# the working tree had the same last-revision as the master
2218
# branch did. We may still have pivot local work from the local
2219
# branch into old_tip:
2220
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2221
self.add_parent_tree_id(old_tip)
2222
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2223
and old_tip != last_rev):
2224
# our last revision was not the prior branch last revision
2225
# and we have converted that last revision to a pending merge.
2226
# base is somewhere between the branch tip now
2227
# and the now pending merge
2229
# Since we just modified the working tree and inventory, flush out
2230
# the current state, before we modify it again.
2231
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2232
# requires it only because TreeTransform directly munges the
2233
# inventory and calls tree._write_inventory(). Ultimately we
2234
# should be able to remove this extra flush.
2236
graph = self.branch.repository.get_graph()
2237
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2239
base_tree = self.branch.repository.revision_tree(base_rev_id)
2240
other_tree = self.branch.repository.revision_tree(old_tip)
2241
result += merge.merge_inner(
2246
change_reporter=change_reporter)
2249
def _write_hashcache_if_dirty(self):
2250
"""Write out the hashcache if it is dirty."""
2251
if self._hashcache.needs_write:
2253
self._hashcache.write()
2255
if e.errno not in (errno.EPERM, errno.EACCES):
2257
# TODO: jam 20061219 Should this be a warning? A single line
2258
# warning might be sufficient to let the user know what
2260
mutter('Could not write hashcache for %s\nError: %s',
2261
self._hashcache.cache_file_name(), e)
2263
@needs_tree_write_lock
2264
def _write_inventory(self, inv):
2265
"""Write inventory as the current inventory."""
2266
self._set_inventory(inv, dirty=True)
2269
def set_conflicts(self, arg):
2270
raise errors.UnsupportedOperation(self.set_conflicts, self)
2272
def add_conflicts(self, arg):
2273
raise errors.UnsupportedOperation(self.add_conflicts, self)
2276
def conflicts(self):
2277
conflicts = _mod_conflicts.ConflictList()
2278
for conflicted in self._iter_conflicts():
2281
if file_kind(self.abspath(conflicted)) != "file":
2283
except errors.NoSuchFile:
2286
for suffix in ('.THIS', '.OTHER'):
2288
kind = file_kind(self.abspath(conflicted+suffix))
2291
except errors.NoSuchFile:
2295
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2296
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2298
file_id=self.path2id(conflicted)))
2301
def walkdirs(self, prefix=""):
2302
"""Walk the directories of this tree.
2304
returns a generator which yields items in the form:
2305
((curren_directory_path, fileid),
2306
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2309
This API returns a generator, which is only valid during the current
2310
tree transaction - within a single lock_read or lock_write duration.
2312
If the tree is not locked, it may cause an error to be raised,
2313
depending on the tree implementation.
2315
disk_top = self.abspath(prefix)
2316
if disk_top.endswith('/'):
2317
disk_top = disk_top[:-1]
2318
top_strip_len = len(disk_top) + 1
2319
inventory_iterator = self._walkdirs(prefix)
2320
disk_iterator = osutils.walkdirs(disk_top, prefix)
2322
current_disk = disk_iterator.next()
2323
disk_finished = False
2325
if not (e.errno == errno.ENOENT or
2326
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2329
disk_finished = True
2331
current_inv = inventory_iterator.next()
2332
inv_finished = False
2333
except StopIteration:
2336
while not inv_finished or not disk_finished:
2338
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2339
cur_disk_dir_content) = current_disk
2341
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2342
cur_disk_dir_content) = ((None, None), None)
2343
if not disk_finished:
2344
# strip out .bzr dirs
2345
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2346
len(cur_disk_dir_content) > 0):
2347
# osutils.walkdirs can be made nicer -
2348
# yield the path-from-prefix rather than the pathjoined
2350
bzrdir_loc = bisect_left(cur_disk_dir_content,
2352
if (bzrdir_loc < len(cur_disk_dir_content)
2353
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2354
# we dont yield the contents of, or, .bzr itself.
2355
del cur_disk_dir_content[bzrdir_loc]
2357
# everything is unknown
2360
# everything is missing
2363
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2365
# disk is before inventory - unknown
2366
dirblock = [(relpath, basename, kind, stat, None, None) for
2367
relpath, basename, kind, stat, top_path in
2368
cur_disk_dir_content]
2369
yield (cur_disk_dir_relpath, None), dirblock
2371
current_disk = disk_iterator.next()
2372
except StopIteration:
2373
disk_finished = True
2375
# inventory is before disk - missing.
2376
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2377
for relpath, basename, dkind, stat, fileid, kind in
2379
yield (current_inv[0][0], current_inv[0][1]), dirblock
2381
current_inv = inventory_iterator.next()
2382
except StopIteration:
2385
# versioned present directory
2386
# merge the inventory and disk data together
2388
for relpath, subiterator in itertools.groupby(sorted(
2389
current_inv[1] + cur_disk_dir_content,
2390
key=operator.itemgetter(0)), operator.itemgetter(1)):
2391
path_elements = list(subiterator)
2392
if len(path_elements) == 2:
2393
inv_row, disk_row = path_elements
2394
# versioned, present file
2395
dirblock.append((inv_row[0],
2396
inv_row[1], disk_row[2],
2397
disk_row[3], inv_row[4],
2399
elif len(path_elements[0]) == 5:
2401
dirblock.append((path_elements[0][0],
2402
path_elements[0][1], path_elements[0][2],
2403
path_elements[0][3], None, None))
2404
elif len(path_elements[0]) == 6:
2405
# versioned, absent file.
2406
dirblock.append((path_elements[0][0],
2407
path_elements[0][1], 'unknown', None,
2408
path_elements[0][4], path_elements[0][5]))
2410
raise NotImplementedError('unreachable code')
2411
yield current_inv[0], dirblock
2413
current_inv = inventory_iterator.next()
2414
except StopIteration:
2417
current_disk = disk_iterator.next()
2418
except StopIteration:
2419
disk_finished = True
2421
def _walkdirs(self, prefix=""):
2422
"""Walk the directories of this tree.
2424
:prefix: is used as the directrory to start with.
2425
returns a generator which yields items in the form:
2426
((curren_directory_path, fileid),
2427
[(file1_path, file1_name, file1_kind, None, file1_id,
2430
_directory = 'directory'
2431
# get the root in the inventory
2432
inv = self.inventory
2433
top_id = inv.path2id(prefix)
2437
pending = [(prefix, '', _directory, None, top_id, None)]
2440
currentdir = pending.pop()
2441
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2442
top_id = currentdir[4]
2444
relroot = currentdir[0] + '/'
2447
# FIXME: stash the node in pending
2449
if entry.kind == 'directory':
2450
for name, child in entry.sorted_children():
2451
dirblock.append((relroot + name, name, child.kind, None,
2452
child.file_id, child.kind
2454
yield (currentdir[0], entry.file_id), dirblock
2455
# push the user specified dirs from dirblock
2456
for dir in reversed(dirblock):
2457
if dir[2] == _directory:
2460
@needs_tree_write_lock
2461
def auto_resolve(self):
2462
"""Automatically resolve text conflicts according to contents.
2464
Only text conflicts are auto_resolvable. Files with no conflict markers
2465
are considered 'resolved', because bzr always puts conflict markers
2466
into files that have text conflicts. The corresponding .THIS .BASE and
2467
.OTHER files are deleted, as per 'resolve'.
2468
:return: a tuple of ConflictLists: (un_resolved, resolved).
2470
un_resolved = _mod_conflicts.ConflictList()
2471
resolved = _mod_conflicts.ConflictList()
2472
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2473
for conflict in self.conflicts():
2474
if (conflict.typestring != 'text conflict' or
2475
self.kind(conflict.file_id) != 'file'):
2476
un_resolved.append(conflict)
2478
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2480
for line in my_file:
2481
if conflict_re.search(line):
2482
un_resolved.append(conflict)
2485
resolved.append(conflict)
2488
resolved.remove_files(self)
2489
self.set_conflicts(un_resolved)
2490
return un_resolved, resolved
2494
tree_basis = self.basis_tree()
2495
tree_basis.lock_read()
2497
repo_basis = self.branch.repository.revision_tree(
2498
self.last_revision())
2499
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2500
raise errors.BzrCheckError(
2501
"Mismatched basis inventory content.")
2506
def _validate(self):
2507
"""Validate internal structures.
2509
This is meant mostly for the test suite. To give it a chance to detect
2510
corruption after actions have occurred. The default implementation is a
2513
:return: None. An exception should be raised if there is an error.
2518
def _get_rules_searcher(self, default_searcher):
2519
"""See Tree._get_rules_searcher."""
2520
if self._rules_searcher is None:
2521
self._rules_searcher = super(WorkingTree,
2522
self)._get_rules_searcher(default_searcher)
2523
return self._rules_searcher
2525
def get_shelf_manager(self):
2526
"""Return the ShelfManager for this WorkingTree."""
2527
from bzrlib.shelf import ShelfManager
2528
return ShelfManager(self, self._transport)
2531
class WorkingTree2(WorkingTree):
2532
"""This is the Format 2 working tree.
2534
This was the first weave based working tree.
2535
- uses os locks for locking.
2536
- uses the branch last-revision.
2539
def __init__(self, *args, **kwargs):
2540
super(WorkingTree2, self).__init__(*args, **kwargs)
2541
# WorkingTree2 has more of a constraint that self._inventory must
2542
# exist. Because this is an older format, we don't mind the overhead
2543
# caused by the extra computation here.
2545
# Newer WorkingTree's should only have self._inventory set when they
2547
if self._inventory is None:
2548
self.read_working_inventory()
2550
def lock_tree_write(self):
2551
"""See WorkingTree.lock_tree_write().
2553
In Format2 WorkingTrees we have a single lock for the branch and tree
2554
so lock_tree_write() degrades to lock_write().
2556
self.branch.lock_write()
2558
return self._control_files.lock_write()
2560
self.branch.unlock()
2564
# do non-implementation specific cleanup
2567
# we share control files:
2568
if self._control_files._lock_count == 3:
2569
# _inventory_is_modified is always False during a read lock.
2570
if self._inventory_is_modified:
2572
self._write_hashcache_if_dirty()
2574
# reverse order of locking.
2576
return self._control_files.unlock()
2578
self.branch.unlock()
2581
class WorkingTree3(WorkingTree):
2582
"""This is the Format 3 working tree.
2584
This differs from the base WorkingTree by:
2585
- having its own file lock
2586
- having its own last-revision property.
2588
This is new in bzr 0.8
2592
def _last_revision(self):
2593
"""See Mutable.last_revision."""
2595
return self._transport.get_bytes('last-revision')
2596
except errors.NoSuchFile:
2597
return _mod_revision.NULL_REVISION
2599
def _change_last_revision(self, revision_id):
2600
"""See WorkingTree._change_last_revision."""
2601
if revision_id is None or revision_id == NULL_REVISION:
2603
self._transport.delete('last-revision')
2604
except errors.NoSuchFile:
2608
self._transport.put_bytes('last-revision', revision_id,
2609
mode=self._control_files._file_mode)
2612
@needs_tree_write_lock
2613
def set_conflicts(self, conflicts):
2614
self._put_rio('conflicts', conflicts.to_stanzas(),
2617
@needs_tree_write_lock
2618
def add_conflicts(self, new_conflicts):
2619
conflict_set = set(self.conflicts())
2620
conflict_set.update(set(list(new_conflicts)))
2621
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2622
key=_mod_conflicts.Conflict.sort_key)))
2625
def conflicts(self):
2627
confile = self._transport.get('conflicts')
2628
except errors.NoSuchFile:
2629
return _mod_conflicts.ConflictList()
2632
if confile.next() != CONFLICT_HEADER_1 + '\n':
2633
raise errors.ConflictFormatError()
2634
except StopIteration:
2635
raise errors.ConflictFormatError()
2636
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2641
# do non-implementation specific cleanup
2643
if self._control_files._lock_count == 1:
2644
# _inventory_is_modified is always False during a read lock.
2645
if self._inventory_is_modified:
2647
self._write_hashcache_if_dirty()
2648
# reverse order of locking.
2650
return self._control_files.unlock()
2652
self.branch.unlock()
2655
def get_conflicted_stem(path):
2656
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2657
if path.endswith(suffix):
2658
return path[:-len(suffix)]
2661
class WorkingTreeFormat(object):
2662
"""An encapsulation of the initialization and open routines for a format.
2664
Formats provide three things:
2665
* An initialization routine,
2669
Formats are placed in an dict by their format string for reference
2670
during workingtree opening. Its not required that these be instances, they
2671
can be classes themselves with class methods - it simply depends on
2672
whether state is needed for a given format or not.
2674
Once a format is deprecated, just deprecate the initialize and open
2675
methods on the format class. Do not deprecate the object, as the
2676
object will be created every time regardless.
2679
_default_format = None
2680
"""The default format used for new trees."""
2683
"""The known formats."""
2685
requires_rich_root = False
2687
upgrade_recommended = False
2690
def find_format(klass, a_bzrdir):
2691
"""Return the format for the working tree object in a_bzrdir."""
2693
transport = a_bzrdir.get_workingtree_transport(None)
2694
format_string = transport.get("format").read()
2695
return klass._formats[format_string]
2696
except errors.NoSuchFile:
2697
raise errors.NoWorkingTree(base=transport.base)
2699
raise errors.UnknownFormatError(format=format_string,
2700
kind="working tree")
2702
def __eq__(self, other):
2703
return self.__class__ is other.__class__
2705
def __ne__(self, other):
2706
return not (self == other)
2709
def get_default_format(klass):
2710
"""Return the current default format."""
2711
return klass._default_format
2713
def get_format_string(self):
2714
"""Return the ASCII format string that identifies this format."""
2715
raise NotImplementedError(self.get_format_string)
2717
def get_format_description(self):
2718
"""Return the short description for this format."""
2719
raise NotImplementedError(self.get_format_description)
2721
def is_supported(self):
2722
"""Is this format supported?
2724
Supported formats can be initialized and opened.
2725
Unsupported formats may not support initialization or committing or
2726
some other features depending on the reason for not being supported.
2731
def register_format(klass, format):
2732
klass._formats[format.get_format_string()] = format
2735
def set_default_format(klass, format):
2736
klass._default_format = format
2739
def unregister_format(klass, format):
2740
del klass._formats[format.get_format_string()]
2743
class WorkingTreeFormat2(WorkingTreeFormat):
2744
"""The second working tree format.
2746
This format modified the hash cache from the format 1 hash cache.
2749
upgrade_recommended = True
2751
def get_format_description(self):
2752
"""See WorkingTreeFormat.get_format_description()."""
2753
return "Working tree format 2"
2755
def _stub_initialize_on_transport(self, transport, file_mode):
2756
"""Workaround: create control files for a remote working tree.
2758
This ensures that it can later be updated and dealt with locally,
2759
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2760
no working tree. (See bug #43064).
2764
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2766
transport.put_file('inventory', sio, file_mode)
2767
transport.put_bytes('pending-merges', '', file_mode)
2769
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2770
accelerator_tree=None, hardlink=False):
2771
"""See WorkingTreeFormat.initialize()."""
2772
if not isinstance(a_bzrdir.transport, LocalTransport):
2773
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2774
if from_branch is not None:
2775
branch = from_branch
2777
branch = a_bzrdir.open_branch()
2778
if revision_id is None:
2779
revision_id = _mod_revision.ensure_null(branch.last_revision())
2782
branch.generate_revision_history(revision_id)
2786
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2792
basis_tree = branch.repository.revision_tree(revision_id)
2793
if basis_tree.inventory.root is not None:
2794
wt.set_root_id(basis_tree.get_root_id())
2795
# set the parent list and cache the basis tree.
2796
if _mod_revision.is_null(revision_id):
2799
parent_trees = [(revision_id, basis_tree)]
2800
wt.set_parent_trees(parent_trees)
2801
transform.build_tree(basis_tree, wt)
2805
super(WorkingTreeFormat2, self).__init__()
2806
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2808
def open(self, a_bzrdir, _found=False):
2809
"""Return the WorkingTree object for a_bzrdir
2811
_found is a private parameter, do not use it. It is used to indicate
2812
if format probing has already been done.
2815
# we are being called directly and must probe.
2816
raise NotImplementedError
2817
if not isinstance(a_bzrdir.transport, LocalTransport):
2818
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2819
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2825
class WorkingTreeFormat3(WorkingTreeFormat):
2826
"""The second working tree format updated to record a format marker.
2829
- exists within a metadir controlling .bzr
2830
- includes an explicit version marker for the workingtree control
2831
files, separate from the BzrDir format
2832
- modifies the hash cache format
2834
- uses a LockDir to guard access for writes.
2837
upgrade_recommended = True
2839
def get_format_string(self):
2840
"""See WorkingTreeFormat.get_format_string()."""
2841
return "Bazaar-NG Working Tree format 3"
2843
def get_format_description(self):
2844
"""See WorkingTreeFormat.get_format_description()."""
2845
return "Working tree format 3"
2847
_lock_file_name = 'lock'
2848
_lock_class = LockDir
2850
_tree_class = WorkingTree3
2852
def __get_matchingbzrdir(self):
2853
return bzrdir.BzrDirMetaFormat1()
2855
_matchingbzrdir = property(__get_matchingbzrdir)
2857
def _open_control_files(self, a_bzrdir):
2858
transport = a_bzrdir.get_workingtree_transport(None)
2859
return LockableFiles(transport, self._lock_file_name,
2862
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2863
accelerator_tree=None, hardlink=False):
2864
"""See WorkingTreeFormat.initialize().
2866
:param revision_id: if supplied, create a working tree at a different
2867
revision than the branch is at.
2868
:param accelerator_tree: A tree which can be used for retrieving file
2869
contents more quickly than the revision tree, i.e. a workingtree.
2870
The revision tree will be used for cases where accelerator_tree's
2871
content is different.
2872
:param hardlink: If true, hard-link files from accelerator_tree,
2875
if not isinstance(a_bzrdir.transport, LocalTransport):
2876
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2877
transport = a_bzrdir.get_workingtree_transport(self)
2878
control_files = self._open_control_files(a_bzrdir)
2879
control_files.create_lock()
2880
control_files.lock_write()
2881
transport.put_bytes('format', self.get_format_string(),
2882
mode=control_files._file_mode)
2883
if from_branch is not None:
2884
branch = from_branch
2886
branch = a_bzrdir.open_branch()
2887
if revision_id is None:
2888
revision_id = _mod_revision.ensure_null(branch.last_revision())
2889
# WorkingTree3 can handle an inventory which has a unique root id.
2890
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2891
# those trees. And because there isn't a format bump inbetween, we
2892
# are maintaining compatibility with older clients.
2893
# inv = Inventory(root_id=gen_root_id())
2894
inv = self._initial_inventory()
2895
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2901
_control_files=control_files)
2902
wt.lock_tree_write()
2904
basis_tree = branch.repository.revision_tree(revision_id)
2905
# only set an explicit root id if there is one to set.
2906
if basis_tree.inventory.root is not None:
2907
wt.set_root_id(basis_tree.get_root_id())
2908
if revision_id == NULL_REVISION:
2909
wt.set_parent_trees([])
2911
wt.set_parent_trees([(revision_id, basis_tree)])
2912
transform.build_tree(basis_tree, wt)
2914
# Unlock in this order so that the unlock-triggers-flush in
2915
# WorkingTree is given a chance to fire.
2916
control_files.unlock()
2920
def _initial_inventory(self):
2924
super(WorkingTreeFormat3, self).__init__()
2926
def open(self, a_bzrdir, _found=False):
2927
"""Return the WorkingTree object for a_bzrdir
2929
_found is a private parameter, do not use it. It is used to indicate
2930
if format probing has already been done.
2933
# we are being called directly and must probe.
2934
raise NotImplementedError
2935
if not isinstance(a_bzrdir.transport, LocalTransport):
2936
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2937
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2940
def _open(self, a_bzrdir, control_files):
2941
"""Open the tree itself.
2943
:param a_bzrdir: the dir for the tree.
2944
:param control_files: the control files for the tree.
2946
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2950
_control_files=control_files)
2953
return self.get_format_string()
2956
__default_format = WorkingTreeFormat4()
2957
WorkingTreeFormat.register_format(__default_format)
2958
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2959
WorkingTreeFormat.set_default_format(__default_format)
2960
# formats which have no format string are not discoverable
2961
# and not independently creatable, so are not registered.
2962
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
