1
# Copyright (C) 2005, 2006, 2007 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,
68
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
self._flush_ignore_list_cache()
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, path=None):
456
path = self.id2path(file_id)
457
return self.get_file_byname(path)
459
def get_file_text(self, file_id):
460
return self.get_file(file_id).read()
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
466
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
467
"""See Tree.annotate_iter
469
This implementation will use the basis tree implementation if possible.
470
Lines not in the basis are attributed to CURRENT_REVISION
472
If there are pending merges, lines added by those merges will be
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
attribution will be correct).
476
basis = self.basis_tree()
479
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
480
require_versioned=True).next()
481
changed_content, kind = changes[2], changes[6]
482
if not changed_content:
483
return basis.annotate_iter(file_id)
487
if kind[0] != 'file':
490
old_lines = list(basis.annotate_iter(file_id))
492
for tree in self.branch.repository.revision_trees(
493
self.get_parent_ids()[1:]):
494
if file_id not in tree:
496
old.append(list(tree.annotate_iter(file_id)))
497
return annotate.reannotate(old, self.get_file(file_id).readlines(),
502
def _get_ancestors(self, default_revision):
503
ancestors = set([default_revision])
504
for parent_id in self.get_parent_ids():
505
ancestors.update(self.branch.repository.get_ancestry(
506
parent_id, topo_sorted=False))
509
def get_parent_ids(self):
510
"""See Tree.get_parent_ids.
512
This implementation reads the pending merges list and last_revision
513
value and uses that to decide what the parents list should be.
515
last_rev = _mod_revision.ensure_null(self._last_revision())
516
if _mod_revision.NULL_REVISION == last_rev:
521
merges_file = self._control_files.get('pending-merges')
522
except errors.NoSuchFile:
525
for l in merges_file.readlines():
526
revision_id = l.rstrip('\n')
527
parents.append(revision_id)
531
def get_root_id(self):
532
"""Return the id of this trees root"""
533
return self._inventory.root.file_id
535
def _get_store_filename(self, file_id):
536
## XXX: badly named; this is not in the store at all
537
return self.abspath(self.id2path(file_id))
540
def clone(self, to_bzrdir, revision_id=None):
541
"""Duplicate this working tree into to_bzr, including all state.
543
Specifically modified files are kept as modified, but
544
ignored and unknown files are discarded.
546
If you want to make a new line of development, see bzrdir.sprout()
549
If not None, the cloned tree will have its last revision set to
550
revision, and and difference between the source trees last revision
551
and this one merged in.
553
# assumes the target bzr dir format is compatible.
554
result = self._format.initialize(to_bzrdir)
555
self.copy_content_into(result, revision_id)
559
def copy_content_into(self, tree, revision_id=None):
560
"""Copy the current content and user files of this tree into tree."""
561
tree.set_root_id(self.get_root_id())
562
if revision_id is None:
563
merge.transform_tree(tree, self)
565
# TODO now merge from tree.last_revision to revision (to preserve
566
# user local changes)
567
merge.transform_tree(tree, self)
568
tree.set_parent_ids([revision_id])
570
def id2abspath(self, file_id):
571
return self.abspath(self.id2path(file_id))
573
def has_id(self, file_id):
574
# files that have been deleted are excluded
576
if not inv.has_id(file_id):
578
path = inv.id2path(file_id)
579
return osutils.lexists(self.abspath(path))
581
def has_or_had_id(self, file_id):
582
if file_id == self.inventory.root.file_id:
584
return self.inventory.has_id(file_id)
586
__contains__ = has_id
588
def get_file_size(self, file_id):
589
return os.path.getsize(self.id2abspath(file_id))
592
def get_file_sha1(self, file_id, path=None, stat_value=None):
594
path = self._inventory.id2path(file_id)
595
return self._hashcache.get_sha1(path, stat_value)
597
def get_file_mtime(self, file_id, path=None):
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
return self._inventory[file_id].executable
606
def is_executable(self, file_id, path=None):
608
path = self.id2path(file_id)
609
mode = os.lstat(self.abspath(path)).st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
612
@needs_tree_write_lock
613
def _add(self, files, ids, kinds):
614
"""See MutableTree._add."""
615
# TODO: Re-adding a file that is removed in the working copy
616
# should probably put it back with the previous ID.
617
# the read and write working inventory should not occur in this
618
# function - they should be part of lock_write and unlock.
620
for f, file_id, kind in zip(files, ids, kinds):
621
assert kind is not None
623
inv.add_path(f, kind=kind)
625
inv.add_path(f, kind=kind, file_id=file_id)
626
self._inventory_is_modified = True
628
@needs_tree_write_lock
629
def _gather_kinds(self, files, kinds):
630
"""See MutableTree._gather_kinds."""
631
for pos, f in enumerate(files):
632
if kinds[pos] is None:
633
fullpath = normpath(self.abspath(f))
635
kinds[pos] = file_kind(fullpath)
637
if e.errno == errno.ENOENT:
638
raise errors.NoSuchFile(fullpath)
641
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
642
"""Add revision_id as a parent.
644
This is equivalent to retrieving the current list of parent ids
645
and setting the list to its value plus revision_id.
647
:param revision_id: The revision id to add to the parent list. It may
648
be a ghost revision as long as its not the first parent to be added,
649
or the allow_leftmost_as_ghost parameter is set True.
650
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
parents = self.get_parent_ids() + [revision_id]
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
654
or allow_leftmost_as_ghost)
656
@needs_tree_write_lock
657
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
658
"""Add revision_id, tree tuple as a parent.
660
This is equivalent to retrieving the current list of parent trees
661
and setting the list to its value plus parent_tuple. See also
662
add_parent_tree_id - if you only have a parent id available it will be
663
simpler to use that api. If you have the parent already available, using
664
this api is preferred.
666
:param parent_tuple: The (revision id, tree) to add to the parent list.
667
If the revision_id is a ghost, pass None for the tree.
668
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
671
if len(parent_ids) > 1:
672
# the leftmost may have already been a ghost, preserve that if it
674
allow_leftmost_as_ghost = True
675
self.set_parent_ids(parent_ids,
676
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
678
@needs_tree_write_lock
679
def add_pending_merge(self, *revision_ids):
680
# TODO: Perhaps should check at this point that the
681
# history of the revision is actually present?
682
parents = self.get_parent_ids()
684
for rev_id in revision_ids:
685
if rev_id in parents:
687
parents.append(rev_id)
690
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
692
@deprecated_method(zero_eleven)
694
def pending_merges(self):
695
"""Return a list of pending merges.
697
These are revisions that have been merged into the working
698
directory but not yet committed.
700
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
701
instead - which is available on all tree objects.
703
return self.get_parent_ids()[1:]
705
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
706
"""Common ghost checking functionality from set_parent_*.
708
This checks that the left hand-parent exists if there are any
711
if len(revision_ids) > 0:
712
leftmost_id = revision_ids[0]
713
if (not allow_leftmost_as_ghost and not
714
self.branch.repository.has_revision(leftmost_id)):
715
raise errors.GhostRevisionUnusableHere(leftmost_id)
717
def _set_merges_from_parent_ids(self, parent_ids):
718
merges = parent_ids[1:]
719
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
721
@needs_tree_write_lock
722
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
723
"""Set the parent ids to revision_ids.
725
See also set_parent_trees. This api will try to retrieve the tree data
726
for each element of revision_ids from the trees repository. If you have
727
tree data already available, it is more efficient to use
728
set_parent_trees rather than set_parent_ids. set_parent_ids is however
729
an easier API to use.
731
:param revision_ids: The revision_ids to set as the parent ids of this
732
working tree. Any of these may be ghosts.
734
self._check_parents_for_ghosts(revision_ids,
735
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
736
for revision_id in revision_ids:
737
_mod_revision.check_not_reserved_id(revision_id)
739
if len(revision_ids) > 0:
740
self.set_last_revision(revision_ids[0])
742
self.set_last_revision(_mod_revision.NULL_REVISION)
744
self._set_merges_from_parent_ids(revision_ids)
746
@needs_tree_write_lock
747
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
748
"""See MutableTree.set_parent_trees."""
749
parent_ids = [rev for (rev, tree) in parents_list]
750
for revision_id in parent_ids:
751
_mod_revision.check_not_reserved_id(revision_id)
753
self._check_parents_for_ghosts(parent_ids,
754
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
756
if len(parent_ids) == 0:
757
leftmost_parent_id = _mod_revision.NULL_REVISION
758
leftmost_parent_tree = None
760
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
762
if self._change_last_revision(leftmost_parent_id):
763
if leftmost_parent_tree is None:
764
# If we don't have a tree, fall back to reading the
765
# parent tree from the repository.
766
self._cache_basis_inventory(leftmost_parent_id)
768
inv = leftmost_parent_tree.inventory
769
xml = self._create_basis_xml_from_inventory(
770
leftmost_parent_id, inv)
771
self._write_basis_inventory(xml)
772
self._set_merges_from_parent_ids(parent_ids)
774
@needs_tree_write_lock
775
def set_pending_merges(self, rev_list):
776
parents = self.get_parent_ids()
777
leftmost = parents[:1]
778
new_parents = leftmost + rev_list
779
self.set_parent_ids(new_parents)
781
@needs_tree_write_lock
782
def set_merge_modified(self, modified_hashes):
784
for file_id, hash in modified_hashes.iteritems():
785
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
786
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
788
def _put_rio(self, filename, stanzas, header):
789
self._must_be_locked()
790
my_file = rio_file(stanzas, header)
791
self._control_files.put(filename, my_file)
793
@needs_write_lock # because merge pulls data into the branch.
794
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
796
"""Merge from a branch into this working tree.
798
:param branch: The branch to merge from.
799
:param to_revision: If non-None, the merge will merge to to_revision,
800
but not beyond it. to_revision does not need to be in the history
801
of the branch when it is supplied. If None, to_revision defaults to
802
branch.last_revision().
804
from bzrlib.merge import Merger, Merge3Merger
805
pb = bzrlib.ui.ui_factory.nested_progress_bar()
807
merger = Merger(self.branch, this_tree=self, pb=pb)
808
merger.pp = ProgressPhase("Merge phase", 5, pb)
809
merger.pp.next_phase()
810
# check that there are no
812
merger.check_basis(check_clean=True, require_commits=False)
813
if to_revision is None:
814
to_revision = _mod_revision.ensure_null(branch.last_revision())
815
merger.other_rev_id = to_revision
816
if _mod_revision.is_null(merger.other_rev_id):
817
raise errors.NoCommits(branch)
818
self.branch.fetch(branch, last_revision=merger.other_rev_id)
819
merger.other_basis = merger.other_rev_id
820
merger.other_tree = self.branch.repository.revision_tree(
822
merger.other_branch = branch
823
merger.pp.next_phase()
824
if from_revision is None:
827
merger.set_base_revision(from_revision, branch)
828
if merger.base_rev_id == merger.other_rev_id:
829
raise errors.PointlessMerge
830
merger.backup_files = False
831
if merge_type is None:
832
merger.merge_type = Merge3Merger
834
merger.merge_type = merge_type
835
merger.set_interesting_files(None)
836
merger.show_base = False
837
merger.reprocess = False
838
conflicts = merger.do_merge()
845
def merge_modified(self):
846
"""Return a dictionary of files modified by a merge.
848
The list is initialized by WorkingTree.set_merge_modified, which is
849
typically called after we make some automatic updates to the tree
852
This returns a map of file_id->sha1, containing only files which are
853
still in the working inventory and have that text hash.
856
hashfile = self._control_files.get('merge-hashes')
857
except errors.NoSuchFile:
861
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
862
raise errors.MergeModifiedFormatError()
863
except StopIteration:
864
raise errors.MergeModifiedFormatError()
865
for s in RioReader(hashfile):
866
# RioReader reads in Unicode, so convert file_ids back to utf8
867
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
868
if file_id not in self.inventory:
870
text_hash = s.get("hash")
871
if text_hash == self.get_file_sha1(file_id):
872
merge_hashes[file_id] = text_hash
876
def mkdir(self, path, file_id=None):
877
"""See MutableTree.mkdir()."""
879
file_id = generate_ids.gen_file_id(os.path.basename(path))
880
os.mkdir(self.abspath(path))
881
self.add(path, file_id, 'directory')
884
def get_symlink_target(self, file_id):
885
return os.readlink(self.id2abspath(file_id))
888
def subsume(self, other_tree):
889
def add_children(inventory, entry):
890
for child_entry in entry.children.values():
891
inventory._byid[child_entry.file_id] = child_entry
892
if child_entry.kind == 'directory':
893
add_children(inventory, child_entry)
894
if other_tree.get_root_id() == self.get_root_id():
895
raise errors.BadSubsumeSource(self, other_tree,
896
'Trees have the same root')
898
other_tree_path = self.relpath(other_tree.basedir)
899
except errors.PathNotChild:
900
raise errors.BadSubsumeSource(self, other_tree,
901
'Tree is not contained by the other')
902
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
903
if new_root_parent is None:
904
raise errors.BadSubsumeSource(self, other_tree,
905
'Parent directory is not versioned.')
906
# We need to ensure that the result of a fetch will have a
907
# versionedfile for the other_tree root, and only fetching into
908
# RepositoryKnit2 guarantees that.
909
if not self.branch.repository.supports_rich_root():
910
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
911
other_tree.lock_tree_write()
913
new_parents = other_tree.get_parent_ids()
914
other_root = other_tree.inventory.root
915
other_root.parent_id = new_root_parent
916
other_root.name = osutils.basename(other_tree_path)
917
self.inventory.add(other_root)
918
add_children(self.inventory, other_root)
919
self._write_inventory(self.inventory)
920
# normally we don't want to fetch whole repositories, but i think
921
# here we really do want to consolidate the whole thing.
922
for parent_id in other_tree.get_parent_ids():
923
self.branch.fetch(other_tree.branch, parent_id)
924
self.add_parent_tree_id(parent_id)
927
other_tree.bzrdir.retire_bzrdir()
929
@needs_tree_write_lock
930
def extract(self, file_id, format=None):
931
"""Extract a subtree from this tree.
933
A new branch will be created, relative to the path for this tree.
937
segments = osutils.splitpath(path)
938
transport = self.branch.bzrdir.root_transport
939
for name in segments:
940
transport = transport.clone(name)
941
transport.ensure_base()
944
sub_path = self.id2path(file_id)
945
branch_transport = mkdirs(sub_path)
947
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
948
branch_transport.ensure_base()
949
branch_bzrdir = format.initialize_on_transport(branch_transport)
951
repo = branch_bzrdir.find_repository()
952
except errors.NoRepositoryPresent:
953
repo = branch_bzrdir.create_repository()
954
assert repo.supports_rich_root()
956
if not repo.supports_rich_root():
957
raise errors.RootNotRich()
958
new_branch = branch_bzrdir.create_branch()
959
new_branch.pull(self.branch)
960
for parent_id in self.get_parent_ids():
961
new_branch.fetch(self.branch, parent_id)
962
tree_transport = self.bzrdir.root_transport.clone(sub_path)
963
if tree_transport.base != branch_transport.base:
964
tree_bzrdir = format.initialize_on_transport(tree_transport)
965
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
967
tree_bzrdir = branch_bzrdir
968
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
969
wt.set_parent_ids(self.get_parent_ids())
970
my_inv = self.inventory
971
child_inv = Inventory(root_id=None)
972
new_root = my_inv[file_id]
973
my_inv.remove_recursive_id(file_id)
974
new_root.parent_id = None
975
child_inv.add(new_root)
976
self._write_inventory(my_inv)
977
wt._write_inventory(child_inv)
980
def _serialize(self, inventory, out_file):
981
xml5.serializer_v5.write_inventory(self._inventory, out_file,
984
def _deserialize(selt, in_file):
985
return xml5.serializer_v5.read_inventory(in_file)
988
"""Write the in memory inventory to disk."""
989
# TODO: Maybe this should only write on dirty ?
990
if self._control_files._lock_mode != 'w':
991
raise errors.NotWriteLocked(self)
993
self._serialize(self._inventory, sio)
995
self._control_files.put('inventory', sio)
996
self._inventory_is_modified = False
998
def _kind(self, relpath):
999
return osutils.file_kind(self.abspath(relpath))
1001
def list_files(self, include_root=False):
1002
"""Recursively list all files as (path, class, kind, id, entry).
1004
Lists, but does not descend into unversioned directories.
1006
This does not include files that have been deleted in this
1009
Skips the control directory.
1011
# list_files is an iterator, so @needs_read_lock doesn't work properly
1012
# with it. So callers should be careful to always read_lock the tree.
1013
if not self.is_locked():
1014
raise errors.ObjectNotLocked(self)
1016
inv = self.inventory
1017
if include_root is True:
1018
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1019
# Convert these into local objects to save lookup times
1020
pathjoin = osutils.pathjoin
1021
file_kind = self._kind
1023
# transport.base ends in a slash, we want the piece
1024
# between the last two slashes
1025
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1027
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1029
# directory file_id, relative path, absolute path, reverse sorted children
1030
children = os.listdir(self.basedir)
1032
# jam 20060527 The kernel sized tree seems equivalent whether we
1033
# use a deque and popleft to keep them sorted, or if we use a plain
1034
# list and just reverse() them.
1035
children = collections.deque(children)
1036
stack = [(inv.root.file_id, u'', self.basedir, children)]
1038
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1041
f = children.popleft()
1042
## TODO: If we find a subdirectory with its own .bzr
1043
## directory, then that is a separate tree and we
1044
## should exclude it.
1046
# the bzrdir for this tree
1047
if transport_base_dir == f:
1050
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1051
# and 'f' doesn't begin with one, we can do a string op, rather
1052
# than the checks of pathjoin(), all relative paths will have an extra slash
1054
fp = from_dir_relpath + '/' + f
1057
fap = from_dir_abspath + '/' + f
1059
f_ie = inv.get_child(from_dir_id, f)
1062
elif self.is_ignored(fp[1:]):
1065
# we may not have found this file, because of a unicode issue
1066
f_norm, can_access = osutils.normalized_filename(f)
1067
if f == f_norm or not can_access:
1068
# No change, so treat this file normally
1071
# this file can be accessed by a normalized path
1072
# check again if it is versioned
1073
# these lines are repeated here for performance
1075
fp = from_dir_relpath + '/' + f
1076
fap = from_dir_abspath + '/' + f
1077
f_ie = inv.get_child(from_dir_id, f)
1080
elif self.is_ignored(fp[1:]):
1087
# make a last minute entry
1089
yield fp[1:], c, fk, f_ie.file_id, f_ie
1092
yield fp[1:], c, fk, None, fk_entries[fk]()
1094
yield fp[1:], c, fk, None, TreeEntry()
1097
if fk != 'directory':
1100
# But do this child first
1101
new_children = os.listdir(fap)
1103
new_children = collections.deque(new_children)
1104
stack.append((f_ie.file_id, fp, fap, new_children))
1105
# Break out of inner loop,
1106
# so that we start outer loop with child
1109
# if we finished all children, pop it off the stack
1112
@needs_tree_write_lock
1113
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1116
to_dir must exist in the inventory.
1118
If to_dir exists and is a directory, the files are moved into
1119
it, keeping their old names.
1121
Note that to_dir is only the last component of the new name;
1122
this doesn't change the directory.
1124
For each entry in from_paths the move mode will be determined
1127
The first mode moves the file in the filesystem and updates the
1128
inventory. The second mode only updates the inventory without
1129
touching the file on the filesystem. This is the new mode introduced
1132
move uses the second mode if 'after == True' and the target is not
1133
versioned but present in the working tree.
1135
move uses the second mode if 'after == False' and the source is
1136
versioned but no longer in the working tree, and the target is not
1137
versioned but present in the working tree.
1139
move uses the first mode if 'after == False' and the source is
1140
versioned and present in the working tree, and the target is not
1141
versioned and not present in the working tree.
1143
Everything else results in an error.
1145
This returns a list of (from_path, to_path) pairs for each
1146
entry that is moved.
1151
# check for deprecated use of signature
1153
to_dir = kwargs.get('to_name', None)
1155
raise TypeError('You must supply a target directory')
1157
symbol_versioning.warn('The parameter to_name was deprecated'
1158
' in version 0.13. Use to_dir instead',
1161
# check destination directory
1162
assert not isinstance(from_paths, basestring)
1163
inv = self.inventory
1164
to_abs = self.abspath(to_dir)
1165
if not isdir(to_abs):
1166
raise errors.BzrMoveFailedError('',to_dir,
1167
errors.NotADirectory(to_abs))
1168
if not self.has_filename(to_dir):
1169
raise errors.BzrMoveFailedError('',to_dir,
1170
errors.NotInWorkingDirectory(to_dir))
1171
to_dir_id = inv.path2id(to_dir)
1172
if to_dir_id is None:
1173
raise errors.BzrMoveFailedError('',to_dir,
1174
errors.NotVersionedError(path=str(to_dir)))
1176
to_dir_ie = inv[to_dir_id]
1177
if to_dir_ie.kind != 'directory':
1178
raise errors.BzrMoveFailedError('',to_dir,
1179
errors.NotADirectory(to_abs))
1181
# create rename entries and tuples
1182
for from_rel in from_paths:
1183
from_tail = splitpath(from_rel)[-1]
1184
from_id = inv.path2id(from_rel)
1186
raise errors.BzrMoveFailedError(from_rel,to_dir,
1187
errors.NotVersionedError(path=str(from_rel)))
1189
from_entry = inv[from_id]
1190
from_parent_id = from_entry.parent_id
1191
to_rel = pathjoin(to_dir, from_tail)
1192
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1194
from_tail=from_tail,
1195
from_parent_id=from_parent_id,
1196
to_rel=to_rel, to_tail=from_tail,
1197
to_parent_id=to_dir_id)
1198
rename_entries.append(rename_entry)
1199
rename_tuples.append((from_rel, to_rel))
1201
# determine which move mode to use. checks also for movability
1202
rename_entries = self._determine_mv_mode(rename_entries, after)
1204
original_modified = self._inventory_is_modified
1207
self._inventory_is_modified = True
1208
self._move(rename_entries)
1210
# restore the inventory on error
1211
self._inventory_is_modified = original_modified
1213
self._write_inventory(inv)
1214
return rename_tuples
1216
def _determine_mv_mode(self, rename_entries, after=False):
1217
"""Determines for each from-to pair if both inventory and working tree
1218
or only the inventory has to be changed.
1220
Also does basic plausability tests.
1222
inv = self.inventory
1224
for rename_entry in rename_entries:
1225
# store to local variables for easier reference
1226
from_rel = rename_entry.from_rel
1227
from_id = rename_entry.from_id
1228
to_rel = rename_entry.to_rel
1229
to_id = inv.path2id(to_rel)
1230
only_change_inv = False
1232
# check the inventory for source and destination
1234
raise errors.BzrMoveFailedError(from_rel,to_rel,
1235
errors.NotVersionedError(path=str(from_rel)))
1236
if to_id is not None:
1237
raise errors.BzrMoveFailedError(from_rel,to_rel,
1238
errors.AlreadyVersionedError(path=str(to_rel)))
1240
# try to determine the mode for rename (only change inv or change
1241
# inv and file system)
1243
if not self.has_filename(to_rel):
1244
raise errors.BzrMoveFailedError(from_id,to_rel,
1245
errors.NoSuchFile(path=str(to_rel),
1246
extra="New file has not been created yet"))
1247
only_change_inv = True
1248
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1249
only_change_inv = True
1250
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1251
only_change_inv = False
1253
# something is wrong, so lets determine what exactly
1254
if not self.has_filename(from_rel) and \
1255
not self.has_filename(to_rel):
1256
raise errors.BzrRenameFailedError(from_rel,to_rel,
1257
errors.PathsDoNotExist(paths=(str(from_rel),
1260
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1261
extra="(Use --after to update the Bazaar id)")
1262
rename_entry.only_change_inv = only_change_inv
1263
return rename_entries
1265
def _move(self, rename_entries):
1266
"""Moves a list of files.
1268
Depending on the value of the flag 'only_change_inv', the
1269
file will be moved on the file system or not.
1271
inv = self.inventory
1274
for entry in rename_entries:
1276
self._move_entry(entry)
1278
self._rollback_move(moved)
1282
def _rollback_move(self, moved):
1283
"""Try to rollback a previous move in case of an filesystem error."""
1284
inv = self.inventory
1287
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1288
entry.to_tail, entry.to_parent_id, entry.from_rel,
1289
entry.from_tail, entry.from_parent_id,
1290
entry.only_change_inv))
1291
except errors.BzrMoveFailedError, e:
1292
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1293
" The working tree is in an inconsistent state."
1294
" Please consider doing a 'bzr revert'."
1295
" Error message is: %s" % e)
1297
def _move_entry(self, entry):
1298
inv = self.inventory
1299
from_rel_abs = self.abspath(entry.from_rel)
1300
to_rel_abs = self.abspath(entry.to_rel)
1301
if from_rel_abs == to_rel_abs:
1302
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1303
"Source and target are identical.")
1305
if not entry.only_change_inv:
1307
osutils.rename(from_rel_abs, to_rel_abs)
1309
raise errors.BzrMoveFailedError(entry.from_rel,
1311
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1313
@needs_tree_write_lock
1314
def rename_one(self, from_rel, to_rel, after=False):
1317
This can change the directory or the filename or both.
1319
rename_one has several 'modes' to work. First, it can rename a physical
1320
file and change the file_id. That is the normal mode. Second, it can
1321
only change the file_id without touching any physical file. This is
1322
the new mode introduced in version 0.15.
1324
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1325
versioned but present in the working tree.
1327
rename_one uses the second mode if 'after == False' and 'from_rel' is
1328
versioned but no longer in the working tree, and 'to_rel' is not
1329
versioned but present in the working tree.
1331
rename_one uses the first mode if 'after == False' and 'from_rel' is
1332
versioned and present in the working tree, and 'to_rel' is not
1333
versioned and not present in the working tree.
1335
Everything else results in an error.
1337
inv = self.inventory
1340
# create rename entries and tuples
1341
from_tail = splitpath(from_rel)[-1]
1342
from_id = inv.path2id(from_rel)
1344
raise errors.BzrRenameFailedError(from_rel,to_rel,
1345
errors.NotVersionedError(path=str(from_rel)))
1346
from_entry = inv[from_id]
1347
from_parent_id = from_entry.parent_id
1348
to_dir, to_tail = os.path.split(to_rel)
1349
to_dir_id = inv.path2id(to_dir)
1350
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1352
from_tail=from_tail,
1353
from_parent_id=from_parent_id,
1354
to_rel=to_rel, to_tail=to_tail,
1355
to_parent_id=to_dir_id)
1356
rename_entries.append(rename_entry)
1358
# determine which move mode to use. checks also for movability
1359
rename_entries = self._determine_mv_mode(rename_entries, after)
1361
# check if the target changed directory and if the target directory is
1363
if to_dir_id is None:
1364
raise errors.BzrMoveFailedError(from_rel,to_rel,
1365
errors.NotVersionedError(path=str(to_dir)))
1367
# all checks done. now we can continue with our actual work
1368
mutter('rename_one:\n'
1373
' to_dir_id {%s}\n',
1374
from_id, from_rel, to_rel, to_dir, to_dir_id)
1376
self._move(rename_entries)
1377
self._write_inventory(inv)
1379
class _RenameEntry(object):
1380
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1381
to_rel, to_tail, to_parent_id, only_change_inv=False):
1382
self.from_rel = from_rel
1383
self.from_id = from_id
1384
self.from_tail = from_tail
1385
self.from_parent_id = from_parent_id
1386
self.to_rel = to_rel
1387
self.to_tail = to_tail
1388
self.to_parent_id = to_parent_id
1389
self.only_change_inv = only_change_inv
1393
"""Return all unknown files.
1395
These are files in the working directory that are not versioned or
1396
control files or ignored.
1398
# force the extras method to be fully executed before returning, to
1399
# prevent race conditions with the lock
1401
[subp for subp in self.extras() if not self.is_ignored(subp)])
1403
@needs_tree_write_lock
1404
def unversion(self, file_ids):
1405
"""Remove the file ids in file_ids from the current versioned set.
1407
When a file_id is unversioned, all of its children are automatically
1410
:param file_ids: The file ids to stop versioning.
1411
:raises: NoSuchId if any fileid is not currently versioned.
1413
for file_id in file_ids:
1414
if self._inventory.has_id(file_id):
1415
self._inventory.remove_recursive_id(file_id)
1417
raise errors.NoSuchId(self, file_id)
1419
# in the future this should just set a dirty bit to wait for the
1420
# final unlock. However, until all methods of workingtree start
1421
# with the current in -memory inventory rather than triggering
1422
# a read, it is more complex - we need to teach read_inventory
1423
# to know when to read, and when to not read first... and possibly
1424
# to save first when the in memory one may be corrupted.
1425
# so for now, we just only write it if it is indeed dirty.
1427
self._write_inventory(self._inventory)
1429
@deprecated_method(zero_eight)
1430
def iter_conflicts(self):
1431
"""List all files in the tree that have text or content conflicts.
1432
DEPRECATED. Use conflicts instead."""
1433
return self._iter_conflicts()
1435
def _iter_conflicts(self):
1437
for info in self.list_files():
1439
stem = get_conflicted_stem(path)
1442
if stem not in conflicted:
1443
conflicted.add(stem)
1447
def pull(self, source, overwrite=False, stop_revision=None,
1448
change_reporter=None):
1449
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1452
pp = ProgressPhase("Pull phase", 2, top_pb)
1454
old_revision_info = self.branch.last_revision_info()
1455
basis_tree = self.basis_tree()
1456
count = self.branch.pull(source, overwrite, stop_revision)
1457
new_revision_info = self.branch.last_revision_info()
1458
if new_revision_info != old_revision_info:
1460
repository = self.branch.repository
1461
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1462
basis_tree.lock_read()
1464
new_basis_tree = self.branch.basis_tree()
1471
change_reporter=change_reporter)
1472
if (basis_tree.inventory.root is None and
1473
new_basis_tree.inventory.root is not None):
1474
self.set_root_id(new_basis_tree.inventory.root.file_id)
1478
# TODO - dedup parents list with things merged by pull ?
1479
# reuse the revisiontree we merged against to set the new
1481
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1482
# we have to pull the merge trees out again, because
1483
# merge_inner has set the ids. - this corner is not yet
1484
# layered well enough to prevent double handling.
1485
# XXX TODO: Fix the double handling: telling the tree about
1486
# the already known parent data is wasteful.
1487
merges = self.get_parent_ids()[1:]
1488
parent_trees.extend([
1489
(parent, repository.revision_tree(parent)) for
1491
self.set_parent_trees(parent_trees)
1498
def put_file_bytes_non_atomic(self, file_id, bytes):
1499
"""See MutableTree.put_file_bytes_non_atomic."""
1500
stream = file(self.id2abspath(file_id), 'wb')
1505
# TODO: update the hashcache here ?
1508
"""Yield all unversioned files in this WorkingTree.
1510
If there are any unversioned directories then only the directory is
1511
returned, not all its children. But if there are unversioned files
1512
under a versioned subdirectory, they are returned.
1514
Currently returned depth-first, sorted by name within directories.
1515
This is the same order used by 'osutils.walkdirs'.
1517
## TODO: Work from given directory downwards
1518
for path, dir_entry in self.inventory.directories():
1519
# mutter("search for unknowns in %r", path)
1520
dirabs = self.abspath(path)
1521
if not isdir(dirabs):
1522
# e.g. directory deleted
1526
for subf in os.listdir(dirabs):
1529
if subf not in dir_entry.children:
1530
subf_norm, can_access = osutils.normalized_filename(subf)
1531
if subf_norm != subf and can_access:
1532
if subf_norm not in dir_entry.children:
1533
fl.append(subf_norm)
1539
subp = pathjoin(path, subf)
1542
def ignored_files(self):
1543
"""Yield list of PATH, IGNORE_PATTERN"""
1544
for subp in self.extras():
1545
pat = self.is_ignored(subp)
1549
def get_ignore_list(self):
1550
"""Return list of ignore patterns.
1552
Cached in the Tree object after the first call.
1554
ignoreset = getattr(self, '_ignoreset', None)
1555
if ignoreset is not None:
1558
ignore_globs = set()
1559
ignore_globs.update(ignores.get_runtime_ignores())
1560
ignore_globs.update(ignores.get_user_ignores())
1561
if self.has_filename(bzrlib.IGNORE_FILENAME):
1562
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1564
ignore_globs.update(ignores.parse_ignore_file(f))
1567
self._ignoreset = ignore_globs
1570
def _flush_ignore_list_cache(self):
1571
"""Resets the cached ignore list to force a cache rebuild."""
1572
self._ignoreset = None
1573
self._ignoreglobster = None
1575
def is_ignored(self, filename):
1576
r"""Check whether the filename matches an ignore pattern.
1578
Patterns containing '/' or '\' need to match the whole path;
1579
others match against only the last component.
1581
If the file is ignored, returns the pattern which caused it to
1582
be ignored, otherwise None. So this can simply be used as a
1583
boolean if desired."""
1584
if getattr(self, '_ignoreglobster', None) is None:
1585
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1586
return self._ignoreglobster.match(filename)
1588
def kind(self, file_id):
1589
return file_kind(self.id2abspath(file_id))
1591
def _comparison_data(self, entry, path):
1592
abspath = self.abspath(path)
1594
stat_value = os.lstat(abspath)
1596
if getattr(e, 'errno', None) == errno.ENOENT:
1603
mode = stat_value.st_mode
1604
kind = osutils.file_kind_from_stat_mode(mode)
1605
if not supports_executable():
1606
executable = entry is not None and entry.executable
1608
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1609
return kind, executable, stat_value
1611
def _file_size(self, entry, stat_value):
1612
return stat_value.st_size
1614
def last_revision(self):
1615
"""Return the last revision of the branch for this tree.
1617
This format tree does not support a separate marker for last-revision
1618
compared to the branch.
1620
See MutableTree.last_revision
1622
return self._last_revision()
1625
def _last_revision(self):
1626
"""helper for get_parent_ids."""
1627
return _mod_revision.ensure_null(self.branch.last_revision())
1629
def is_locked(self):
1630
return self._control_files.is_locked()
1632
def _must_be_locked(self):
1633
if not self.is_locked():
1634
raise errors.ObjectNotLocked(self)
1636
def lock_read(self):
1637
"""See Branch.lock_read, and WorkingTree.unlock."""
1638
if not self.is_locked():
1640
self.branch.lock_read()
1642
return self._control_files.lock_read()
1644
self.branch.unlock()
1647
def lock_tree_write(self):
1648
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1649
if not self.is_locked():
1651
self.branch.lock_read()
1653
return self._control_files.lock_write()
1655
self.branch.unlock()
1658
def lock_write(self):
1659
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_write()
1664
return self._control_files.lock_write()
1666
self.branch.unlock()
1669
def get_physical_lock_status(self):
1670
return self._control_files.get_physical_lock_status()
1672
def _basis_inventory_name(self):
1673
return 'basis-inventory-cache'
1675
def _reset_data(self):
1676
"""Reset transient data that cannot be revalidated."""
1677
self._inventory_is_modified = False
1678
result = self._deserialize(self._control_files.get('inventory'))
1679
self._set_inventory(result, dirty=False)
1681
@needs_tree_write_lock
1682
def set_last_revision(self, new_revision):
1683
"""Change the last revision in the working tree."""
1684
if self._change_last_revision(new_revision):
1685
self._cache_basis_inventory(new_revision)
1687
def _change_last_revision(self, new_revision):
1688
"""Template method part of set_last_revision to perform the change.
1690
This is used to allow WorkingTree3 instances to not affect branch
1691
when their last revision is set.
1693
if _mod_revision.is_null(new_revision):
1694
self.branch.set_revision_history([])
1697
self.branch.generate_revision_history(new_revision)
1698
except errors.NoSuchRevision:
1699
# not present in the repo - dont try to set it deeper than the tip
1700
self.branch.set_revision_history([new_revision])
1703
def _write_basis_inventory(self, xml):
1704
"""Write the basis inventory XML to the basis-inventory file"""
1705
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1706
path = self._basis_inventory_name()
1708
self._control_files.put(path, sio)
1710
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1711
"""Create the text that will be saved in basis-inventory"""
1712
return xml7.serializer_v7.write_inventory_to_string(inventory)
1714
def _cache_basis_inventory(self, new_revision):
1715
"""Cache new_revision as the basis inventory."""
1716
# TODO: this should allow the ready-to-use inventory to be passed in,
1717
# as commit already has that ready-to-use [while the format is the
1720
# this double handles the inventory - unpack and repack -
1721
# but is easier to understand. We can/should put a conditional
1722
# in here based on whether the inventory is in the latest format
1723
# - perhaps we should repack all inventories on a repository
1725
# the fast path is to copy the raw xml from the repository. If the
1726
# xml contains 'revision_id="', then we assume the right
1727
# revision_id is set. We must check for this full string, because a
1728
# root node id can legitimately look like 'revision_id' but cannot
1730
xml = self.branch.repository.get_inventory_xml(new_revision)
1731
firstline = xml.split('\n', 1)[0]
1732
if (not 'revision_id="' in firstline or
1733
'format="7"' not in firstline):
1734
inv = self.branch.repository.deserialise_inventory(
1736
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1737
self._write_basis_inventory(xml)
1738
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1741
def read_basis_inventory(self):
1742
"""Read the cached basis inventory."""
1743
path = self._basis_inventory_name()
1744
return self._control_files.get(path).read()
1747
def read_working_inventory(self):
1748
"""Read the working inventory.
1750
:raises errors.InventoryModified: read_working_inventory will fail
1751
when the current in memory inventory has been modified.
1753
# conceptually this should be an implementation detail of the tree.
1754
# XXX: Deprecate this.
1755
# ElementTree does its own conversion from UTF-8, so open in
1757
if self._inventory_is_modified:
1758
raise errors.InventoryModified(self)
1759
result = self._deserialize(self._control_files.get('inventory'))
1760
self._set_inventory(result, dirty=False)
1763
@needs_tree_write_lock
1764
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1766
"""Remove nominated files from the working inventory.
1768
:files: File paths relative to the basedir.
1769
:keep_files: If true, the files will also be kept.
1770
:force: Delete files and directories, even if they are changed and
1771
even if the directories are not empty.
1773
if isinstance(files, basestring):
1779
unknown_nested_files=set()
1781
def recurse_directory_to_add_files(directory):
1782
# Recurse directory and add all files
1783
# so we can check if they have changed.
1784
for parent_info, file_infos in\
1785
osutils.walkdirs(self.abspath(directory),
1787
for relpath, basename, kind, lstat, abspath in file_infos:
1788
# Is it versioned or ignored?
1789
if self.path2id(relpath) or self.is_ignored(relpath):
1790
# Add nested content for deletion.
1791
new_files.add(relpath)
1793
# Files which are not versioned and not ignored
1794
# should be treated as unknown.
1795
unknown_nested_files.add((relpath, None, kind))
1797
for filename in files:
1798
# Get file name into canonical form.
1799
abspath = self.abspath(filename)
1800
filename = self.relpath(abspath)
1801
if len(filename) > 0:
1802
new_files.add(filename)
1803
if osutils.isdir(abspath):
1804
recurse_directory_to_add_files(filename)
1806
files = list(new_files)
1809
return # nothing to do
1811
# Sort needed to first handle directory content before the directory
1812
files.sort(reverse=True)
1814
# Bail out if we are going to delete files we shouldn't
1815
if not keep_files and not force:
1816
has_changed_files = len(unknown_nested_files) > 0
1817
if not has_changed_files:
1818
for (file_id, path, content_change, versioned, parent_id, name,
1819
kind, executable) in self._iter_changes(self.basis_tree(),
1820
include_unchanged=True, require_versioned=False,
1821
want_unversioned=True, specific_files=files):
1822
# Check if it's an unknown (but not ignored) OR
1823
# changed (but not deleted) :
1824
if not self.is_ignored(path[1]) and (
1825
versioned == (False, False) or
1826
content_change and kind[1] != None):
1827
has_changed_files = True
1830
if has_changed_files:
1831
# Make delta show ALL applicable changes in error message.
1832
tree_delta = self.changes_from(self.basis_tree(),
1833
require_versioned=False, want_unversioned=True,
1834
specific_files=files)
1835
for unknown_file in unknown_nested_files:
1836
if unknown_file not in tree_delta.unversioned:
1837
tree_delta.unversioned.extend((unknown_file,))
1838
raise errors.BzrRemoveChangedFilesError(tree_delta)
1840
# Build inv_delta and delete files where applicaple,
1841
# do this before any modifications to inventory.
1843
fid = self.path2id(f)
1846
message = "%s is not versioned." % (f,)
1849
# having removed it, it must be either ignored or unknown
1850
if self.is_ignored(f):
1854
textui.show_status(new_status, self.kind(fid), f,
1857
inv_delta.append((f, None, fid, None))
1858
message = "removed %s" % (f,)
1861
abs_path = self.abspath(f)
1862
if osutils.lexists(abs_path):
1863
if (osutils.isdir(abs_path) and
1864
len(os.listdir(abs_path)) > 0):
1866
osutils.rmtree(abs_path)
1868
message = "%s is not an empty directory "\
1869
"and won't be deleted." % (f,)
1871
osutils.delete_any(abs_path)
1872
message = "deleted %s" % (f,)
1873
elif message is not None:
1874
# Only care if we haven't done anything yet.
1875
message = "%s does not exist." % (f,)
1877
# Print only one message (if any) per file.
1878
if message is not None:
1880
self.apply_inventory_delta(inv_delta)
1882
@needs_tree_write_lock
1883
def revert(self, filenames=None, old_tree=None, backups=True,
1884
pb=DummyProgress(), report_changes=False):
1885
from bzrlib.conflicts import resolve
1888
symbol_versioning.warn('Using [] to revert all files is deprecated'
1889
' as of bzr 0.91. Please use None (the default) instead.',
1890
DeprecationWarning, stacklevel=2)
1891
if old_tree is None:
1892
old_tree = self.basis_tree()
1893
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1895
if filenames is None:
1896
self.set_parent_ids(self.get_parent_ids()[:1])
1899
resolve(self, filenames, ignore_misses=True)
1902
def revision_tree(self, revision_id):
1903
"""See Tree.revision_tree.
1905
WorkingTree can supply revision_trees for the basis revision only
1906
because there is only one cached inventory in the bzr directory.
1908
if revision_id == self.last_revision():
1910
xml = self.read_basis_inventory()
1911
except errors.NoSuchFile:
1915
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1916
# dont use the repository revision_tree api because we want
1917
# to supply the inventory.
1918
if inv.revision_id == revision_id:
1919
return revisiontree.RevisionTree(self.branch.repository,
1921
except errors.BadInventoryFormat:
1923
# raise if there was no inventory, or if we read the wrong inventory.
1924
raise errors.NoSuchRevisionInTree(self, revision_id)
1926
# XXX: This method should be deprecated in favour of taking in a proper
1927
# new Inventory object.
1928
@needs_tree_write_lock
1929
def set_inventory(self, new_inventory_list):
1930
from bzrlib.inventory import (Inventory,
1935
inv = Inventory(self.get_root_id())
1936
for path, file_id, parent, kind in new_inventory_list:
1937
name = os.path.basename(path)
1940
# fixme, there should be a factory function inv,add_??
1941
if kind == 'directory':
1942
inv.add(InventoryDirectory(file_id, name, parent))
1943
elif kind == 'file':
1944
inv.add(InventoryFile(file_id, name, parent))
1945
elif kind == 'symlink':
1946
inv.add(InventoryLink(file_id, name, parent))
1948
raise errors.BzrError("unknown kind %r" % kind)
1949
self._write_inventory(inv)
1951
@needs_tree_write_lock
1952
def set_root_id(self, file_id):
1953
"""Set the root id for this tree."""
1954
self._set_root_id(file_id)
1956
def _set_root_id(self, file_id):
1957
"""Set the root id for this tree, in a format specific manner.
1959
:param file_id: The file id to assign to the root. It must not be
1960
present in the current inventory or an error will occur. It must
1961
not be None, but rather a valid file id.
1963
inv = self._inventory
1964
orig_root_id = inv.root.file_id
1965
# TODO: it might be nice to exit early if there was nothing
1966
# to do, saving us from trigger a sync on unlock.
1967
self._inventory_is_modified = True
1968
# we preserve the root inventory entry object, but
1969
# unlinkit from the byid index
1970
del inv._byid[inv.root.file_id]
1971
inv.root.file_id = file_id
1972
# and link it into the index with the new changed id.
1973
inv._byid[inv.root.file_id] = inv.root
1974
# and finally update all children to reference the new id.
1975
# XXX: this should be safe to just look at the root.children
1976
# list, not the WHOLE INVENTORY.
1979
if entry.parent_id == orig_root_id:
1980
entry.parent_id = inv.root.file_id
1983
"""See Branch.unlock.
1985
WorkingTree locking just uses the Branch locking facilities.
1986
This is current because all working trees have an embedded branch
1987
within them. IF in the future, we were to make branch data shareable
1988
between multiple working trees, i.e. via shared storage, then we
1989
would probably want to lock both the local tree, and the branch.
1991
raise NotImplementedError(self.unlock)
1993
def update(self, change_reporter=None, possible_transports=None):
1994
"""Update a working tree along its branch.
1996
This will update the branch if its bound too, which means we have
1997
multiple trees involved:
1999
- The new basis tree of the master.
2000
- The old basis tree of the branch.
2001
- The old basis tree of the working tree.
2002
- The current working tree state.
2004
Pathologically, all three may be different, and non-ancestors of each
2005
other. Conceptually we want to:
2007
- Preserve the wt.basis->wt.state changes
2008
- Transform the wt.basis to the new master basis.
2009
- Apply a merge of the old branch basis to get any 'local' changes from
2011
- Restore the wt.basis->wt.state changes.
2013
There isn't a single operation at the moment to do that, so we:
2014
- Merge current state -> basis tree of the master w.r.t. the old tree
2016
- Do a 'normal' merge of the old branch basis if it is relevant.
2018
if self.branch.get_master_branch(possible_transports) is not None:
2020
update_branch = True
2022
self.lock_tree_write()
2023
update_branch = False
2026
old_tip = self.branch.update(possible_transports)
2029
return self._update_tree(old_tip, change_reporter)
2033
@needs_tree_write_lock
2034
def _update_tree(self, old_tip=None, change_reporter=None):
2035
"""Update a tree to the master branch.
2037
:param old_tip: if supplied, the previous tip revision the branch,
2038
before it was changed to the master branch's tip.
2040
# here if old_tip is not None, it is the old tip of the branch before
2041
# it was updated from the master branch. This should become a pending
2042
# merge in the working tree to preserve the user existing work. we
2043
# cant set that until we update the working trees last revision to be
2044
# one from the new branch, because it will just get absorbed by the
2045
# parent de-duplication logic.
2047
# We MUST save it even if an error occurs, because otherwise the users
2048
# local work is unreferenced and will appear to have been lost.
2052
last_rev = self.get_parent_ids()[0]
2054
last_rev = _mod_revision.NULL_REVISION
2055
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2056
# merge tree state up to new branch tip.
2057
basis = self.basis_tree()
2060
to_tree = self.branch.basis_tree()
2061
if basis.inventory.root is None:
2062
self.set_root_id(to_tree.inventory.root.file_id)
2064
result += merge.merge_inner(
2069
change_reporter=change_reporter)
2072
# TODO - dedup parents list with things merged by pull ?
2073
# reuse the tree we've updated to to set the basis:
2074
parent_trees = [(self.branch.last_revision(), to_tree)]
2075
merges = self.get_parent_ids()[1:]
2076
# Ideally we ask the tree for the trees here, that way the working
2077
# tree can decide whether to give us teh entire tree or give us a
2078
# lazy initialised tree. dirstate for instance will have the trees
2079
# in ram already, whereas a last-revision + basis-inventory tree
2080
# will not, but also does not need them when setting parents.
2081
for parent in merges:
2082
parent_trees.append(
2083
(parent, self.branch.repository.revision_tree(parent)))
2084
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2085
parent_trees.append(
2086
(old_tip, self.branch.repository.revision_tree(old_tip)))
2087
self.set_parent_trees(parent_trees)
2088
last_rev = parent_trees[0][0]
2090
# the working tree had the same last-revision as the master
2091
# branch did. We may still have pivot local work from the local
2092
# branch into old_tip:
2093
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2094
self.add_parent_tree_id(old_tip)
2095
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2096
and old_tip != last_rev):
2097
# our last revision was not the prior branch last revision
2098
# and we have converted that last revision to a pending merge.
2099
# base is somewhere between the branch tip now
2100
# and the now pending merge
2102
# Since we just modified the working tree and inventory, flush out
2103
# the current state, before we modify it again.
2104
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2105
# requires it only because TreeTransform directly munges the
2106
# inventory and calls tree._write_inventory(). Ultimately we
2107
# should be able to remove this extra flush.
2109
graph = self.branch.repository.get_graph()
2110
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2112
base_tree = self.branch.repository.revision_tree(base_rev_id)
2113
other_tree = self.branch.repository.revision_tree(old_tip)
2114
result += merge.merge_inner(
2119
change_reporter=change_reporter)
2122
def _write_hashcache_if_dirty(self):
2123
"""Write out the hashcache if it is dirty."""
2124
if self._hashcache.needs_write:
2126
self._hashcache.write()
2128
if e.errno not in (errno.EPERM, errno.EACCES):
2130
# TODO: jam 20061219 Should this be a warning? A single line
2131
# warning might be sufficient to let the user know what
2133
mutter('Could not write hashcache for %s\nError: %s',
2134
self._hashcache.cache_file_name(), e)
2136
@needs_tree_write_lock
2137
def _write_inventory(self, inv):
2138
"""Write inventory as the current inventory."""
2139
self._set_inventory(inv, dirty=True)
2142
def set_conflicts(self, arg):
2143
raise errors.UnsupportedOperation(self.set_conflicts, self)
2145
def add_conflicts(self, arg):
2146
raise errors.UnsupportedOperation(self.add_conflicts, self)
2149
def conflicts(self):
2150
conflicts = _mod_conflicts.ConflictList()
2151
for conflicted in self._iter_conflicts():
2154
if file_kind(self.abspath(conflicted)) != "file":
2156
except errors.NoSuchFile:
2159
for suffix in ('.THIS', '.OTHER'):
2161
kind = file_kind(self.abspath(conflicted+suffix))
2164
except errors.NoSuchFile:
2168
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2169
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2171
file_id=self.path2id(conflicted)))
2174
def walkdirs(self, prefix=""):
2175
"""Walk the directories of this tree.
2177
returns a generator which yields items in the form:
2178
((curren_directory_path, fileid),
2179
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2182
This API returns a generator, which is only valid during the current
2183
tree transaction - within a single lock_read or lock_write duration.
2185
If the tree is not locked, it may cause an error to be raised,
2186
depending on the tree implementation.
2188
disk_top = self.abspath(prefix)
2189
if disk_top.endswith('/'):
2190
disk_top = disk_top[:-1]
2191
top_strip_len = len(disk_top) + 1
2192
inventory_iterator = self._walkdirs(prefix)
2193
disk_iterator = osutils.walkdirs(disk_top, prefix)
2195
current_disk = disk_iterator.next()
2196
disk_finished = False
2198
if not (e.errno == errno.ENOENT or
2199
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2202
disk_finished = True
2204
current_inv = inventory_iterator.next()
2205
inv_finished = False
2206
except StopIteration:
2209
while not inv_finished or not disk_finished:
2210
if not disk_finished:
2211
# strip out .bzr dirs
2212
if current_disk[0][1][top_strip_len:] == '':
2213
# osutils.walkdirs can be made nicer -
2214
# yield the path-from-prefix rather than the pathjoined
2216
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2217
if current_disk[1][bzrdir_loc][0] == '.bzr':
2218
# we dont yield the contents of, or, .bzr itself.
2219
del current_disk[1][bzrdir_loc]
2221
# everything is unknown
2224
# everything is missing
2227
direction = cmp(current_inv[0][0], current_disk[0][0])
2229
# disk is before inventory - unknown
2230
dirblock = [(relpath, basename, kind, stat, None, None) for
2231
relpath, basename, kind, stat, top_path in current_disk[1]]
2232
yield (current_disk[0][0], None), dirblock
2234
current_disk = disk_iterator.next()
2235
except StopIteration:
2236
disk_finished = True
2238
# inventory is before disk - missing.
2239
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2240
for relpath, basename, dkind, stat, fileid, kind in
2242
yield (current_inv[0][0], current_inv[0][1]), dirblock
2244
current_inv = inventory_iterator.next()
2245
except StopIteration:
2248
# versioned present directory
2249
# merge the inventory and disk data together
2251
for relpath, subiterator in itertools.groupby(sorted(
2252
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2253
path_elements = list(subiterator)
2254
if len(path_elements) == 2:
2255
inv_row, disk_row = path_elements
2256
# versioned, present file
2257
dirblock.append((inv_row[0],
2258
inv_row[1], disk_row[2],
2259
disk_row[3], inv_row[4],
2261
elif len(path_elements[0]) == 5:
2263
dirblock.append((path_elements[0][0],
2264
path_elements[0][1], path_elements[0][2],
2265
path_elements[0][3], None, None))
2266
elif len(path_elements[0]) == 6:
2267
# versioned, absent file.
2268
dirblock.append((path_elements[0][0],
2269
path_elements[0][1], 'unknown', None,
2270
path_elements[0][4], path_elements[0][5]))
2272
raise NotImplementedError('unreachable code')
2273
yield current_inv[0], dirblock
2275
current_inv = inventory_iterator.next()
2276
except StopIteration:
2279
current_disk = disk_iterator.next()
2280
except StopIteration:
2281
disk_finished = True
2283
def _walkdirs(self, prefix=""):
2284
"""Walk the directories of this tree.
2286
:prefix: is used as the directrory to start with.
2287
returns a generator which yields items in the form:
2288
((curren_directory_path, fileid),
2289
[(file1_path, file1_name, file1_kind, None, file1_id,
2292
_directory = 'directory'
2293
# get the root in the inventory
2294
inv = self.inventory
2295
top_id = inv.path2id(prefix)
2299
pending = [(prefix, '', _directory, None, top_id, None)]
2302
currentdir = pending.pop()
2303
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2304
top_id = currentdir[4]
2306
relroot = currentdir[0] + '/'
2309
# FIXME: stash the node in pending
2311
for name, child in entry.sorted_children():
2312
dirblock.append((relroot + name, name, child.kind, None,
2313
child.file_id, child.kind
2315
yield (currentdir[0], entry.file_id), dirblock
2316
# push the user specified dirs from dirblock
2317
for dir in reversed(dirblock):
2318
if dir[2] == _directory:
2321
@needs_tree_write_lock
2322
def auto_resolve(self):
2323
"""Automatically resolve text conflicts according to contents.
2325
Only text conflicts are auto_resolvable. Files with no conflict markers
2326
are considered 'resolved', because bzr always puts conflict markers
2327
into files that have text conflicts. The corresponding .THIS .BASE and
2328
.OTHER files are deleted, as per 'resolve'.
2329
:return: a tuple of ConflictLists: (un_resolved, resolved).
2331
un_resolved = _mod_conflicts.ConflictList()
2332
resolved = _mod_conflicts.ConflictList()
2333
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2334
for conflict in self.conflicts():
2335
if (conflict.typestring != 'text conflict' or
2336
self.kind(conflict.file_id) != 'file'):
2337
un_resolved.append(conflict)
2339
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2341
for line in my_file:
2342
if conflict_re.search(line):
2343
un_resolved.append(conflict)
2346
resolved.append(conflict)
2349
resolved.remove_files(self)
2350
self.set_conflicts(un_resolved)
2351
return un_resolved, resolved
2353
def _validate(self):
2354
"""Validate internal structures.
2356
This is meant mostly for the test suite. To give it a chance to detect
2357
corruption after actions have occurred. The default implementation is a
2360
:return: None. An exception should be raised if there is an error.
2365
class WorkingTree2(WorkingTree):
2366
"""This is the Format 2 working tree.
2368
This was the first weave based working tree.
2369
- uses os locks for locking.
2370
- uses the branch last-revision.
2373
def __init__(self, *args, **kwargs):
2374
super(WorkingTree2, self).__init__(*args, **kwargs)
2375
# WorkingTree2 has more of a constraint that self._inventory must
2376
# exist. Because this is an older format, we don't mind the overhead
2377
# caused by the extra computation here.
2379
# Newer WorkingTree's should only have self._inventory set when they
2381
if self._inventory is None:
2382
self.read_working_inventory()
2384
def lock_tree_write(self):
2385
"""See WorkingTree.lock_tree_write().
2387
In Format2 WorkingTrees we have a single lock for the branch and tree
2388
so lock_tree_write() degrades to lock_write().
2390
self.branch.lock_write()
2392
return self._control_files.lock_write()
2394
self.branch.unlock()
2398
# do non-implementation specific cleanup
2401
# we share control files:
2402
if self._control_files._lock_count == 3:
2403
# _inventory_is_modified is always False during a read lock.
2404
if self._inventory_is_modified:
2406
self._write_hashcache_if_dirty()
2408
# reverse order of locking.
2410
return self._control_files.unlock()
2412
self.branch.unlock()
2415
class WorkingTree3(WorkingTree):
2416
"""This is the Format 3 working tree.
2418
This differs from the base WorkingTree by:
2419
- having its own file lock
2420
- having its own last-revision property.
2422
This is new in bzr 0.8
2426
def _last_revision(self):
2427
"""See Mutable.last_revision."""
2429
return self._control_files.get('last-revision').read()
2430
except errors.NoSuchFile:
2431
return _mod_revision.NULL_REVISION
2433
def _change_last_revision(self, revision_id):
2434
"""See WorkingTree._change_last_revision."""
2435
if revision_id is None or revision_id == NULL_REVISION:
2437
self._control_files._transport.delete('last-revision')
2438
except errors.NoSuchFile:
2442
self._control_files.put_bytes('last-revision', revision_id)
2445
@needs_tree_write_lock
2446
def set_conflicts(self, conflicts):
2447
self._put_rio('conflicts', conflicts.to_stanzas(),
2450
@needs_tree_write_lock
2451
def add_conflicts(self, new_conflicts):
2452
conflict_set = set(self.conflicts())
2453
conflict_set.update(set(list(new_conflicts)))
2454
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2455
key=_mod_conflicts.Conflict.sort_key)))
2458
def conflicts(self):
2460
confile = self._control_files.get('conflicts')
2461
except errors.NoSuchFile:
2462
return _mod_conflicts.ConflictList()
2464
if confile.next() != CONFLICT_HEADER_1 + '\n':
2465
raise errors.ConflictFormatError()
2466
except StopIteration:
2467
raise errors.ConflictFormatError()
2468
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2471
# do non-implementation specific cleanup
2473
if self._control_files._lock_count == 1:
2474
# _inventory_is_modified is always False during a read lock.
2475
if self._inventory_is_modified:
2477
self._write_hashcache_if_dirty()
2478
# reverse order of locking.
2480
return self._control_files.unlock()
2482
self.branch.unlock()
2485
def get_conflicted_stem(path):
2486
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2487
if path.endswith(suffix):
2488
return path[:-len(suffix)]
2491
@deprecated_function(zero_eight)
2492
def is_control_file(filename):
2493
"""See WorkingTree.is_control_filename(filename)."""
2494
## FIXME: better check
2495
filename = normpath(filename)
2496
while filename != '':
2497
head, tail = os.path.split(filename)
2498
## mutter('check %r for control file' % ((head, tail),))
2501
if filename == head:
2507
class WorkingTreeFormat(object):
2508
"""An encapsulation of the initialization and open routines for a format.
2510
Formats provide three things:
2511
* An initialization routine,
2515
Formats are placed in an dict by their format string for reference
2516
during workingtree opening. Its not required that these be instances, they
2517
can be classes themselves with class methods - it simply depends on
2518
whether state is needed for a given format or not.
2520
Once a format is deprecated, just deprecate the initialize and open
2521
methods on the format class. Do not deprecate the object, as the
2522
object will be created every time regardless.
2525
_default_format = None
2526
"""The default format used for new trees."""
2529
"""The known formats."""
2531
requires_rich_root = False
2533
upgrade_recommended = False
2536
def find_format(klass, a_bzrdir):
2537
"""Return the format for the working tree object in a_bzrdir."""
2539
transport = a_bzrdir.get_workingtree_transport(None)
2540
format_string = transport.get("format").read()
2541
return klass._formats[format_string]
2542
except errors.NoSuchFile:
2543
raise errors.NoWorkingTree(base=transport.base)
2545
raise errors.UnknownFormatError(format=format_string)
2547
def __eq__(self, other):
2548
return self.__class__ is other.__class__
2550
def __ne__(self, other):
2551
return not (self == other)
2554
def get_default_format(klass):
2555
"""Return the current default format."""
2556
return klass._default_format
2558
def get_format_string(self):
2559
"""Return the ASCII format string that identifies this format."""
2560
raise NotImplementedError(self.get_format_string)
2562
def get_format_description(self):
2563
"""Return the short description for this format."""
2564
raise NotImplementedError(self.get_format_description)
2566
def is_supported(self):
2567
"""Is this format supported?
2569
Supported formats can be initialized and opened.
2570
Unsupported formats may not support initialization or committing or
2571
some other features depending on the reason for not being supported.
2576
def register_format(klass, format):
2577
klass._formats[format.get_format_string()] = format
2580
def set_default_format(klass, format):
2581
klass._default_format = format
2584
def unregister_format(klass, format):
2585
assert klass._formats[format.get_format_string()] is format
2586
del klass._formats[format.get_format_string()]
2589
class WorkingTreeFormat2(WorkingTreeFormat):
2590
"""The second working tree format.
2592
This format modified the hash cache from the format 1 hash cache.
2595
upgrade_recommended = True
2597
def get_format_description(self):
2598
"""See WorkingTreeFormat.get_format_description()."""
2599
return "Working tree format 2"
2601
def stub_initialize_remote(self, control_files):
2602
"""As a special workaround create critical control files for a remote working tree
2604
This ensures that it can later be updated and dealt with locally,
2605
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2606
no working tree. (See bug #43064).
2610
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2612
control_files.put('inventory', sio)
2614
control_files.put_bytes('pending-merges', '')
2617
def initialize(self, a_bzrdir, revision_id=None):
2618
"""See WorkingTreeFormat.initialize()."""
2619
if not isinstance(a_bzrdir.transport, LocalTransport):
2620
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2621
branch = a_bzrdir.open_branch()
2622
if revision_id is None:
2623
revision_id = _mod_revision.ensure_null(branch.last_revision())
2626
branch.generate_revision_history(revision_id)
2630
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2636
basis_tree = branch.repository.revision_tree(revision_id)
2637
if basis_tree.inventory.root is not None:
2638
wt.set_root_id(basis_tree.inventory.root.file_id)
2639
# set the parent list and cache the basis tree.
2640
if _mod_revision.is_null(revision_id):
2643
parent_trees = [(revision_id, basis_tree)]
2644
wt.set_parent_trees(parent_trees)
2645
transform.build_tree(basis_tree, wt)
2649
super(WorkingTreeFormat2, self).__init__()
2650
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2652
def open(self, a_bzrdir, _found=False):
2653
"""Return the WorkingTree object for a_bzrdir
2655
_found is a private parameter, do not use it. It is used to indicate
2656
if format probing has already been done.
2659
# we are being called directly and must probe.
2660
raise NotImplementedError
2661
if not isinstance(a_bzrdir.transport, LocalTransport):
2662
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2663
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2669
class WorkingTreeFormat3(WorkingTreeFormat):
2670
"""The second working tree format updated to record a format marker.
2673
- exists within a metadir controlling .bzr
2674
- includes an explicit version marker for the workingtree control
2675
files, separate from the BzrDir format
2676
- modifies the hash cache format
2678
- uses a LockDir to guard access for writes.
2681
upgrade_recommended = True
2683
def get_format_string(self):
2684
"""See WorkingTreeFormat.get_format_string()."""
2685
return "Bazaar-NG Working Tree format 3"
2687
def get_format_description(self):
2688
"""See WorkingTreeFormat.get_format_description()."""
2689
return "Working tree format 3"
2691
_lock_file_name = 'lock'
2692
_lock_class = LockDir
2694
_tree_class = WorkingTree3
2696
def __get_matchingbzrdir(self):
2697
return bzrdir.BzrDirMetaFormat1()
2699
_matchingbzrdir = property(__get_matchingbzrdir)
2701
def _open_control_files(self, a_bzrdir):
2702
transport = a_bzrdir.get_workingtree_transport(None)
2703
return LockableFiles(transport, self._lock_file_name,
2706
def initialize(self, a_bzrdir, revision_id=None):
2707
"""See WorkingTreeFormat.initialize().
2709
revision_id allows creating a working tree at a different
2710
revision than the branch is at.
2712
if not isinstance(a_bzrdir.transport, LocalTransport):
2713
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2714
transport = a_bzrdir.get_workingtree_transport(self)
2715
control_files = self._open_control_files(a_bzrdir)
2716
control_files.create_lock()
2717
control_files.lock_write()
2718
control_files.put_utf8('format', self.get_format_string())
2719
branch = a_bzrdir.open_branch()
2720
if revision_id is None:
2721
revision_id = _mod_revision.ensure_null(branch.last_revision())
2722
# WorkingTree3 can handle an inventory which has a unique root id.
2723
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2724
# those trees. And because there isn't a format bump inbetween, we
2725
# are maintaining compatibility with older clients.
2726
# inv = Inventory(root_id=gen_root_id())
2727
inv = self._initial_inventory()
2728
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2734
_control_files=control_files)
2735
wt.lock_tree_write()
2737
basis_tree = branch.repository.revision_tree(revision_id)
2738
# only set an explicit root id if there is one to set.
2739
if basis_tree.inventory.root is not None:
2740
wt.set_root_id(basis_tree.inventory.root.file_id)
2741
if revision_id == NULL_REVISION:
2742
wt.set_parent_trees([])
2744
wt.set_parent_trees([(revision_id, basis_tree)])
2745
transform.build_tree(basis_tree, wt)
2747
# Unlock in this order so that the unlock-triggers-flush in
2748
# WorkingTree is given a chance to fire.
2749
control_files.unlock()
2753
def _initial_inventory(self):
2757
super(WorkingTreeFormat3, self).__init__()
2759
def open(self, a_bzrdir, _found=False):
2760
"""Return the WorkingTree object for a_bzrdir
2762
_found is a private parameter, do not use it. It is used to indicate
2763
if format probing has already been done.
2766
# we are being called directly and must probe.
2767
raise NotImplementedError
2768
if not isinstance(a_bzrdir.transport, LocalTransport):
2769
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2770
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2773
def _open(self, a_bzrdir, control_files):
2774
"""Open the tree itself.
2776
:param a_bzrdir: the dir for the tree.
2777
:param control_files: the control files for the tree.
2779
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2783
_control_files=control_files)
2786
return self.get_format_string()
2789
__default_format = WorkingTreeFormat4()
2790
WorkingTreeFormat.register_format(__default_format)
2791
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2792
WorkingTreeFormat.set_default_format(__default_format)
2793
# formats which have no format string are not discoverable
2794
# and not independently creatable, so are not registered.
2795
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
