1
# Copyright (C) 2005, 2006 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
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
45
from copy import deepcopy
54
conflicts as _mod_conflicts,
69
from bzrlib.transport import get_transport
73
from bzrlib import symbol_versioning
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
75
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
76
from bzrlib.lockable_files import LockableFiles, TransportLock
77
from bzrlib.lockdir import LockDir
78
import bzrlib.mutabletree
79
from bzrlib.mutabletree import needs_tree_write_lock
80
from bzrlib.osutils import (
92
from bzrlib.trace import mutter, note
93
from bzrlib.transport.local import LocalTransport
95
from bzrlib.progress import DummyProgress, ProgressPhase
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
97
import bzrlib.revisiontree
98
from bzrlib.rio import RioReader, rio_file, Stanza
99
from bzrlib.symbol_versioning import (deprecated_passed,
102
DEPRECATED_PARAMETER,
109
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
@deprecated_function(zero_thirteen)
114
def gen_file_id(name):
115
"""Return new file id for the basename 'name'.
117
Use bzrlib.generate_ids.gen_file_id() instead
119
return generate_ids.gen_file_id(name)
122
@deprecated_function(zero_thirteen)
124
"""Return a new tree-root file id.
126
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
128
return generate_ids.gen_root_id()
131
class TreeEntry(object):
132
"""An entry that implements the minimum interface used by commands.
134
This needs further inspection, it may be better to have
135
InventoryEntries without ids - though that seems wrong. For now,
136
this is a parallel hierarchy to InventoryEntry, and needs to become
137
one of several things: decorates to that hierarchy, children of, or
139
Another note is that these objects are currently only used when there is
140
no InventoryEntry available - i.e. for unversioned objects.
141
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
144
def __eq__(self, other):
145
# yes, this us ugly, TODO: best practice __eq__ style.
146
return (isinstance(other, TreeEntry)
147
and other.__class__ == self.__class__)
149
def kind_character(self):
153
class TreeDirectory(TreeEntry):
154
"""See TreeEntry. This is a directory in a working tree."""
156
def __eq__(self, other):
157
return (isinstance(other, TreeDirectory)
158
and other.__class__ == self.__class__)
160
def kind_character(self):
164
class TreeFile(TreeEntry):
165
"""See TreeEntry. This is a regular file in a working tree."""
167
def __eq__(self, other):
168
return (isinstance(other, TreeFile)
169
and other.__class__ == self.__class__)
171
def kind_character(self):
175
class TreeLink(TreeEntry):
176
"""See TreeEntry. This is a symlink in a working tree."""
178
def __eq__(self, other):
179
return (isinstance(other, TreeLink)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class WorkingTree(bzrlib.mutabletree.MutableTree):
187
"""Working copy tree.
189
The inventory is held in the `Branch` working-inventory, and the
190
files are in a directory on disk.
192
It is possible for a `WorkingTree` to have a filename which is
193
not listed in the Inventory and vice versa.
196
def __init__(self, basedir='.',
197
branch=DEPRECATED_PARAMETER,
203
"""Construct a WorkingTree for basedir.
205
If the branch is not supplied, it is opened automatically.
206
If the branch is supplied, it must be the branch for this basedir.
207
(branch.base is not cross checked, because for remote branches that
208
would be meaningless).
210
self._format = _format
211
self.bzrdir = _bzrdir
213
# not created via open etc.
214
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
215
"Please use bzrdir.open_workingtree or WorkingTree.open().",
218
wt = WorkingTree.open(basedir)
219
self._branch = wt.branch
220
self.basedir = wt.basedir
221
self._control_files = wt._control_files
222
self._hashcache = wt._hashcache
223
self._set_inventory(wt._inventory, dirty=False)
224
self._format = wt._format
225
self.bzrdir = wt.bzrdir
226
assert isinstance(basedir, basestring), \
227
"base directory %r is not a string" % basedir
228
basedir = safe_unicode(basedir)
229
mutter("opening working tree %r", basedir)
230
if deprecated_passed(branch):
232
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
233
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
234
" WorkingTree.open().",
238
self._branch = branch
240
self._branch = self.bzrdir.open_branch()
241
self.basedir = realpath(basedir)
242
# if branch is at our basedir and is a format 6 or less
243
if isinstance(self._format, WorkingTreeFormat2):
244
# share control object
245
self._control_files = self.branch.control_files
247
# assume all other formats have their own control files.
248
assert isinstance(_control_files, LockableFiles), \
249
"_control_files must be a LockableFiles, not %r" \
251
self._control_files = _control_files
252
# update the whole cache up front and write to disk if anything changed;
253
# in the future we might want to do this more selectively
254
# two possible ways offer themselves : in self._unlock, write the cache
255
# if needed, or, when the cache sees a change, append it to the hash
256
# cache file, and have the parser take the most recent entry for a
258
wt_trans = self.bzrdir.get_workingtree_transport(None)
259
cache_filename = wt_trans.local_abspath('stat-cache')
260
self._hashcache = hashcache.HashCache(basedir, cache_filename,
261
self._control_files._file_mode)
264
# is this scan needed ? it makes things kinda slow.
271
if _inventory is None:
272
self._inventory_is_modified = False
273
self.read_working_inventory()
275
# the caller of __init__ has provided an inventory,
276
# we assume they know what they are doing - as its only
277
# the Format factory and creation methods that are
278
# permitted to do this.
279
self._set_inventory(_inventory, dirty=False)
282
fget=lambda self: self._branch,
283
doc="""The branch this WorkingTree is connected to.
285
This cannot be set - it is reflective of the actual disk structure
286
the working tree has been constructed from.
289
def break_lock(self):
290
"""Break a lock if one is present from another instance.
292
Uses the ui factory to ask for confirmation if the lock may be from
295
This will probe the repository for its lock as well.
297
self._control_files.break_lock()
298
self.branch.break_lock()
300
def _set_inventory(self, inv, dirty):
301
"""Set the internal cached inventory.
303
:param inv: The inventory to set.
304
:param dirty: A boolean indicating whether the inventory is the same
305
logical inventory as whats on disk. If True the inventory is not
306
the same and should be written to disk or data will be lost, if
307
False then the inventory is the same as that on disk and any
308
serialisation would be unneeded overhead.
310
assert inv.root is not None
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = os.path.getcwdu()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
352
"""Iterate through file_ids for this tree.
354
file_ids are in a WorkingTree if they are in the working inventory
355
and the working file exists.
357
inv = self._inventory
358
for path, ie in inv.iter_entries():
359
if osutils.lexists(self.abspath(path)):
363
return "<%s of %s>" % (self.__class__.__name__,
364
getattr(self, 'basedir', None))
366
def abspath(self, filename):
367
return pathjoin(self.basedir, filename)
369
def basis_tree(self):
370
"""Return RevisionTree for the current last revision.
372
If the left most parent is a ghost then the returned tree will be an
373
empty tree - one obtained by calling repository.revision_tree(None).
376
revision_id = self.get_parent_ids()[0]
378
# no parents, return an empty revision tree.
379
# in the future this should return the tree for
380
# 'empty:' - the implicit root empty tree.
381
return self.branch.repository.revision_tree(None)
384
xml = self.read_basis_inventory()
385
inv = xml6.serializer_v6.read_inventory_from_string(xml)
386
if inv is not None and inv.revision_id == revision_id:
387
return bzrlib.revisiontree.RevisionTree(
388
self.branch.repository, inv, revision_id)
389
except (errors.NoSuchFile, errors.BadInventoryFormat):
391
# No cached copy available, retrieve from the repository.
392
# FIXME? RBC 20060403 should we cache the inventory locally
395
return self.branch.repository.revision_tree(revision_id)
396
except errors.RevisionNotPresent:
397
# the basis tree *may* be a ghost or a low level error may have
398
# occured. If the revision is present, its a problem, if its not
400
if self.branch.repository.has_revision(revision_id):
402
# the basis tree is a ghost so return an empty tree.
403
return self.branch.repository.revision_tree(None)
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id):
455
return self.get_file_byname(self.id2path(file_id))
457
def get_file_text(self, file_id):
458
return self.get_file(file_id).read()
460
def get_file_byname(self, filename):
461
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id):
464
"""See Tree.annotate_iter
466
This implementation will use the basis tree implementation if possible.
467
Lines not in the basis are attributed to CURRENT_REVISION
469
If there are pending merges, lines added by those merges will be
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
471
attribution will be correct).
473
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [file_id]).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get_utf8('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
parents.append(l.rstrip('\n'))
515
def get_root_id(self):
516
"""Return the id of this trees root"""
517
return self._inventory.root.file_id
519
def _get_store_filename(self, file_id):
520
## XXX: badly named; this is not in the store at all
521
return self.abspath(self.id2path(file_id))
524
def clone(self, to_bzrdir, revision_id=None, basis=None):
525
"""Duplicate this working tree into to_bzr, including all state.
527
Specifically modified files are kept as modified, but
528
ignored and unknown files are discarded.
530
If you want to make a new line of development, see bzrdir.sprout()
533
If not None, the cloned tree will have its last revision set to
534
revision, and and difference between the source trees last revision
535
and this one merged in.
538
If not None, a closer copy of a tree which may have some files in
539
common, and which file content should be preferentially copied from.
541
# assumes the target bzr dir format is compatible.
542
result = self._format.initialize(to_bzrdir)
543
self.copy_content_into(result, revision_id)
547
def copy_content_into(self, tree, revision_id=None):
548
"""Copy the current content and user files of this tree into tree."""
549
tree.set_root_id(self.get_root_id())
550
if revision_id is None:
551
merge.transform_tree(tree, self)
553
# TODO now merge from tree.last_revision to revision (to preserve
554
# user local changes)
555
merge.transform_tree(tree, self)
556
tree.set_parent_ids([revision_id])
558
def id2abspath(self, file_id):
559
return self.abspath(self.id2path(file_id))
561
def has_id(self, file_id):
562
# files that have been deleted are excluded
563
inv = self._inventory
564
if not inv.has_id(file_id):
566
path = inv.id2path(file_id)
567
return osutils.lexists(self.abspath(path))
569
def has_or_had_id(self, file_id):
570
if file_id == self.inventory.root.file_id:
572
return self.inventory.has_id(file_id)
574
__contains__ = has_id
576
def get_file_size(self, file_id):
577
return os.path.getsize(self.id2abspath(file_id))
580
def get_file_sha1(self, file_id, path=None, stat_value=None):
582
path = self._inventory.id2path(file_id)
583
return self._hashcache.get_sha1(path, stat_value)
585
def get_file_mtime(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
return os.lstat(self.abspath(path)).st_mtime
590
if not supports_executable():
591
def is_executable(self, file_id, path=None):
592
return self._inventory[file_id].executable
594
def is_executable(self, file_id, path=None):
596
path = self._inventory.id2path(file_id)
597
mode = os.lstat(self.abspath(path)).st_mode
598
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
601
def _add(self, files, ids, kinds):
602
"""See MutableTree._add."""
603
# TODO: Re-adding a file that is removed in the working copy
604
# should probably put it back with the previous ID.
605
# the read and write working inventory should not occur in this
606
# function - they should be part of lock_write and unlock.
607
inv = self.read_working_inventory()
608
for f, file_id, kind in zip(files, ids, kinds):
609
assert kind is not None
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
614
self._write_inventory(inv)
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
667
def add_pending_merge(self, *revision_ids):
668
# TODO: Perhaps should check at this point that the
669
# history of the revision is actually present?
670
parents = self.get_parent_ids()
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
@deprecated_method(zero_eleven)
682
def pending_merges(self):
683
"""Return a list of pending merges.
685
These are revisions that have been merged into the working
686
directory but not yet committed.
688
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
689
instead - which is available on all tree objects.
691
return self.get_parent_ids()[1:]
693
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
694
"""Common ghost checking functionality from set_parent_*.
696
This checks that the left hand-parent exists if there are any
699
if len(revision_ids) > 0:
700
leftmost_id = revision_ids[0]
701
if (not allow_leftmost_as_ghost and not
702
self.branch.repository.has_revision(leftmost_id)):
703
raise errors.GhostRevisionUnusableHere(leftmost_id)
705
def _set_merges_from_parent_ids(self, parent_ids):
706
merges = parent_ids[1:]
707
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
709
@needs_tree_write_lock
710
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
711
"""Set the parent ids to revision_ids.
713
See also set_parent_trees. This api will try to retrieve the tree data
714
for each element of revision_ids from the trees repository. If you have
715
tree data already available, it is more efficient to use
716
set_parent_trees rather than set_parent_ids. set_parent_ids is however
717
an easier API to use.
719
:param revision_ids: The revision_ids to set as the parent ids of this
720
working tree. Any of these may be ghosts.
722
self._check_parents_for_ghosts(revision_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(revision_ids) > 0:
726
self.set_last_revision(revision_ids[0])
728
self.set_last_revision(None)
730
self._set_merges_from_parent_ids(revision_ids)
732
@needs_tree_write_lock
733
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
734
"""See MutableTree.set_parent_trees."""
735
parent_ids = [rev for (rev, tree) in parents_list]
737
self._check_parents_for_ghosts(parent_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(parent_ids) == 0:
741
leftmost_parent_id = None
742
leftmost_parent_tree = None
744
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
746
if self._change_last_revision(leftmost_parent_id):
747
if leftmost_parent_tree is None:
748
# If we don't have a tree, fall back to reading the
749
# parent tree from the repository.
750
self._cache_basis_inventory(leftmost_parent_id)
752
inv = leftmost_parent_tree.inventory
753
xml = self._create_basis_xml_from_inventory(
754
leftmost_parent_id, inv)
755
self._write_basis_inventory(xml)
756
self._set_merges_from_parent_ids(parent_ids)
758
@needs_tree_write_lock
759
def set_pending_merges(self, rev_list):
760
parents = self.get_parent_ids()
761
leftmost = parents[:1]
762
new_parents = leftmost + rev_list
763
self.set_parent_ids(new_parents)
765
@needs_tree_write_lock
766
def set_merge_modified(self, modified_hashes):
768
for file_id, hash in modified_hashes.iteritems():
769
yield Stanza(file_id=file_id, hash=hash)
770
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
772
@needs_tree_write_lock
773
def _put_rio(self, filename, stanzas, header):
774
my_file = rio_file(stanzas, header)
775
self._control_files.put(filename, my_file)
777
@needs_write_lock # because merge pulls data into the branch.
778
def merge_from_branch(self, branch, to_revision=None):
779
"""Merge from a branch into this working tree.
781
:param branch: The branch to merge from.
782
:param to_revision: If non-None, the merge will merge to to_revision,
783
but not beyond it. to_revision does not need to be in the history
784
of the branch when it is supplied. If None, to_revision defaults to
785
branch.last_revision().
787
from bzrlib.merge import Merger, Merge3Merger
788
pb = bzrlib.ui.ui_factory.nested_progress_bar()
790
merger = Merger(self.branch, this_tree=self, pb=pb)
791
merger.pp = ProgressPhase("Merge phase", 5, pb)
792
merger.pp.next_phase()
793
# check that there are no
795
merger.check_basis(check_clean=True, require_commits=False)
796
if to_revision is None:
797
to_revision = branch.last_revision()
798
merger.other_rev_id = to_revision
799
if merger.other_rev_id is None:
800
raise error.NoCommits(branch)
801
self.branch.fetch(branch, last_revision=merger.other_rev_id)
802
merger.other_basis = merger.other_rev_id
803
merger.other_tree = self.branch.repository.revision_tree(
805
merger.pp.next_phase()
807
if merger.base_rev_id == merger.other_rev_id:
808
raise errors.PointlessMerge
809
merger.backup_files = False
810
merger.merge_type = Merge3Merger
811
merger.set_interesting_files(None)
812
merger.show_base = False
813
merger.reprocess = False
814
conflicts = merger.do_merge()
821
def merge_modified(self):
823
hashfile = self._control_files.get('merge-hashes')
824
except errors.NoSuchFile:
828
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
829
raise errors.MergeModifiedFormatError()
830
except StopIteration:
831
raise errors.MergeModifiedFormatError()
832
for s in RioReader(hashfile):
833
file_id = s.get("file_id")
834
if file_id not in self.inventory:
837
if hash == self.get_file_sha1(file_id):
838
merge_hashes[file_id] = hash
842
def mkdir(self, path, file_id=None):
843
"""See MutableTree.mkdir()."""
845
file_id = generate_ids.gen_file_id(os.path.basename(path))
846
os.mkdir(self.abspath(path))
847
self.add(path, file_id, 'directory')
850
def get_symlink_target(self, file_id):
851
return os.readlink(self.id2abspath(file_id))
853
def file_class(self, filename):
854
if self.path2id(filename):
856
elif self.is_ignored(filename):
862
"""Write the in memory inventory to disk."""
863
# TODO: Maybe this should only write on dirty ?
864
if self._control_files._lock_mode != 'w':
865
raise errors.NotWriteLocked(self)
867
xml5.serializer_v5.write_inventory(self._inventory, sio)
869
self._control_files.put('inventory', sio)
870
self._inventory_is_modified = False
872
def list_files(self, include_root=False):
873
"""Recursively list all files as (path, class, kind, id, entry).
875
Lists, but does not descend into unversioned directories.
877
This does not include files that have been deleted in this
880
Skips the control directory.
882
inv = self._inventory
883
if include_root is True:
884
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
885
# Convert these into local objects to save lookup times
886
pathjoin = osutils.pathjoin
887
file_kind = osutils.file_kind
889
# transport.base ends in a slash, we want the piece
890
# between the last two slashes
891
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
893
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
895
# directory file_id, relative path, absolute path, reverse sorted children
896
children = os.listdir(self.basedir)
898
# jam 20060527 The kernel sized tree seems equivalent whether we
899
# use a deque and popleft to keep them sorted, or if we use a plain
900
# list and just reverse() them.
901
children = collections.deque(children)
902
stack = [(inv.root.file_id, u'', self.basedir, children)]
904
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
907
f = children.popleft()
908
## TODO: If we find a subdirectory with its own .bzr
909
## directory, then that is a separate tree and we
910
## should exclude it.
912
# the bzrdir for this tree
913
if transport_base_dir == f:
916
# we know that from_dir_relpath and from_dir_abspath never end in a slash
917
# and 'f' doesn't begin with one, we can do a string op, rather
918
# than the checks of pathjoin(), all relative paths will have an extra slash
920
fp = from_dir_relpath + '/' + f
923
fap = from_dir_abspath + '/' + f
925
f_ie = inv.get_child(from_dir_id, f)
928
elif self.is_ignored(fp[1:]):
931
# we may not have found this file, because of a unicode issue
932
f_norm, can_access = osutils.normalized_filename(f)
933
if f == f_norm or not can_access:
934
# No change, so treat this file normally
937
# this file can be accessed by a normalized path
938
# check again if it is versioned
939
# these lines are repeated here for performance
941
fp = from_dir_relpath + '/' + f
942
fap = from_dir_abspath + '/' + f
943
f_ie = inv.get_child(from_dir_id, f)
946
elif self.is_ignored(fp[1:]):
955
raise errors.BzrCheckError(
956
"file %r entered as kind %r id %r, now of kind %r"
957
% (fap, f_ie.kind, f_ie.file_id, fk))
959
# make a last minute entry
961
yield fp[1:], c, fk, f_ie.file_id, f_ie
964
yield fp[1:], c, fk, None, fk_entries[fk]()
966
yield fp[1:], c, fk, None, TreeEntry()
969
if fk != 'directory':
972
# But do this child first
973
new_children = os.listdir(fap)
975
new_children = collections.deque(new_children)
976
stack.append((f_ie.file_id, fp, fap, new_children))
977
# Break out of inner loop,
978
# so that we start outer loop with child
981
# if we finished all children, pop it off the stack
984
@needs_tree_write_lock
985
def move(self, from_paths, to_dir=None, after=False, **kwargs):
988
to_dir must exist in the inventory.
990
If to_dir exists and is a directory, the files are moved into
991
it, keeping their old names.
993
Note that to_dir is only the last component of the new name;
994
this doesn't change the directory.
996
For each entry in from_paths the move mode will be determined
999
The first mode moves the file in the filesystem and updates the
1000
inventory. The second mode only updates the inventory without
1001
touching the file on the filesystem. This is the new mode introduced
1004
move uses the second mode if 'after == True' and the target is not
1005
versioned but present in the working tree.
1007
move uses the second mode if 'after == False' and the source is
1008
versioned but no longer in the working tree, and the target is not
1009
versioned but present in the working tree.
1011
move uses the first mode if 'after == False' and the source is
1012
versioned and present in the working tree, and the target is not
1013
versioned and not present in the working tree.
1015
Everything else results in an error.
1017
This returns a list of (from_path, to_path) pairs for each
1018
entry that is moved.
1023
# check for deprecated use of signature
1025
to_dir = kwargs.get('to_name', None)
1027
raise TypeError('You must supply a target directory')
1029
symbol_versioning.warn('The parameter to_name was deprecated'
1030
' in version 0.13. Use to_dir instead',
1033
# check destination directory
1034
assert not isinstance(from_paths, basestring)
1035
inv = self.inventory
1036
to_abs = self.abspath(to_dir)
1037
if not isdir(to_abs):
1038
raise errors.BzrMoveFailedError('',to_dir,
1039
errors.NotADirectory(to_abs))
1040
if not self.has_filename(to_dir):
1041
raise errors.BzrMoveFailedError('',to_dir,
1042
errors.NotInWorkingDirectory(to_dir))
1043
to_dir_id = inv.path2id(to_dir)
1044
if to_dir_id is None:
1045
raise errors.BzrMoveFailedError('',to_dir,
1046
errors.NotVersionedError(path=str(to_dir)))
1048
to_dir_ie = inv[to_dir_id]
1049
if to_dir_ie.kind != 'directory':
1050
raise errors.BzrMoveFailedError('',to_dir,
1051
errors.NotADirectory(to_abs))
1053
# create rename entries and tuples
1054
for from_rel in from_paths:
1055
from_tail = splitpath(from_rel)[-1]
1056
from_id = inv.path2id(from_rel)
1058
raise errors.BzrMoveFailedError(from_rel,to_dir,
1059
errors.NotVersionedError(path=str(from_rel)))
1061
from_entry = inv[from_id]
1062
from_parent_id = from_entry.parent_id
1063
to_rel = pathjoin(to_dir, from_tail)
1064
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1066
from_tail=from_tail,
1067
from_parent_id=from_parent_id,
1068
to_rel=to_rel, to_tail=from_tail,
1069
to_parent_id=to_dir_id)
1070
rename_entries.append(rename_entry)
1071
rename_tuples.append((from_rel, to_rel))
1073
# determine which move mode to use. checks also for movability
1074
rename_entries = self._determine_mv_mode(rename_entries, after)
1076
original_modified = self._inventory_is_modified
1079
self._inventory_is_modified = True
1080
self._move(rename_entries)
1082
# restore the inventory on error
1083
self._inventory_is_modified = original_modified
1085
self._write_inventory(inv)
1086
return rename_tuples
1088
def _determine_mv_mode(self, rename_entries, after=False):
1089
"""Determines for each from-to pair if both inventory and working tree
1090
or only the inventory has to be changed.
1092
Also does basic plausability tests.
1094
inv = self.inventory
1096
for rename_entry in rename_entries:
1097
# store to local variables for easier reference
1098
from_rel = rename_entry.from_rel
1099
from_id = rename_entry.from_id
1100
to_rel = rename_entry.to_rel
1101
to_id = inv.path2id(to_rel)
1102
only_change_inv = False
1104
# check the inventory for source and destination
1106
raise errors.BzrMoveFailedError(from_rel,to_rel,
1107
errors.NotVersionedError(path=str(from_rel)))
1108
if to_id is not None:
1109
raise errors.BzrMoveFailedError(from_rel,to_rel,
1110
errors.AlreadyVersionedError(path=str(to_rel)))
1112
# try to determine the mode for rename (only change inv or change
1113
# inv and file system)
1115
if not self.has_filename(to_rel):
1116
raise errors.BzrMoveFailedError(from_id,to_rel,
1117
errors.NoSuchFile(path=str(to_rel),
1118
extra="New file has not been created yet"))
1119
only_change_inv = True
1120
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1121
only_change_inv = True
1122
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1123
only_change_inv = False
1125
# something is wrong, so lets determine what exactly
1126
if not self.has_filename(from_rel) and \
1127
not self.has_filename(to_rel):
1128
raise errors.BzrRenameFailedError(from_rel,to_rel,
1129
errors.PathsDoNotExist(paths=(str(from_rel),
1132
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1133
extra="(Use --after to update the Bazaar id)")
1134
rename_entry.only_change_inv = only_change_inv
1135
return rename_entries
1137
def _move(self, rename_entries):
1138
"""Moves a list of files.
1140
Depending on the value of the flag 'only_change_inv', the
1141
file will be moved on the file system or not.
1143
inv = self.inventory
1146
for entry in rename_entries:
1148
self._move_entry(entry)
1150
self._rollback_move(moved)
1154
def _rollback_move(self, moved):
1155
"""Try to rollback a previous move in case of an filesystem error."""
1156
inv = self.inventory
1159
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1160
entry.to_tail, entry.to_parent_id, entry.from_rel,
1161
entry.from_tail, entry.from_parent_id,
1162
entry.only_change_inv))
1163
except errors.BzrMoveFailedError, e:
1164
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1165
" The working tree is in an inconsistent state."
1166
" Please consider doing a 'bzr revert'."
1167
" Error message is: %s" % e)
1169
def _move_entry(self, entry):
1170
inv = self.inventory
1171
from_rel_abs = self.abspath(entry.from_rel)
1172
to_rel_abs = self.abspath(entry.to_rel)
1173
if from_rel_abs == to_rel_abs:
1174
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1175
"Source and target are identical.")
1177
if not entry.only_change_inv:
1179
osutils.rename(from_rel_abs, to_rel_abs)
1181
raise errors.BzrMoveFailedError(entry.from_rel,
1183
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1185
@needs_tree_write_lock
1186
def rename_one(self, from_rel, to_rel, after=False):
1189
This can change the directory or the filename or both.
1191
rename_one has several 'modes' to work. First, it can rename a physical
1192
file and change the file_id. That is the normal mode. Second, it can
1193
only change the file_id without touching any physical file. This is
1194
the new mode introduced in version 0.15.
1196
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1197
versioned but present in the working tree.
1199
rename_one uses the second mode if 'after == False' and 'from_rel' is
1200
versioned but no longer in the working tree, and 'to_rel' is not
1201
versioned but present in the working tree.
1203
rename_one uses the first mode if 'after == False' and 'from_rel' is
1204
versioned and present in the working tree, and 'to_rel' is not
1205
versioned and not present in the working tree.
1207
Everything else results in an error.
1209
inv = self.inventory
1212
# create rename entries and tuples
1213
from_tail = splitpath(from_rel)[-1]
1214
from_id = inv.path2id(from_rel)
1216
raise errors.BzrRenameFailedError(from_rel,to_rel,
1217
errors.NotVersionedError(path=str(from_rel)))
1218
from_entry = inv[from_id]
1219
from_parent_id = from_entry.parent_id
1220
to_dir, to_tail = os.path.split(to_rel)
1221
to_dir_id = inv.path2id(to_dir)
1222
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1224
from_tail=from_tail,
1225
from_parent_id=from_parent_id,
1226
to_rel=to_rel, to_tail=to_tail,
1227
to_parent_id=to_dir_id)
1228
rename_entries.append(rename_entry)
1230
# determine which move mode to use. checks also for movability
1231
rename_entries = self._determine_mv_mode(rename_entries, after)
1233
# check if the target changed directory and if the target directory is
1235
if to_dir_id is None:
1236
raise errors.BzrMoveFailedError(from_rel,to_rel,
1237
errors.NotVersionedError(path=str(to_dir)))
1239
# all checks done. now we can continue with our actual work
1240
mutter('rename_one:\n'
1245
' to_dir_id {%s}\n',
1246
from_id, from_rel, to_rel, to_dir, to_dir_id)
1248
self._move(rename_entries)
1249
self._write_inventory(inv)
1251
class _RenameEntry(object):
1252
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1253
to_rel, to_tail, to_parent_id, only_change_inv=False):
1254
self.from_rel = from_rel
1255
self.from_id = from_id
1256
self.from_tail = from_tail
1257
self.from_parent_id = from_parent_id
1258
self.to_rel = to_rel
1259
self.to_tail = to_tail
1260
self.to_parent_id = to_parent_id
1261
self.only_change_inv = only_change_inv
1265
"""Return all unknown files.
1267
These are files in the working directory that are not versioned or
1268
control files or ignored.
1270
for subp in self.extras():
1271
if not self.is_ignored(subp):
1274
@needs_tree_write_lock
1275
def unversion(self, file_ids):
1276
"""Remove the file ids in file_ids from the current versioned set.
1278
When a file_id is unversioned, all of its children are automatically
1281
:param file_ids: The file ids to stop versioning.
1282
:raises: NoSuchId if any fileid is not currently versioned.
1284
for file_id in file_ids:
1285
if self._inventory.has_id(file_id):
1286
self._inventory.remove_recursive_id(file_id)
1288
raise errors.NoSuchId(self, file_id)
1290
# in the future this should just set a dirty bit to wait for the
1291
# final unlock. However, until all methods of workingtree start
1292
# with the current in -memory inventory rather than triggering
1293
# a read, it is more complex - we need to teach read_inventory
1294
# to know when to read, and when to not read first... and possibly
1295
# to save first when the in memory one may be corrupted.
1296
# so for now, we just only write it if it is indeed dirty.
1298
self._write_inventory(self._inventory)
1300
@deprecated_method(zero_eight)
1301
def iter_conflicts(self):
1302
"""List all files in the tree that have text or content conflicts.
1303
DEPRECATED. Use conflicts instead."""
1304
return self._iter_conflicts()
1306
def _iter_conflicts(self):
1308
for info in self.list_files():
1310
stem = get_conflicted_stem(path)
1313
if stem not in conflicted:
1314
conflicted.add(stem)
1318
def pull(self, source, overwrite=False, stop_revision=None,
1319
change_reporter=None):
1320
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1323
pp = ProgressPhase("Pull phase", 2, top_pb)
1325
old_revision_info = self.branch.last_revision_info()
1326
basis_tree = self.basis_tree()
1327
count = self.branch.pull(source, overwrite, stop_revision)
1328
new_revision_info = self.branch.last_revision_info()
1329
if new_revision_info != old_revision_info:
1331
repository = self.branch.repository
1332
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1334
new_basis_tree = self.branch.basis_tree()
1341
change_reporter=change_reporter)
1342
if (basis_tree.inventory.root is None and
1343
new_basis_tree.inventory.root is not None):
1344
self.set_root_id(new_basis_tree.inventory.root.file_id)
1347
# TODO - dedup parents list with things merged by pull ?
1348
# reuse the revisiontree we merged against to set the new
1350
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1351
# we have to pull the merge trees out again, because
1352
# merge_inner has set the ids. - this corner is not yet
1353
# layered well enough to prevent double handling.
1354
merges = self.get_parent_ids()[1:]
1355
parent_trees.extend([
1356
(parent, repository.revision_tree(parent)) for
1358
self.set_parent_trees(parent_trees)
1365
def put_file_bytes_non_atomic(self, file_id, bytes):
1366
"""See MutableTree.put_file_bytes_non_atomic."""
1367
stream = file(self.id2abspath(file_id), 'wb')
1372
# TODO: update the hashcache here ?
1375
"""Yield all unknown files in this WorkingTree.
1377
If there are any unknown directories then only the directory is
1378
returned, not all its children. But if there are unknown files
1379
under a versioned subdirectory, they are returned.
1381
Currently returned depth-first, sorted by name within directories.
1383
## TODO: Work from given directory downwards
1384
for path, dir_entry in self.inventory.directories():
1385
# mutter("search for unknowns in %r", path)
1386
dirabs = self.abspath(path)
1387
if not isdir(dirabs):
1388
# e.g. directory deleted
1392
for subf in os.listdir(dirabs):
1395
if subf not in dir_entry.children:
1396
subf_norm, can_access = osutils.normalized_filename(subf)
1397
if subf_norm != subf and can_access:
1398
if subf_norm not in dir_entry.children:
1399
fl.append(subf_norm)
1405
subp = pathjoin(path, subf)
1409
def ignored_files(self):
1410
"""Yield list of PATH, IGNORE_PATTERN"""
1411
for subp in self.extras():
1412
pat = self.is_ignored(subp)
1416
def get_ignore_list(self):
1417
"""Return list of ignore patterns.
1419
Cached in the Tree object after the first call.
1421
ignoreset = getattr(self, '_ignoreset', None)
1422
if ignoreset is not None:
1425
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1426
ignore_globs.update(ignores.get_runtime_ignores())
1427
ignore_globs.update(ignores.get_user_ignores())
1428
if self.has_filename(bzrlib.IGNORE_FILENAME):
1429
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1431
ignore_globs.update(ignores.parse_ignore_file(f))
1434
self._ignoreset = ignore_globs
1437
def _flush_ignore_list_cache(self):
1438
"""Resets the cached ignore list to force a cache rebuild."""
1439
self._ignoreset = None
1440
self._ignoreglobster = None
1442
def is_ignored(self, filename):
1443
r"""Check whether the filename matches an ignore pattern.
1445
Patterns containing '/' or '\' need to match the whole path;
1446
others match against only the last component.
1448
If the file is ignored, returns the pattern which caused it to
1449
be ignored, otherwise None. So this can simply be used as a
1450
boolean if desired."""
1451
if getattr(self, '_ignoreglobster', None) is None:
1452
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1453
return self._ignoreglobster.match(filename)
1455
def kind(self, file_id):
1456
return file_kind(self.id2abspath(file_id))
1458
def _comparison_data(self, entry, path):
1459
abspath = self.abspath(path)
1461
stat_value = os.lstat(abspath)
1463
if getattr(e, 'errno', None) == errno.ENOENT:
1470
mode = stat_value.st_mode
1471
kind = osutils.file_kind_from_stat_mode(mode)
1472
if not supports_executable():
1473
executable = entry.executable
1475
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1476
return kind, executable, stat_value
1478
def _file_size(self, entry, stat_value):
1479
return stat_value.st_size
1481
def last_revision(self):
1482
"""Return the last revision of the branch for this tree.
1484
This format tree does not support a separate marker for last-revision
1485
compared to the branch.
1487
See MutableTree.last_revision
1489
return self._last_revision()
1492
def _last_revision(self):
1493
"""helper for get_parent_ids."""
1494
return self.branch.last_revision()
1496
def is_locked(self):
1497
return self._control_files.is_locked()
1499
def lock_read(self):
1500
"""See Branch.lock_read, and WorkingTree.unlock."""
1501
self.branch.lock_read()
1503
return self._control_files.lock_read()
1505
self.branch.unlock()
1508
def lock_tree_write(self):
1509
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1510
self.branch.lock_read()
1512
return self._control_files.lock_write()
1514
self.branch.unlock()
1517
def lock_write(self):
1518
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1519
self.branch.lock_write()
1521
return self._control_files.lock_write()
1523
self.branch.unlock()
1526
def get_physical_lock_status(self):
1527
return self._control_files.get_physical_lock_status()
1529
def _basis_inventory_name(self):
1530
return 'basis-inventory-cache'
1532
@needs_tree_write_lock
1533
def set_last_revision(self, new_revision):
1534
"""Change the last revision in the working tree."""
1535
if self._change_last_revision(new_revision):
1536
self._cache_basis_inventory(new_revision)
1538
def _change_last_revision(self, new_revision):
1539
"""Template method part of set_last_revision to perform the change.
1541
This is used to allow WorkingTree3 instances to not affect branch
1542
when their last revision is set.
1544
if new_revision is None:
1545
self.branch.set_revision_history([])
1548
self.branch.generate_revision_history(new_revision)
1549
except errors.NoSuchRevision:
1550
# not present in the repo - dont try to set it deeper than the tip
1551
self.branch.set_revision_history([new_revision])
1554
def _write_basis_inventory(self, xml):
1555
"""Write the basis inventory XML to the basis-inventory file"""
1556
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1557
path = self._basis_inventory_name()
1559
self._control_files.put(path, sio)
1561
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1562
"""Create the text that will be saved in basis-inventory"""
1563
inventory.revision_id = revision_id
1564
return xml6.serializer_v6.write_inventory_to_string(inventory)
1566
def _cache_basis_inventory(self, new_revision):
1567
"""Cache new_revision as the basis inventory."""
1568
# TODO: this should allow the ready-to-use inventory to be passed in,
1569
# as commit already has that ready-to-use [while the format is the
1572
# this double handles the inventory - unpack and repack -
1573
# but is easier to understand. We can/should put a conditional
1574
# in here based on whether the inventory is in the latest format
1575
# - perhaps we should repack all inventories on a repository
1577
# the fast path is to copy the raw xml from the repository. If the
1578
# xml contains 'revision_id="', then we assume the right
1579
# revision_id is set. We must check for this full string, because a
1580
# root node id can legitimately look like 'revision_id' but cannot
1582
xml = self.branch.repository.get_inventory_xml(new_revision)
1583
firstline = xml.split('\n', 1)[0]
1584
if (not 'revision_id="' in firstline or
1585
'format="6"' not in firstline):
1586
inv = self.branch.repository.deserialise_inventory(
1588
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1589
self._write_basis_inventory(xml)
1590
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1593
def read_basis_inventory(self):
1594
"""Read the cached basis inventory."""
1595
path = self._basis_inventory_name()
1596
return self._control_files.get(path).read()
1599
def read_working_inventory(self):
1600
"""Read the working inventory.
1602
:raises errors.InventoryModified: read_working_inventory will fail
1603
when the current in memory inventory has been modified.
1605
# conceptually this should be an implementation detail of the tree.
1606
# XXX: Deprecate this.
1607
# ElementTree does its own conversion from UTF-8, so open in
1609
if self._inventory_is_modified:
1610
raise errors.InventoryModified(self)
1611
result = xml5.serializer_v5.read_inventory(
1612
self._control_files.get('inventory'))
1613
self._set_inventory(result, dirty=False)
1616
@needs_tree_write_lock
1617
def remove(self, files, verbose=False, to_file=None):
1618
"""Remove nominated files from the working inventory..
1620
This does not remove their text. This does not run on XXX on what? RBC
1622
TODO: Refuse to remove modified files unless --force is given?
1624
TODO: Do something useful with directories.
1626
TODO: Should this remove the text or not? Tough call; not
1627
removing may be useful and the user can just use use rm, and
1628
is the opposite of add. Removing it is consistent with most
1629
other tools. Maybe an option.
1631
## TODO: Normalize names
1632
## TODO: Remove nested loops; better scalability
1633
if isinstance(files, basestring):
1636
inv = self.inventory
1638
# do this before any modifications
1640
fid = inv.path2id(f)
1642
note("%s is not versioned."%f)
1645
# having remove it, it must be either ignored or unknown
1646
if self.is_ignored(f):
1650
textui.show_status(new_status, inv[fid].kind, f,
1654
self._write_inventory(inv)
1656
@needs_tree_write_lock
1657
def revert(self, filenames, old_tree=None, backups=True,
1658
pb=DummyProgress(), report_changes=False):
1659
from bzrlib.conflicts import resolve
1660
if old_tree is None:
1661
old_tree = self.basis_tree()
1662
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1664
if not len(filenames):
1665
self.set_parent_ids(self.get_parent_ids()[:1])
1668
resolve(self, filenames, ignore_misses=True)
1671
# XXX: This method should be deprecated in favour of taking in a proper
1672
# new Inventory object.
1673
@needs_tree_write_lock
1674
def set_inventory(self, new_inventory_list):
1675
from bzrlib.inventory import (Inventory,
1680
inv = Inventory(self.get_root_id())
1681
for path, file_id, parent, kind in new_inventory_list:
1682
name = os.path.basename(path)
1685
# fixme, there should be a factory function inv,add_??
1686
if kind == 'directory':
1687
inv.add(InventoryDirectory(file_id, name, parent))
1688
elif kind == 'file':
1689
inv.add(InventoryFile(file_id, name, parent))
1690
elif kind == 'symlink':
1691
inv.add(InventoryLink(file_id, name, parent))
1693
raise errors.BzrError("unknown kind %r" % kind)
1694
self._write_inventory(inv)
1696
@needs_tree_write_lock
1697
def set_root_id(self, file_id):
1698
"""Set the root id for this tree."""
1701
symbol_versioning.warn(symbol_versioning.zero_twelve
1702
% 'WorkingTree.set_root_id with fileid=None',
1706
inv = self._inventory
1707
orig_root_id = inv.root.file_id
1708
# TODO: it might be nice to exit early if there was nothing
1709
# to do, saving us from trigger a sync on unlock.
1710
self._inventory_is_modified = True
1711
# we preserve the root inventory entry object, but
1712
# unlinkit from the byid index
1713
del inv._byid[inv.root.file_id]
1714
inv.root.file_id = file_id
1715
# and link it into the index with the new changed id.
1716
inv._byid[inv.root.file_id] = inv.root
1717
# and finally update all children to reference the new id.
1718
# XXX: this should be safe to just look at the root.children
1719
# list, not the WHOLE INVENTORY.
1722
if entry.parent_id == orig_root_id:
1723
entry.parent_id = inv.root.file_id
1726
"""See Branch.unlock.
1728
WorkingTree locking just uses the Branch locking facilities.
1729
This is current because all working trees have an embedded branch
1730
within them. IF in the future, we were to make branch data shareable
1731
between multiple working trees, i.e. via shared storage, then we
1732
would probably want to lock both the local tree, and the branch.
1734
raise NotImplementedError(self.unlock)
1737
"""Update a working tree along its branch.
1739
This will update the branch if its bound too, which means we have
1740
multiple trees involved:
1742
- The new basis tree of the master.
1743
- The old basis tree of the branch.
1744
- The old basis tree of the working tree.
1745
- The current working tree state.
1747
Pathologically, all three may be different, and non-ancestors of each
1748
other. Conceptually we want to:
1750
- Preserve the wt.basis->wt.state changes
1751
- Transform the wt.basis to the new master basis.
1752
- Apply a merge of the old branch basis to get any 'local' changes from
1754
- Restore the wt.basis->wt.state changes.
1756
There isn't a single operation at the moment to do that, so we:
1757
- Merge current state -> basis tree of the master w.r.t. the old tree
1759
- Do a 'normal' merge of the old branch basis if it is relevant.
1761
if self.branch.get_master_branch() is not None:
1763
update_branch = True
1765
self.lock_tree_write()
1766
update_branch = False
1769
old_tip = self.branch.update()
1772
return self._update_tree(old_tip)
1776
@needs_tree_write_lock
1777
def _update_tree(self, old_tip=None):
1778
"""Update a tree to the master branch.
1780
:param old_tip: if supplied, the previous tip revision the branch,
1781
before it was changed to the master branch's tip.
1783
# here if old_tip is not None, it is the old tip of the branch before
1784
# it was updated from the master branch. This should become a pending
1785
# merge in the working tree to preserve the user existing work. we
1786
# cant set that until we update the working trees last revision to be
1787
# one from the new branch, because it will just get absorbed by the
1788
# parent de-duplication logic.
1790
# We MUST save it even if an error occurs, because otherwise the users
1791
# local work is unreferenced and will appear to have been lost.
1795
last_rev = self.get_parent_ids()[0]
1798
if last_rev != self.branch.last_revision():
1799
# merge tree state up to new branch tip.
1800
basis = self.basis_tree()
1801
to_tree = self.branch.basis_tree()
1802
if basis.inventory.root is None:
1803
self.set_root_id(to_tree.inventory.root.file_id)
1804
result += merge.merge_inner(
1809
# TODO - dedup parents list with things merged by pull ?
1810
# reuse the tree we've updated to to set the basis:
1811
parent_trees = [(self.branch.last_revision(), to_tree)]
1812
merges = self.get_parent_ids()[1:]
1813
# Ideally we ask the tree for the trees here, that way the working
1814
# tree can decide whether to give us teh entire tree or give us a
1815
# lazy initialised tree. dirstate for instance will have the trees
1816
# in ram already, whereas a last-revision + basis-inventory tree
1817
# will not, but also does not need them when setting parents.
1818
for parent in merges:
1819
parent_trees.append(
1820
(parent, self.branch.repository.revision_tree(parent)))
1821
if old_tip is not None:
1822
parent_trees.append(
1823
(old_tip, self.branch.repository.revision_tree(old_tip)))
1824
self.set_parent_trees(parent_trees)
1825
last_rev = parent_trees[0][0]
1827
# the working tree had the same last-revision as the master
1828
# branch did. We may still have pivot local work from the local
1829
# branch into old_tip:
1830
if old_tip is not None:
1831
self.add_parent_tree_id(old_tip)
1832
if old_tip and old_tip != last_rev:
1833
# our last revision was not the prior branch last revision
1834
# and we have converted that last revision to a pending merge.
1835
# base is somewhere between the branch tip now
1836
# and the now pending merge
1837
from bzrlib.revision import common_ancestor
1839
base_rev_id = common_ancestor(self.branch.last_revision(),
1841
self.branch.repository)
1842
except errors.NoCommonAncestor:
1844
base_tree = self.branch.repository.revision_tree(base_rev_id)
1845
other_tree = self.branch.repository.revision_tree(old_tip)
1846
result += merge.merge_inner(
1853
def _write_hashcache_if_dirty(self):
1854
"""Write out the hashcache if it is dirty."""
1855
if self._hashcache.needs_write:
1857
self._hashcache.write()
1859
if e.errno not in (errno.EPERM, errno.EACCES):
1861
# TODO: jam 20061219 Should this be a warning? A single line
1862
# warning might be sufficient to let the user know what
1864
mutter('Could not write hashcache for %s\nError: %s',
1865
self._hashcache.cache_file_name(), e)
1867
@needs_tree_write_lock
1868
def _write_inventory(self, inv):
1869
"""Write inventory as the current inventory."""
1870
self._set_inventory(inv, dirty=True)
1873
def set_conflicts(self, arg):
1874
raise errors.UnsupportedOperation(self.set_conflicts, self)
1876
def add_conflicts(self, arg):
1877
raise errors.UnsupportedOperation(self.add_conflicts, self)
1880
def conflicts(self):
1881
conflicts = _mod_conflicts.ConflictList()
1882
for conflicted in self._iter_conflicts():
1885
if file_kind(self.abspath(conflicted)) != "file":
1887
except errors.NoSuchFile:
1890
for suffix in ('.THIS', '.OTHER'):
1892
kind = file_kind(self.abspath(conflicted+suffix))
1895
except errors.NoSuchFile:
1899
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1900
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1902
file_id=self.path2id(conflicted)))
1906
class WorkingTree2(WorkingTree):
1907
"""This is the Format 2 working tree.
1909
This was the first weave based working tree.
1910
- uses os locks for locking.
1911
- uses the branch last-revision.
1914
def lock_tree_write(self):
1915
"""See WorkingTree.lock_tree_write().
1917
In Format2 WorkingTrees we have a single lock for the branch and tree
1918
so lock_tree_write() degrades to lock_write().
1920
self.branch.lock_write()
1922
return self._control_files.lock_write()
1924
self.branch.unlock()
1928
# we share control files:
1929
if self._control_files._lock_count == 3:
1930
# _inventory_is_modified is always False during a read lock.
1931
if self._inventory_is_modified:
1933
self._write_hashcache_if_dirty()
1935
# reverse order of locking.
1937
return self._control_files.unlock()
1939
self.branch.unlock()
1942
class WorkingTree3(WorkingTree):
1943
"""This is the Format 3 working tree.
1945
This differs from the base WorkingTree by:
1946
- having its own file lock
1947
- having its own last-revision property.
1949
This is new in bzr 0.8
1953
def _last_revision(self):
1954
"""See Mutable.last_revision."""
1956
return self._control_files.get_utf8('last-revision').read()
1957
except errors.NoSuchFile:
1960
def _change_last_revision(self, revision_id):
1961
"""See WorkingTree._change_last_revision."""
1962
if revision_id is None or revision_id == NULL_REVISION:
1964
self._control_files._transport.delete('last-revision')
1965
except errors.NoSuchFile:
1969
self._control_files.put_utf8('last-revision', revision_id)
1972
@needs_tree_write_lock
1973
def set_conflicts(self, conflicts):
1974
self._put_rio('conflicts', conflicts.to_stanzas(),
1977
@needs_tree_write_lock
1978
def add_conflicts(self, new_conflicts):
1979
conflict_set = set(self.conflicts())
1980
conflict_set.update(set(list(new_conflicts)))
1981
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1982
key=_mod_conflicts.Conflict.sort_key)))
1985
def conflicts(self):
1987
confile = self._control_files.get('conflicts')
1988
except errors.NoSuchFile:
1989
return _mod_conflicts.ConflictList()
1991
if confile.next() != CONFLICT_HEADER_1 + '\n':
1992
raise errors.ConflictFormatError()
1993
except StopIteration:
1994
raise errors.ConflictFormatError()
1995
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1998
if self._control_files._lock_count == 1:
1999
# _inventory_is_modified is always False during a read lock.
2000
if self._inventory_is_modified:
2002
self._write_hashcache_if_dirty()
2003
# reverse order of locking.
2005
return self._control_files.unlock()
2007
self.branch.unlock()
2010
def get_conflicted_stem(path):
2011
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2012
if path.endswith(suffix):
2013
return path[:-len(suffix)]
2015
@deprecated_function(zero_eight)
2016
def is_control_file(filename):
2017
"""See WorkingTree.is_control_filename(filename)."""
2018
## FIXME: better check
2019
filename = normpath(filename)
2020
while filename != '':
2021
head, tail = os.path.split(filename)
2022
## mutter('check %r for control file' % ((head, tail),))
2025
if filename == head:
2031
class WorkingTreeFormat(object):
2032
"""An encapsulation of the initialization and open routines for a format.
2034
Formats provide three things:
2035
* An initialization routine,
2039
Formats are placed in an dict by their format string for reference
2040
during workingtree opening. Its not required that these be instances, they
2041
can be classes themselves with class methods - it simply depends on
2042
whether state is needed for a given format or not.
2044
Once a format is deprecated, just deprecate the initialize and open
2045
methods on the format class. Do not deprecate the object, as the
2046
object will be created every time regardless.
2049
_default_format = None
2050
"""The default format used for new trees."""
2053
"""The known formats."""
2056
def find_format(klass, a_bzrdir):
2057
"""Return the format for the working tree object in a_bzrdir."""
2059
transport = a_bzrdir.get_workingtree_transport(None)
2060
format_string = transport.get("format").read()
2061
return klass._formats[format_string]
2062
except errors.NoSuchFile:
2063
raise errors.NoWorkingTree(base=transport.base)
2065
raise errors.UnknownFormatError(format=format_string)
2068
def get_default_format(klass):
2069
"""Return the current default format."""
2070
return klass._default_format
2072
def get_format_string(self):
2073
"""Return the ASCII format string that identifies this format."""
2074
raise NotImplementedError(self.get_format_string)
2076
def get_format_description(self):
2077
"""Return the short description for this format."""
2078
raise NotImplementedError(self.get_format_description)
2080
def is_supported(self):
2081
"""Is this format supported?
2083
Supported formats can be initialized and opened.
2084
Unsupported formats may not support initialization or committing or
2085
some other features depending on the reason for not being supported.
2090
def register_format(klass, format):
2091
klass._formats[format.get_format_string()] = format
2094
def set_default_format(klass, format):
2095
klass._default_format = format
2098
def unregister_format(klass, format):
2099
assert klass._formats[format.get_format_string()] is format
2100
del klass._formats[format.get_format_string()]
2104
class WorkingTreeFormat2(WorkingTreeFormat):
2105
"""The second working tree format.
2107
This format modified the hash cache from the format 1 hash cache.
2110
def get_format_description(self):
2111
"""See WorkingTreeFormat.get_format_description()."""
2112
return "Working tree format 2"
2114
def stub_initialize_remote(self, control_files):
2115
"""As a special workaround create critical control files for a remote working tree
2117
This ensures that it can later be updated and dealt with locally,
2118
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2119
no working tree. (See bug #43064).
2123
xml5.serializer_v5.write_inventory(inv, sio)
2125
control_files.put('inventory', sio)
2127
control_files.put_utf8('pending-merges', '')
2130
def initialize(self, a_bzrdir, revision_id=None):
2131
"""See WorkingTreeFormat.initialize()."""
2132
if not isinstance(a_bzrdir.transport, LocalTransport):
2133
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2134
branch = a_bzrdir.open_branch()
2135
if revision_id is not None:
2138
revision_history = branch.revision_history()
2140
position = revision_history.index(revision_id)
2142
raise errors.NoSuchRevision(branch, revision_id)
2143
branch.set_revision_history(revision_history[:position + 1])
2146
revision = branch.last_revision()
2148
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2154
basis_tree = branch.repository.revision_tree(revision)
2155
if basis_tree.inventory.root is not None:
2156
wt.set_root_id(basis_tree.inventory.root.file_id)
2157
# set the parent list and cache the basis tree.
2158
wt.set_parent_trees([(revision, basis_tree)])
2159
transform.build_tree(basis_tree, wt)
2163
super(WorkingTreeFormat2, self).__init__()
2164
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2166
def open(self, a_bzrdir, _found=False):
2167
"""Return the WorkingTree object for a_bzrdir
2169
_found is a private parameter, do not use it. It is used to indicate
2170
if format probing has already been done.
2173
# we are being called directly and must probe.
2174
raise NotImplementedError
2175
if not isinstance(a_bzrdir.transport, LocalTransport):
2176
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2177
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2183
class WorkingTreeFormat3(WorkingTreeFormat):
2184
"""The second working tree format updated to record a format marker.
2187
- exists within a metadir controlling .bzr
2188
- includes an explicit version marker for the workingtree control
2189
files, separate from the BzrDir format
2190
- modifies the hash cache format
2192
- uses a LockDir to guard access for writes.
2195
def get_format_string(self):
2196
"""See WorkingTreeFormat.get_format_string()."""
2197
return "Bazaar-NG Working Tree format 3"
2199
def get_format_description(self):
2200
"""See WorkingTreeFormat.get_format_description()."""
2201
return "Working tree format 3"
2203
_lock_file_name = 'lock'
2204
_lock_class = LockDir
2206
def _open_control_files(self, a_bzrdir):
2207
transport = a_bzrdir.get_workingtree_transport(None)
2208
return LockableFiles(transport, self._lock_file_name,
2211
def initialize(self, a_bzrdir, revision_id=None):
2212
"""See WorkingTreeFormat.initialize().
2214
revision_id allows creating a working tree at a different
2215
revision than the branch is at.
2217
if not isinstance(a_bzrdir.transport, LocalTransport):
2218
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2219
transport = a_bzrdir.get_workingtree_transport(self)
2220
control_files = self._open_control_files(a_bzrdir)
2221
control_files.create_lock()
2222
control_files.lock_write()
2223
control_files.put_utf8('format', self.get_format_string())
2224
branch = a_bzrdir.open_branch()
2225
if revision_id is None:
2226
revision_id = branch.last_revision()
2227
# WorkingTree3 can handle an inventory which has a unique root id.
2228
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2229
# those trees. And because there isn't a format bump inbetween, we
2230
# are maintaining compatibility with older clients.
2231
# inv = Inventory(root_id=gen_root_id())
2233
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2239
_control_files=control_files)
2240
wt.lock_tree_write()
2242
basis_tree = branch.repository.revision_tree(revision_id)
2243
# only set an explicit root id if there is one to set.
2244
if basis_tree.inventory.root is not None:
2245
wt.set_root_id(basis_tree.inventory.root.file_id)
2246
if revision_id == NULL_REVISION:
2247
wt.set_parent_trees([])
2249
wt.set_parent_trees([(revision_id, basis_tree)])
2250
transform.build_tree(basis_tree, wt)
2252
# Unlock in this order so that the unlock-triggers-flush in
2253
# WorkingTree is given a chance to fire.
2254
control_files.unlock()
2259
super(WorkingTreeFormat3, self).__init__()
2260
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2262
def open(self, a_bzrdir, _found=False):
2263
"""Return the WorkingTree object for a_bzrdir
2265
_found is a private parameter, do not use it. It is used to indicate
2266
if format probing has already been done.
2269
# we are being called directly and must probe.
2270
raise NotImplementedError
2271
if not isinstance(a_bzrdir.transport, LocalTransport):
2272
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2273
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2275
def _open(self, a_bzrdir, control_files):
2276
"""Open the tree itself.
2278
:param a_bzrdir: the dir for the tree.
2279
:param control_files: the control files for the tree.
2281
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2285
_control_files=control_files)
2288
return self.get_format_string()
2291
# formats which have no format string are not discoverable
2292
# and not independently creatable, so are not registered.
2293
__default_format = WorkingTreeFormat3()
2294
WorkingTreeFormat.register_format(__default_format)
2295
WorkingTreeFormat.set_default_format(__default_format)
2296
_legacy_formats = [WorkingTreeFormat2(),
2300
class WorkingTreeTestProviderAdapter(object):
2301
"""A tool to generate a suite testing multiple workingtree formats at once.
2303
This is done by copying the test once for each transport and injecting
2304
the transport_server, transport_readonly_server, and workingtree_format
2305
classes into each copy. Each copy is also given a new id() to make it
2309
def __init__(self, transport_server, transport_readonly_server, formats):
2310
self._transport_server = transport_server
2311
self._transport_readonly_server = transport_readonly_server
2312
self._formats = formats
2314
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2315
"""Clone test for adaption."""
2316
new_test = deepcopy(test)
2317
new_test.transport_server = self._transport_server
2318
new_test.transport_readonly_server = self._transport_readonly_server
2319
new_test.bzrdir_format = bzrdir_format
2320
new_test.workingtree_format = workingtree_format
2321
def make_new_test_id():
2322
new_id = "%s(%s)" % (test.id(), variation)
2323
return lambda: new_id
2324
new_test.id = make_new_test_id()
2327
def adapt(self, test):
2328
from bzrlib.tests import TestSuite
2329
result = TestSuite()
2330
for workingtree_format, bzrdir_format in self._formats:
2331
new_test = self._clone_test(
2334
workingtree_format, workingtree_format.__class__.__name__)
2335
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
