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
@deprecated_method(zero_eight)
404
def create(branch, directory):
405
"""Create a workingtree for branch at directory.
407
If existing_directory already exists it must have a .bzr directory.
408
If it does not exist, it will be created.
410
This returns a new WorkingTree object for the new checkout.
412
TODO FIXME RBC 20060124 when we have checkout formats in place this
413
should accept an optional revisionid to checkout [and reject this if
414
checking out into the same dir as a pre-checkout-aware branch format.]
416
XXX: When BzrDir is present, these should be created through that
419
warnings.warn('delete WorkingTree.create', stacklevel=3)
420
transport = get_transport(directory)
421
if branch.bzrdir.root_transport.base == transport.base:
423
return branch.bzrdir.create_workingtree()
424
# different directory,
425
# create a branch reference
426
# and now a working tree.
427
raise NotImplementedError
430
@deprecated_method(zero_eight)
431
def create_standalone(directory):
432
"""Create a checkout and a branch and a repo at directory.
434
Directory must exist and be empty.
436
please use BzrDir.create_standalone_workingtree
438
return bzrdir.BzrDir.create_standalone_workingtree(directory)
440
def relpath(self, path):
441
"""Return the local path portion from a given path.
443
The path may be absolute or relative. If its a relative path it is
444
interpreted relative to the python current working directory.
446
return osutils.relpath(self.basedir, path)
448
def has_filename(self, filename):
449
return osutils.lexists(self.abspath(filename))
451
def get_file(self, file_id):
452
file_id = osutils.safe_file_id(file_id)
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_text(self, file_id):
456
file_id = osutils.safe_file_id(file_id)
457
return self.get_file(file_id).read()
459
def get_file_byname(self, filename):
460
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
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
file_id = osutils.safe_file_id(file_id)
474
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
478
require_versioned=True).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
500
def _get_ancestors(self, default_revision):
501
ancestors = set([default_revision])
502
for parent_id in self.get_parent_ids():
503
ancestors.update(self.branch.repository.get_ancestry(
504
parent_id, topo_sorted=False))
507
def get_parent_ids(self):
508
"""See Tree.get_parent_ids.
510
This implementation reads the pending merges list and last_revision
511
value and uses that to decide what the parents list should be.
513
last_rev = _mod_revision.ensure_null(self._last_revision())
514
if _mod_revision.NULL_REVISION == last_rev:
519
merges_file = self._control_files.get('pending-merges')
520
except errors.NoSuchFile:
523
for l in merges_file.readlines():
524
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
525
parents.append(revision_id)
529
def get_root_id(self):
530
"""Return the id of this trees root"""
531
return self._inventory.root.file_id
533
def _get_store_filename(self, file_id):
534
## XXX: badly named; this is not in the store at all
535
file_id = osutils.safe_file_id(file_id)
536
return self.abspath(self.id2path(file_id))
539
def clone(self, to_bzrdir, revision_id=None):
540
"""Duplicate this working tree into to_bzr, including all state.
542
Specifically modified files are kept as modified, but
543
ignored and unknown files are discarded.
545
If you want to make a new line of development, see bzrdir.sprout()
548
If not None, the cloned tree will have its last revision set to
549
revision, and and difference between the source trees last revision
550
and this one merged in.
552
# assumes the target bzr dir format is compatible.
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id)
558
def copy_content_into(self, tree, revision_id=None):
559
"""Copy the current content and user files of this tree into tree."""
560
tree.set_root_id(self.get_root_id())
561
if revision_id is None:
562
merge.transform_tree(tree, self)
564
# TODO now merge from tree.last_revision to revision (to preserve
565
# user local changes)
566
merge.transform_tree(tree, self)
567
tree.set_parent_ids([revision_id])
569
def id2abspath(self, file_id):
570
file_id = osutils.safe_file_id(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
575
file_id = osutils.safe_file_id(file_id)
577
if not inv.has_id(file_id):
579
path = inv.id2path(file_id)
580
return osutils.lexists(self.abspath(path))
582
def has_or_had_id(self, file_id):
583
file_id = osutils.safe_file_id(file_id)
584
if file_id == self.inventory.root.file_id:
586
return self.inventory.has_id(file_id)
588
__contains__ = has_id
590
def get_file_size(self, file_id):
591
file_id = osutils.safe_file_id(file_id)
592
return os.path.getsize(self.id2abspath(file_id))
595
def get_file_sha1(self, file_id, path=None, stat_value=None):
596
file_id = osutils.safe_file_id(file_id)
598
path = self._inventory.id2path(file_id)
599
return self._hashcache.get_sha1(path, stat_value)
601
def get_file_mtime(self, file_id, path=None):
602
file_id = osutils.safe_file_id(file_id)
604
path = self.inventory.id2path(file_id)
605
return os.lstat(self.abspath(path)).st_mtime
607
if not supports_executable():
608
def is_executable(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
610
return self._inventory[file_id].executable
612
def is_executable(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
615
path = self.id2path(file_id)
616
mode = os.lstat(self.abspath(path)).st_mode
617
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
619
@needs_tree_write_lock
620
def _add(self, files, ids, kinds):
621
"""See MutableTree._add."""
622
# TODO: Re-adding a file that is removed in the working copy
623
# should probably put it back with the previous ID.
624
# the read and write working inventory should not occur in this
625
# function - they should be part of lock_write and unlock.
627
for f, file_id, kind in zip(files, ids, kinds):
628
assert kind is not None
630
inv.add_path(f, kind=kind)
632
file_id = osutils.safe_file_id(file_id)
633
inv.add_path(f, kind=kind, file_id=file_id)
634
self._inventory_is_modified = True
636
@needs_tree_write_lock
637
def _gather_kinds(self, files, kinds):
638
"""See MutableTree._gather_kinds."""
639
for pos, f in enumerate(files):
640
if kinds[pos] is None:
641
fullpath = normpath(self.abspath(f))
643
kinds[pos] = file_kind(fullpath)
645
if e.errno == errno.ENOENT:
646
raise errors.NoSuchFile(fullpath)
649
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
650
"""Add revision_id as a parent.
652
This is equivalent to retrieving the current list of parent ids
653
and setting the list to its value plus revision_id.
655
:param revision_id: The revision id to add to the parent list. It may
656
be a ghost revision as long as its not the first parent to be added,
657
or the allow_leftmost_as_ghost parameter is set True.
658
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
660
parents = self.get_parent_ids() + [revision_id]
661
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
662
or allow_leftmost_as_ghost)
664
@needs_tree_write_lock
665
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
666
"""Add revision_id, tree tuple as a parent.
668
This is equivalent to retrieving the current list of parent trees
669
and setting the list to its value plus parent_tuple. See also
670
add_parent_tree_id - if you only have a parent id available it will be
671
simpler to use that api. If you have the parent already available, using
672
this api is preferred.
674
:param parent_tuple: The (revision id, tree) to add to the parent list.
675
If the revision_id is a ghost, pass None for the tree.
676
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
678
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
679
if len(parent_ids) > 1:
680
# the leftmost may have already been a ghost, preserve that if it
682
allow_leftmost_as_ghost = True
683
self.set_parent_ids(parent_ids,
684
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
686
@needs_tree_write_lock
687
def add_pending_merge(self, *revision_ids):
688
# TODO: Perhaps should check at this point that the
689
# history of the revision is actually present?
690
parents = self.get_parent_ids()
692
for rev_id in revision_ids:
693
if rev_id in parents:
695
parents.append(rev_id)
698
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
700
@deprecated_method(zero_eleven)
702
def pending_merges(self):
703
"""Return a list of pending merges.
705
These are revisions that have been merged into the working
706
directory but not yet committed.
708
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
709
instead - which is available on all tree objects.
711
return self.get_parent_ids()[1:]
713
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
714
"""Common ghost checking functionality from set_parent_*.
716
This checks that the left hand-parent exists if there are any
719
if len(revision_ids) > 0:
720
leftmost_id = revision_ids[0]
721
if (not allow_leftmost_as_ghost and not
722
self.branch.repository.has_revision(leftmost_id)):
723
raise errors.GhostRevisionUnusableHere(leftmost_id)
725
def _set_merges_from_parent_ids(self, parent_ids):
726
merges = parent_ids[1:]
727
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
729
@needs_tree_write_lock
730
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
731
"""Set the parent ids to revision_ids.
733
See also set_parent_trees. This api will try to retrieve the tree data
734
for each element of revision_ids from the trees repository. If you have
735
tree data already available, it is more efficient to use
736
set_parent_trees rather than set_parent_ids. set_parent_ids is however
737
an easier API to use.
739
:param revision_ids: The revision_ids to set as the parent ids of this
740
working tree. Any of these may be ghosts.
742
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
743
self._check_parents_for_ghosts(revision_ids,
744
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
745
for revision_id in revision_ids:
746
_mod_revision.check_not_reserved_id(revision_id)
748
if len(revision_ids) > 0:
749
self.set_last_revision(revision_ids[0])
751
self.set_last_revision(_mod_revision.NULL_REVISION)
753
self._set_merges_from_parent_ids(revision_ids)
755
@needs_tree_write_lock
756
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
757
"""See MutableTree.set_parent_trees."""
758
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
759
for revision_id in parent_ids:
760
_mod_revision.check_not_reserved_id(revision_id)
762
self._check_parents_for_ghosts(parent_ids,
763
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
765
if len(parent_ids) == 0:
766
leftmost_parent_id = _mod_revision.NULL_REVISION
767
leftmost_parent_tree = None
769
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
771
if self._change_last_revision(leftmost_parent_id):
772
if leftmost_parent_tree is None:
773
# If we don't have a tree, fall back to reading the
774
# parent tree from the repository.
775
self._cache_basis_inventory(leftmost_parent_id)
777
inv = leftmost_parent_tree.inventory
778
xml = self._create_basis_xml_from_inventory(
779
leftmost_parent_id, inv)
780
self._write_basis_inventory(xml)
781
self._set_merges_from_parent_ids(parent_ids)
783
@needs_tree_write_lock
784
def set_pending_merges(self, rev_list):
785
parents = self.get_parent_ids()
786
leftmost = parents[:1]
787
new_parents = leftmost + rev_list
788
self.set_parent_ids(new_parents)
790
@needs_tree_write_lock
791
def set_merge_modified(self, modified_hashes):
793
for file_id, hash in modified_hashes.iteritems():
794
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
795
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
797
def _put_rio(self, filename, stanzas, header):
798
self._must_be_locked()
799
my_file = rio_file(stanzas, header)
800
self._control_files.put(filename, my_file)
802
@needs_write_lock # because merge pulls data into the branch.
803
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
805
"""Merge from a branch into this working tree.
807
:param branch: The branch to merge from.
808
:param to_revision: If non-None, the merge will merge to to_revision,
809
but not beyond it. to_revision does not need to be in the history
810
of the branch when it is supplied. If None, to_revision defaults to
811
branch.last_revision().
813
from bzrlib.merge import Merger, Merge3Merger
814
pb = bzrlib.ui.ui_factory.nested_progress_bar()
816
merger = Merger(self.branch, this_tree=self, pb=pb)
817
merger.pp = ProgressPhase("Merge phase", 5, pb)
818
merger.pp.next_phase()
819
# check that there are no
821
merger.check_basis(check_clean=True, require_commits=False)
822
if to_revision is None:
823
to_revision = _mod_revision.ensure_null(branch.last_revision())
825
to_revision = osutils.safe_revision_id(to_revision)
826
merger.other_rev_id = to_revision
827
if _mod_revision.is_null(merger.other_rev_id):
828
raise errors.NoCommits(branch)
829
self.branch.fetch(branch, last_revision=merger.other_rev_id)
830
merger.other_basis = merger.other_rev_id
831
merger.other_tree = self.branch.repository.revision_tree(
833
merger.other_branch = branch
834
merger.pp.next_phase()
835
if from_revision is None:
838
merger.set_base_revision(from_revision, branch)
839
if merger.base_rev_id == merger.other_rev_id:
840
raise errors.PointlessMerge
841
merger.backup_files = False
842
if merge_type is None:
843
merger.merge_type = Merge3Merger
845
merger.merge_type = merge_type
846
merger.set_interesting_files(None)
847
merger.show_base = False
848
merger.reprocess = False
849
conflicts = merger.do_merge()
856
def merge_modified(self):
857
"""Return a dictionary of files modified by a merge.
859
The list is initialized by WorkingTree.set_merge_modified, which is
860
typically called after we make some automatic updates to the tree
863
This returns a map of file_id->sha1, containing only files which are
864
still in the working inventory and have that text hash.
867
hashfile = self._control_files.get('merge-hashes')
868
except errors.NoSuchFile:
872
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
873
raise errors.MergeModifiedFormatError()
874
except StopIteration:
875
raise errors.MergeModifiedFormatError()
876
for s in RioReader(hashfile):
877
# RioReader reads in Unicode, so convert file_ids back to utf8
878
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
879
if file_id not in self.inventory:
881
text_hash = s.get("hash")
882
if text_hash == self.get_file_sha1(file_id):
883
merge_hashes[file_id] = text_hash
887
def mkdir(self, path, file_id=None):
888
"""See MutableTree.mkdir()."""
890
file_id = generate_ids.gen_file_id(os.path.basename(path))
891
os.mkdir(self.abspath(path))
892
self.add(path, file_id, 'directory')
895
def get_symlink_target(self, file_id):
896
file_id = osutils.safe_file_id(file_id)
897
return os.readlink(self.id2abspath(file_id))
900
def subsume(self, other_tree):
901
def add_children(inventory, entry):
902
for child_entry in entry.children.values():
903
inventory._byid[child_entry.file_id] = child_entry
904
if child_entry.kind == 'directory':
905
add_children(inventory, child_entry)
906
if other_tree.get_root_id() == self.get_root_id():
907
raise errors.BadSubsumeSource(self, other_tree,
908
'Trees have the same root')
910
other_tree_path = self.relpath(other_tree.basedir)
911
except errors.PathNotChild:
912
raise errors.BadSubsumeSource(self, other_tree,
913
'Tree is not contained by the other')
914
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
915
if new_root_parent is None:
916
raise errors.BadSubsumeSource(self, other_tree,
917
'Parent directory is not versioned.')
918
# We need to ensure that the result of a fetch will have a
919
# versionedfile for the other_tree root, and only fetching into
920
# RepositoryKnit2 guarantees that.
921
if not self.branch.repository.supports_rich_root():
922
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
923
other_tree.lock_tree_write()
925
new_parents = other_tree.get_parent_ids()
926
other_root = other_tree.inventory.root
927
other_root.parent_id = new_root_parent
928
other_root.name = osutils.basename(other_tree_path)
929
self.inventory.add(other_root)
930
add_children(self.inventory, other_root)
931
self._write_inventory(self.inventory)
932
# normally we don't want to fetch whole repositories, but i think
933
# here we really do want to consolidate the whole thing.
934
for parent_id in other_tree.get_parent_ids():
935
self.branch.fetch(other_tree.branch, parent_id)
936
self.add_parent_tree_id(parent_id)
939
other_tree.bzrdir.retire_bzrdir()
941
@needs_tree_write_lock
942
def extract(self, file_id, format=None):
943
"""Extract a subtree from this tree.
945
A new branch will be created, relative to the path for this tree.
949
segments = osutils.splitpath(path)
950
transport = self.branch.bzrdir.root_transport
951
for name in segments:
952
transport = transport.clone(name)
953
transport.ensure_base()
956
sub_path = self.id2path(file_id)
957
branch_transport = mkdirs(sub_path)
959
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
960
branch_transport.ensure_base()
961
branch_bzrdir = format.initialize_on_transport(branch_transport)
963
repo = branch_bzrdir.find_repository()
964
except errors.NoRepositoryPresent:
965
repo = branch_bzrdir.create_repository()
966
assert repo.supports_rich_root()
968
if not repo.supports_rich_root():
969
raise errors.RootNotRich()
970
new_branch = branch_bzrdir.create_branch()
971
new_branch.pull(self.branch)
972
for parent_id in self.get_parent_ids():
973
new_branch.fetch(self.branch, parent_id)
974
tree_transport = self.bzrdir.root_transport.clone(sub_path)
975
if tree_transport.base != branch_transport.base:
976
tree_bzrdir = format.initialize_on_transport(tree_transport)
977
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
979
tree_bzrdir = branch_bzrdir
980
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
981
wt.set_parent_ids(self.get_parent_ids())
982
my_inv = self.inventory
983
child_inv = Inventory(root_id=None)
984
new_root = my_inv[file_id]
985
my_inv.remove_recursive_id(file_id)
986
new_root.parent_id = None
987
child_inv.add(new_root)
988
self._write_inventory(my_inv)
989
wt._write_inventory(child_inv)
992
def _serialize(self, inventory, out_file):
993
xml5.serializer_v5.write_inventory(self._inventory, out_file)
995
def _deserialize(selt, in_file):
996
return xml5.serializer_v5.read_inventory(in_file)
999
"""Write the in memory inventory to disk."""
1000
# TODO: Maybe this should only write on dirty ?
1001
if self._control_files._lock_mode != 'w':
1002
raise errors.NotWriteLocked(self)
1004
self._serialize(self._inventory, sio)
1006
self._control_files.put('inventory', sio)
1007
self._inventory_is_modified = False
1009
def _kind(self, relpath):
1010
return osutils.file_kind(self.abspath(relpath))
1012
def list_files(self, include_root=False):
1013
"""Recursively list all files as (path, class, kind, id, entry).
1015
Lists, but does not descend into unversioned directories.
1017
This does not include files that have been deleted in this
1020
Skips the control directory.
1022
# list_files is an iterator, so @needs_read_lock doesn't work properly
1023
# with it. So callers should be careful to always read_lock the tree.
1024
if not self.is_locked():
1025
raise errors.ObjectNotLocked(self)
1027
inv = self.inventory
1028
if include_root is True:
1029
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1030
# Convert these into local objects to save lookup times
1031
pathjoin = osutils.pathjoin
1032
file_kind = self._kind
1034
# transport.base ends in a slash, we want the piece
1035
# between the last two slashes
1036
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1038
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1040
# directory file_id, relative path, absolute path, reverse sorted children
1041
children = os.listdir(self.basedir)
1043
# jam 20060527 The kernel sized tree seems equivalent whether we
1044
# use a deque and popleft to keep them sorted, or if we use a plain
1045
# list and just reverse() them.
1046
children = collections.deque(children)
1047
stack = [(inv.root.file_id, u'', self.basedir, children)]
1049
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1052
f = children.popleft()
1053
## TODO: If we find a subdirectory with its own .bzr
1054
## directory, then that is a separate tree and we
1055
## should exclude it.
1057
# the bzrdir for this tree
1058
if transport_base_dir == f:
1061
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1062
# and 'f' doesn't begin with one, we can do a string op, rather
1063
# than the checks of pathjoin(), all relative paths will have an extra slash
1065
fp = from_dir_relpath + '/' + f
1068
fap = from_dir_abspath + '/' + f
1070
f_ie = inv.get_child(from_dir_id, f)
1073
elif self.is_ignored(fp[1:]):
1076
# we may not have found this file, because of a unicode issue
1077
f_norm, can_access = osutils.normalized_filename(f)
1078
if f == f_norm or not can_access:
1079
# No change, so treat this file normally
1082
# this file can be accessed by a normalized path
1083
# check again if it is versioned
1084
# these lines are repeated here for performance
1086
fp = from_dir_relpath + '/' + f
1087
fap = from_dir_abspath + '/' + f
1088
f_ie = inv.get_child(from_dir_id, f)
1091
elif self.is_ignored(fp[1:]):
1098
# make a last minute entry
1100
yield fp[1:], c, fk, f_ie.file_id, f_ie
1103
yield fp[1:], c, fk, None, fk_entries[fk]()
1105
yield fp[1:], c, fk, None, TreeEntry()
1108
if fk != 'directory':
1111
# But do this child first
1112
new_children = os.listdir(fap)
1114
new_children = collections.deque(new_children)
1115
stack.append((f_ie.file_id, fp, fap, new_children))
1116
# Break out of inner loop,
1117
# so that we start outer loop with child
1120
# if we finished all children, pop it off the stack
1123
@needs_tree_write_lock
1124
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1127
to_dir must exist in the inventory.
1129
If to_dir exists and is a directory, the files are moved into
1130
it, keeping their old names.
1132
Note that to_dir is only the last component of the new name;
1133
this doesn't change the directory.
1135
For each entry in from_paths the move mode will be determined
1138
The first mode moves the file in the filesystem and updates the
1139
inventory. The second mode only updates the inventory without
1140
touching the file on the filesystem. This is the new mode introduced
1143
move uses the second mode if 'after == True' and the target is not
1144
versioned but present in the working tree.
1146
move uses the second mode if 'after == False' and the source is
1147
versioned but no longer in the working tree, and the target is not
1148
versioned but present in the working tree.
1150
move uses the first mode if 'after == False' and the source is
1151
versioned and present in the working tree, and the target is not
1152
versioned and not present in the working tree.
1154
Everything else results in an error.
1156
This returns a list of (from_path, to_path) pairs for each
1157
entry that is moved.
1162
# check for deprecated use of signature
1164
to_dir = kwargs.get('to_name', None)
1166
raise TypeError('You must supply a target directory')
1168
symbol_versioning.warn('The parameter to_name was deprecated'
1169
' in version 0.13. Use to_dir instead',
1172
# check destination directory
1173
assert not isinstance(from_paths, basestring)
1174
inv = self.inventory
1175
to_abs = self.abspath(to_dir)
1176
if not isdir(to_abs):
1177
raise errors.BzrMoveFailedError('',to_dir,
1178
errors.NotADirectory(to_abs))
1179
if not self.has_filename(to_dir):
1180
raise errors.BzrMoveFailedError('',to_dir,
1181
errors.NotInWorkingDirectory(to_dir))
1182
to_dir_id = inv.path2id(to_dir)
1183
if to_dir_id is None:
1184
raise errors.BzrMoveFailedError('',to_dir,
1185
errors.NotVersionedError(path=str(to_dir)))
1187
to_dir_ie = inv[to_dir_id]
1188
if to_dir_ie.kind != 'directory':
1189
raise errors.BzrMoveFailedError('',to_dir,
1190
errors.NotADirectory(to_abs))
1192
# create rename entries and tuples
1193
for from_rel in from_paths:
1194
from_tail = splitpath(from_rel)[-1]
1195
from_id = inv.path2id(from_rel)
1197
raise errors.BzrMoveFailedError(from_rel,to_dir,
1198
errors.NotVersionedError(path=str(from_rel)))
1200
from_entry = inv[from_id]
1201
from_parent_id = from_entry.parent_id
1202
to_rel = pathjoin(to_dir, from_tail)
1203
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1205
from_tail=from_tail,
1206
from_parent_id=from_parent_id,
1207
to_rel=to_rel, to_tail=from_tail,
1208
to_parent_id=to_dir_id)
1209
rename_entries.append(rename_entry)
1210
rename_tuples.append((from_rel, to_rel))
1212
# determine which move mode to use. checks also for movability
1213
rename_entries = self._determine_mv_mode(rename_entries, after)
1215
original_modified = self._inventory_is_modified
1218
self._inventory_is_modified = True
1219
self._move(rename_entries)
1221
# restore the inventory on error
1222
self._inventory_is_modified = original_modified
1224
self._write_inventory(inv)
1225
return rename_tuples
1227
def _determine_mv_mode(self, rename_entries, after=False):
1228
"""Determines for each from-to pair if both inventory and working tree
1229
or only the inventory has to be changed.
1231
Also does basic plausability tests.
1233
inv = self.inventory
1235
for rename_entry in rename_entries:
1236
# store to local variables for easier reference
1237
from_rel = rename_entry.from_rel
1238
from_id = rename_entry.from_id
1239
to_rel = rename_entry.to_rel
1240
to_id = inv.path2id(to_rel)
1241
only_change_inv = False
1243
# check the inventory for source and destination
1245
raise errors.BzrMoveFailedError(from_rel,to_rel,
1246
errors.NotVersionedError(path=str(from_rel)))
1247
if to_id is not None:
1248
raise errors.BzrMoveFailedError(from_rel,to_rel,
1249
errors.AlreadyVersionedError(path=str(to_rel)))
1251
# try to determine the mode for rename (only change inv or change
1252
# inv and file system)
1254
if not self.has_filename(to_rel):
1255
raise errors.BzrMoveFailedError(from_id,to_rel,
1256
errors.NoSuchFile(path=str(to_rel),
1257
extra="New file has not been created yet"))
1258
only_change_inv = True
1259
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1260
only_change_inv = True
1261
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1262
only_change_inv = False
1264
# something is wrong, so lets determine what exactly
1265
if not self.has_filename(from_rel) and \
1266
not self.has_filename(to_rel):
1267
raise errors.BzrRenameFailedError(from_rel,to_rel,
1268
errors.PathsDoNotExist(paths=(str(from_rel),
1271
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1272
extra="(Use --after to update the Bazaar id)")
1273
rename_entry.only_change_inv = only_change_inv
1274
return rename_entries
1276
def _move(self, rename_entries):
1277
"""Moves a list of files.
1279
Depending on the value of the flag 'only_change_inv', the
1280
file will be moved on the file system or not.
1282
inv = self.inventory
1285
for entry in rename_entries:
1287
self._move_entry(entry)
1289
self._rollback_move(moved)
1293
def _rollback_move(self, moved):
1294
"""Try to rollback a previous move in case of an filesystem error."""
1295
inv = self.inventory
1298
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1299
entry.to_tail, entry.to_parent_id, entry.from_rel,
1300
entry.from_tail, entry.from_parent_id,
1301
entry.only_change_inv))
1302
except errors.BzrMoveFailedError, e:
1303
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1304
" The working tree is in an inconsistent state."
1305
" Please consider doing a 'bzr revert'."
1306
" Error message is: %s" % e)
1308
def _move_entry(self, entry):
1309
inv = self.inventory
1310
from_rel_abs = self.abspath(entry.from_rel)
1311
to_rel_abs = self.abspath(entry.to_rel)
1312
if from_rel_abs == to_rel_abs:
1313
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1314
"Source and target are identical.")
1316
if not entry.only_change_inv:
1318
osutils.rename(from_rel_abs, to_rel_abs)
1320
raise errors.BzrMoveFailedError(entry.from_rel,
1322
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1324
@needs_tree_write_lock
1325
def rename_one(self, from_rel, to_rel, after=False):
1328
This can change the directory or the filename or both.
1330
rename_one has several 'modes' to work. First, it can rename a physical
1331
file and change the file_id. That is the normal mode. Second, it can
1332
only change the file_id without touching any physical file. This is
1333
the new mode introduced in version 0.15.
1335
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1336
versioned but present in the working tree.
1338
rename_one uses the second mode if 'after == False' and 'from_rel' is
1339
versioned but no longer in the working tree, and 'to_rel' is not
1340
versioned but present in the working tree.
1342
rename_one uses the first mode if 'after == False' and 'from_rel' is
1343
versioned and present in the working tree, and 'to_rel' is not
1344
versioned and not present in the working tree.
1346
Everything else results in an error.
1348
inv = self.inventory
1351
# create rename entries and tuples
1352
from_tail = splitpath(from_rel)[-1]
1353
from_id = inv.path2id(from_rel)
1355
raise errors.BzrRenameFailedError(from_rel,to_rel,
1356
errors.NotVersionedError(path=str(from_rel)))
1357
from_entry = inv[from_id]
1358
from_parent_id = from_entry.parent_id
1359
to_dir, to_tail = os.path.split(to_rel)
1360
to_dir_id = inv.path2id(to_dir)
1361
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1363
from_tail=from_tail,
1364
from_parent_id=from_parent_id,
1365
to_rel=to_rel, to_tail=to_tail,
1366
to_parent_id=to_dir_id)
1367
rename_entries.append(rename_entry)
1369
# determine which move mode to use. checks also for movability
1370
rename_entries = self._determine_mv_mode(rename_entries, after)
1372
# check if the target changed directory and if the target directory is
1374
if to_dir_id is None:
1375
raise errors.BzrMoveFailedError(from_rel,to_rel,
1376
errors.NotVersionedError(path=str(to_dir)))
1378
# all checks done. now we can continue with our actual work
1379
mutter('rename_one:\n'
1384
' to_dir_id {%s}\n',
1385
from_id, from_rel, to_rel, to_dir, to_dir_id)
1387
self._move(rename_entries)
1388
self._write_inventory(inv)
1390
class _RenameEntry(object):
1391
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1392
to_rel, to_tail, to_parent_id, only_change_inv=False):
1393
self.from_rel = from_rel
1394
self.from_id = from_id
1395
self.from_tail = from_tail
1396
self.from_parent_id = from_parent_id
1397
self.to_rel = to_rel
1398
self.to_tail = to_tail
1399
self.to_parent_id = to_parent_id
1400
self.only_change_inv = only_change_inv
1404
"""Return all unknown files.
1406
These are files in the working directory that are not versioned or
1407
control files or ignored.
1409
# force the extras method to be fully executed before returning, to
1410
# prevent race conditions with the lock
1412
[subp for subp in self.extras() if not self.is_ignored(subp)])
1414
@needs_tree_write_lock
1415
def unversion(self, file_ids):
1416
"""Remove the file ids in file_ids from the current versioned set.
1418
When a file_id is unversioned, all of its children are automatically
1421
:param file_ids: The file ids to stop versioning.
1422
:raises: NoSuchId if any fileid is not currently versioned.
1424
for file_id in file_ids:
1425
file_id = osutils.safe_file_id(file_id)
1426
if self._inventory.has_id(file_id):
1427
self._inventory.remove_recursive_id(file_id)
1429
raise errors.NoSuchId(self, file_id)
1431
# in the future this should just set a dirty bit to wait for the
1432
# final unlock. However, until all methods of workingtree start
1433
# with the current in -memory inventory rather than triggering
1434
# a read, it is more complex - we need to teach read_inventory
1435
# to know when to read, and when to not read first... and possibly
1436
# to save first when the in memory one may be corrupted.
1437
# so for now, we just only write it if it is indeed dirty.
1439
self._write_inventory(self._inventory)
1441
@deprecated_method(zero_eight)
1442
def iter_conflicts(self):
1443
"""List all files in the tree that have text or content conflicts.
1444
DEPRECATED. Use conflicts instead."""
1445
return self._iter_conflicts()
1447
def _iter_conflicts(self):
1449
for info in self.list_files():
1451
stem = get_conflicted_stem(path)
1454
if stem not in conflicted:
1455
conflicted.add(stem)
1459
def pull(self, source, overwrite=False, stop_revision=None,
1460
change_reporter=None):
1461
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1464
pp = ProgressPhase("Pull phase", 2, top_pb)
1466
old_revision_info = self.branch.last_revision_info()
1467
basis_tree = self.basis_tree()
1468
count = self.branch.pull(source, overwrite, stop_revision)
1469
new_revision_info = self.branch.last_revision_info()
1470
if new_revision_info != old_revision_info:
1472
repository = self.branch.repository
1473
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1474
basis_tree.lock_read()
1476
new_basis_tree = self.branch.basis_tree()
1483
change_reporter=change_reporter)
1484
if (basis_tree.inventory.root is None and
1485
new_basis_tree.inventory.root is not None):
1486
self.set_root_id(new_basis_tree.inventory.root.file_id)
1490
# TODO - dedup parents list with things merged by pull ?
1491
# reuse the revisiontree we merged against to set the new
1493
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1494
# we have to pull the merge trees out again, because
1495
# merge_inner has set the ids. - this corner is not yet
1496
# layered well enough to prevent double handling.
1497
# XXX TODO: Fix the double handling: telling the tree about
1498
# the already known parent data is wasteful.
1499
merges = self.get_parent_ids()[1:]
1500
parent_trees.extend([
1501
(parent, repository.revision_tree(parent)) for
1503
self.set_parent_trees(parent_trees)
1510
def put_file_bytes_non_atomic(self, file_id, bytes):
1511
"""See MutableTree.put_file_bytes_non_atomic."""
1512
file_id = osutils.safe_file_id(file_id)
1513
stream = file(self.id2abspath(file_id), 'wb')
1518
# TODO: update the hashcache here ?
1521
"""Yield all unversioned files in this WorkingTree.
1523
If there are any unversioned directories then only the directory is
1524
returned, not all its children. But if there are unversioned files
1525
under a versioned subdirectory, they are returned.
1527
Currently returned depth-first, sorted by name within directories.
1528
This is the same order used by 'osutils.walkdirs'.
1530
## TODO: Work from given directory downwards
1531
for path, dir_entry in self.inventory.directories():
1532
# mutter("search for unknowns in %r", path)
1533
dirabs = self.abspath(path)
1534
if not isdir(dirabs):
1535
# e.g. directory deleted
1539
for subf in os.listdir(dirabs):
1542
if subf not in dir_entry.children:
1543
subf_norm, can_access = osutils.normalized_filename(subf)
1544
if subf_norm != subf and can_access:
1545
if subf_norm not in dir_entry.children:
1546
fl.append(subf_norm)
1552
subp = pathjoin(path, subf)
1555
def ignored_files(self):
1556
"""Yield list of PATH, IGNORE_PATTERN"""
1557
for subp in self.extras():
1558
pat = self.is_ignored(subp)
1562
def get_ignore_list(self):
1563
"""Return list of ignore patterns.
1565
Cached in the Tree object after the first call.
1567
ignoreset = getattr(self, '_ignoreset', None)
1568
if ignoreset is not None:
1571
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1572
ignore_globs.update(ignores.get_runtime_ignores())
1573
ignore_globs.update(ignores.get_user_ignores())
1574
if self.has_filename(bzrlib.IGNORE_FILENAME):
1575
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1577
ignore_globs.update(ignores.parse_ignore_file(f))
1580
self._ignoreset = ignore_globs
1583
def _flush_ignore_list_cache(self):
1584
"""Resets the cached ignore list to force a cache rebuild."""
1585
self._ignoreset = None
1586
self._ignoreglobster = None
1588
def is_ignored(self, filename):
1589
r"""Check whether the filename matches an ignore pattern.
1591
Patterns containing '/' or '\' need to match the whole path;
1592
others match against only the last component.
1594
If the file is ignored, returns the pattern which caused it to
1595
be ignored, otherwise None. So this can simply be used as a
1596
boolean if desired."""
1597
if getattr(self, '_ignoreglobster', None) is None:
1598
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1599
return self._ignoreglobster.match(filename)
1601
def kind(self, file_id):
1602
return file_kind(self.id2abspath(file_id))
1604
def _comparison_data(self, entry, path):
1605
abspath = self.abspath(path)
1607
stat_value = os.lstat(abspath)
1609
if getattr(e, 'errno', None) == errno.ENOENT:
1616
mode = stat_value.st_mode
1617
kind = osutils.file_kind_from_stat_mode(mode)
1618
if not supports_executable():
1619
executable = entry is not None and entry.executable
1621
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1622
return kind, executable, stat_value
1624
def _file_size(self, entry, stat_value):
1625
return stat_value.st_size
1627
def last_revision(self):
1628
"""Return the last revision of the branch for this tree.
1630
This format tree does not support a separate marker for last-revision
1631
compared to the branch.
1633
See MutableTree.last_revision
1635
return self._last_revision()
1638
def _last_revision(self):
1639
"""helper for get_parent_ids."""
1640
return self.branch.last_revision()
1642
def is_locked(self):
1643
return self._control_files.is_locked()
1645
def _must_be_locked(self):
1646
if not self.is_locked():
1647
raise errors.ObjectNotLocked(self)
1649
def lock_read(self):
1650
"""See Branch.lock_read, and WorkingTree.unlock."""
1651
if not self.is_locked():
1653
self.branch.lock_read()
1655
return self._control_files.lock_read()
1657
self.branch.unlock()
1660
def lock_tree_write(self):
1661
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1662
if not self.is_locked():
1664
self.branch.lock_read()
1666
return self._control_files.lock_write()
1668
self.branch.unlock()
1671
def lock_write(self):
1672
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1673
if not self.is_locked():
1675
self.branch.lock_write()
1677
return self._control_files.lock_write()
1679
self.branch.unlock()
1682
def get_physical_lock_status(self):
1683
return self._control_files.get_physical_lock_status()
1685
def _basis_inventory_name(self):
1686
return 'basis-inventory-cache'
1688
def _reset_data(self):
1689
"""Reset transient data that cannot be revalidated."""
1690
self._inventory_is_modified = False
1691
result = self._deserialize(self._control_files.get('inventory'))
1692
self._set_inventory(result, dirty=False)
1694
@needs_tree_write_lock
1695
def set_last_revision(self, new_revision):
1696
"""Change the last revision in the working tree."""
1697
new_revision = osutils.safe_revision_id(new_revision)
1698
if self._change_last_revision(new_revision):
1699
self._cache_basis_inventory(new_revision)
1701
def _change_last_revision(self, new_revision):
1702
"""Template method part of set_last_revision to perform the change.
1704
This is used to allow WorkingTree3 instances to not affect branch
1705
when their last revision is set.
1707
if _mod_revision.is_null(new_revision):
1708
self.branch.set_revision_history([])
1711
self.branch.generate_revision_history(new_revision)
1712
except errors.NoSuchRevision:
1713
# not present in the repo - dont try to set it deeper than the tip
1714
self.branch.set_revision_history([new_revision])
1717
def _write_basis_inventory(self, xml):
1718
"""Write the basis inventory XML to the basis-inventory file"""
1719
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1720
path = self._basis_inventory_name()
1722
self._control_files.put(path, sio)
1724
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1725
"""Create the text that will be saved in basis-inventory"""
1726
# TODO: jam 20070209 This should be redundant, as the revision_id
1727
# as all callers should have already converted the revision_id to
1729
inventory.revision_id = osutils.safe_revision_id(revision_id)
1730
return xml7.serializer_v7.write_inventory_to_string(inventory)
1732
def _cache_basis_inventory(self, new_revision):
1733
"""Cache new_revision as the basis inventory."""
1734
# TODO: this should allow the ready-to-use inventory to be passed in,
1735
# as commit already has that ready-to-use [while the format is the
1738
# this double handles the inventory - unpack and repack -
1739
# but is easier to understand. We can/should put a conditional
1740
# in here based on whether the inventory is in the latest format
1741
# - perhaps we should repack all inventories on a repository
1743
# the fast path is to copy the raw xml from the repository. If the
1744
# xml contains 'revision_id="', then we assume the right
1745
# revision_id is set. We must check for this full string, because a
1746
# root node id can legitimately look like 'revision_id' but cannot
1748
xml = self.branch.repository.get_inventory_xml(new_revision)
1749
firstline = xml.split('\n', 1)[0]
1750
if (not 'revision_id="' in firstline or
1751
'format="7"' not in firstline):
1752
inv = self.branch.repository.deserialise_inventory(
1754
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1755
self._write_basis_inventory(xml)
1756
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1759
def read_basis_inventory(self):
1760
"""Read the cached basis inventory."""
1761
path = self._basis_inventory_name()
1762
return self._control_files.get(path).read()
1765
def read_working_inventory(self):
1766
"""Read the working inventory.
1768
:raises errors.InventoryModified: read_working_inventory will fail
1769
when the current in memory inventory has been modified.
1771
# conceptually this should be an implementation detail of the tree.
1772
# XXX: Deprecate this.
1773
# ElementTree does its own conversion from UTF-8, so open in
1775
if self._inventory_is_modified:
1776
raise errors.InventoryModified(self)
1777
result = self._deserialize(self._control_files.get('inventory'))
1778
self._set_inventory(result, dirty=False)
1781
@needs_tree_write_lock
1782
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1784
"""Remove nominated files from the working inventory.
1786
:files: File paths relative to the basedir.
1787
:keep_files: If true, the files will also be kept.
1788
:force: Delete files and directories, even if they are changed and
1789
even if the directories are not empty.
1791
if isinstance(files, basestring):
1797
unknown_files_in_directory=set()
1799
def recurse_directory_to_add_files(directory):
1800
# recurse directory and add all files
1801
# so we can check if they have changed.
1802
for parent_info, file_infos in\
1803
osutils.walkdirs(self.abspath(directory),
1805
for relpath, basename, kind, lstat, abspath in file_infos:
1807
if self.path2id(relpath): #is it versioned?
1808
new_files.add(relpath)
1810
unknown_files_in_directory.add(
1811
(relpath, None, kind))
1813
for filename in files:
1814
# Get file name into canonical form.
1815
abspath = self.abspath(filename)
1816
filename = self.relpath(abspath)
1817
if len(filename) > 0:
1818
new_files.add(filename)
1819
if osutils.isdir(abspath):
1820
recurse_directory_to_add_files(filename)
1822
files = [f for f in new_files]
1825
return # nothing to do
1827
# Sort needed to first handle directory content before the directory
1828
files.sort(reverse=True)
1830
# Bail out if we are going to delete files we shouldn't
1831
if not keep_files and not force:
1832
has_changed_files = len(unknown_files_in_directory) > 0
1833
if not has_changed_files:
1834
for (file_id, path, content_change, versioned, parent_id, name,
1835
kind, executable) in self._iter_changes(self.basis_tree(),
1836
include_unchanged=True, require_versioned=False,
1837
want_unversioned=True, specific_files=files):
1838
# check if it's unknown OR 'changed but not deleted':
1839
if (versioned == (False, False)
1840
or (content_change and kind[1] != None)):
1841
has_changed_files = True
1844
if has_changed_files:
1845
# make delta show ALL applicable changes in error message.
1846
tree_delta = self.changes_from(self.basis_tree(),
1847
require_versioned=False, want_unversioned=True,
1848
specific_files=files)
1849
for unknown_file in unknown_files_in_directory:
1850
tree_delta.unversioned.extend((unknown_file,))
1851
raise errors.BzrRemoveChangedFilesError(tree_delta)
1853
# Build inv_delta and delete files where applicaple,
1854
# do this before any modifications to inventory
1856
fid = self.path2id(f)
1859
message = "%s is not versioned." % (f,)
1862
# having removed it, it must be either ignored or unknown
1863
if self.is_ignored(f):
1867
textui.show_status(new_status, self.kind(fid), f,
1870
inv_delta.append((f, None, fid, None))
1871
message = "removed %s" % (f,)
1874
abs_path = self.abspath(f)
1875
if osutils.lexists(abs_path):
1876
if (osutils.isdir(abs_path) and
1877
len(os.listdir(abs_path)) > 0):
1879
osutils.rmtree(abs_path)
1881
message = "%s is not empty directory "\
1882
"and won't be deleted." % (f,)
1884
osutils.delete_any(abs_path)
1885
message = "deleted %s" % (f,)
1886
elif message is not None:
1887
# only care if we haven't done anything yet.
1888
message ="%s does not exist." % (f,)
1890
# print only one message (if any) per file.
1891
if message is not None:
1893
self.apply_inventory_delta(inv_delta)
1895
@needs_tree_write_lock
1896
def revert(self, filenames, old_tree=None, backups=True,
1897
pb=DummyProgress(), report_changes=False):
1898
from bzrlib.conflicts import resolve
1899
if old_tree is None:
1900
old_tree = self.basis_tree()
1901
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1903
if not len(filenames):
1904
self.set_parent_ids(self.get_parent_ids()[:1])
1907
resolve(self, filenames, ignore_misses=True)
1910
def revision_tree(self, revision_id):
1911
"""See Tree.revision_tree.
1913
WorkingTree can supply revision_trees for the basis revision only
1914
because there is only one cached inventory in the bzr directory.
1916
if revision_id == self.last_revision():
1918
xml = self.read_basis_inventory()
1919
except errors.NoSuchFile:
1923
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1924
# dont use the repository revision_tree api because we want
1925
# to supply the inventory.
1926
if inv.revision_id == revision_id:
1927
return revisiontree.RevisionTree(self.branch.repository,
1929
except errors.BadInventoryFormat:
1931
# raise if there was no inventory, or if we read the wrong inventory.
1932
raise errors.NoSuchRevisionInTree(self, revision_id)
1934
# XXX: This method should be deprecated in favour of taking in a proper
1935
# new Inventory object.
1936
@needs_tree_write_lock
1937
def set_inventory(self, new_inventory_list):
1938
from bzrlib.inventory import (Inventory,
1943
inv = Inventory(self.get_root_id())
1944
for path, file_id, parent, kind in new_inventory_list:
1945
name = os.path.basename(path)
1948
# fixme, there should be a factory function inv,add_??
1949
if kind == 'directory':
1950
inv.add(InventoryDirectory(file_id, name, parent))
1951
elif kind == 'file':
1952
inv.add(InventoryFile(file_id, name, parent))
1953
elif kind == 'symlink':
1954
inv.add(InventoryLink(file_id, name, parent))
1956
raise errors.BzrError("unknown kind %r" % kind)
1957
self._write_inventory(inv)
1959
@needs_tree_write_lock
1960
def set_root_id(self, file_id):
1961
"""Set the root id for this tree."""
1964
symbol_versioning.warn(symbol_versioning.zero_twelve
1965
% 'WorkingTree.set_root_id with fileid=None',
1970
file_id = osutils.safe_file_id(file_id)
1971
self._set_root_id(file_id)
1973
def _set_root_id(self, file_id):
1974
"""Set the root id for this tree, in a format specific manner.
1976
:param file_id: The file id to assign to the root. It must not be
1977
present in the current inventory or an error will occur. It must
1978
not be None, but rather a valid file id.
1980
inv = self._inventory
1981
orig_root_id = inv.root.file_id
1982
# TODO: it might be nice to exit early if there was nothing
1983
# to do, saving us from trigger a sync on unlock.
1984
self._inventory_is_modified = True
1985
# we preserve the root inventory entry object, but
1986
# unlinkit from the byid index
1987
del inv._byid[inv.root.file_id]
1988
inv.root.file_id = file_id
1989
# and link it into the index with the new changed id.
1990
inv._byid[inv.root.file_id] = inv.root
1991
# and finally update all children to reference the new id.
1992
# XXX: this should be safe to just look at the root.children
1993
# list, not the WHOLE INVENTORY.
1996
if entry.parent_id == orig_root_id:
1997
entry.parent_id = inv.root.file_id
2000
"""See Branch.unlock.
2002
WorkingTree locking just uses the Branch locking facilities.
2003
This is current because all working trees have an embedded branch
2004
within them. IF in the future, we were to make branch data shareable
2005
between multiple working trees, i.e. via shared storage, then we
2006
would probably want to lock both the local tree, and the branch.
2008
raise NotImplementedError(self.unlock)
2010
def update(self, change_reporter=None):
2011
"""Update a working tree along its branch.
2013
This will update the branch if its bound too, which means we have
2014
multiple trees involved:
2016
- The new basis tree of the master.
2017
- The old basis tree of the branch.
2018
- The old basis tree of the working tree.
2019
- The current working tree state.
2021
Pathologically, all three may be different, and non-ancestors of each
2022
other. Conceptually we want to:
2024
- Preserve the wt.basis->wt.state changes
2025
- Transform the wt.basis to the new master basis.
2026
- Apply a merge of the old branch basis to get any 'local' changes from
2028
- Restore the wt.basis->wt.state changes.
2030
There isn't a single operation at the moment to do that, so we:
2031
- Merge current state -> basis tree of the master w.r.t. the old tree
2033
- Do a 'normal' merge of the old branch basis if it is relevant.
2035
if self.branch.get_master_branch() is not None:
2037
update_branch = True
2039
self.lock_tree_write()
2040
update_branch = False
2043
old_tip = self.branch.update()
2046
return self._update_tree(old_tip, change_reporter)
2050
@needs_tree_write_lock
2051
def _update_tree(self, old_tip=None, change_reporter=None):
2052
"""Update a tree to the master branch.
2054
:param old_tip: if supplied, the previous tip revision the branch,
2055
before it was changed to the master branch's tip.
2057
# here if old_tip is not None, it is the old tip of the branch before
2058
# it was updated from the master branch. This should become a pending
2059
# merge in the working tree to preserve the user existing work. we
2060
# cant set that until we update the working trees last revision to be
2061
# one from the new branch, because it will just get absorbed by the
2062
# parent de-duplication logic.
2064
# We MUST save it even if an error occurs, because otherwise the users
2065
# local work is unreferenced and will appear to have been lost.
2069
last_rev = self.get_parent_ids()[0]
2071
last_rev = _mod_revision.NULL_REVISION
2072
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2073
# merge tree state up to new branch tip.
2074
basis = self.basis_tree()
2077
to_tree = self.branch.basis_tree()
2078
if basis.inventory.root is None:
2079
self.set_root_id(to_tree.inventory.root.file_id)
2081
result += merge.merge_inner(
2086
change_reporter=change_reporter)
2089
# TODO - dedup parents list with things merged by pull ?
2090
# reuse the tree we've updated to to set the basis:
2091
parent_trees = [(self.branch.last_revision(), to_tree)]
2092
merges = self.get_parent_ids()[1:]
2093
# Ideally we ask the tree for the trees here, that way the working
2094
# tree can decide whether to give us teh entire tree or give us a
2095
# lazy initialised tree. dirstate for instance will have the trees
2096
# in ram already, whereas a last-revision + basis-inventory tree
2097
# will not, but also does not need them when setting parents.
2098
for parent in merges:
2099
parent_trees.append(
2100
(parent, self.branch.repository.revision_tree(parent)))
2101
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2102
parent_trees.append(
2103
(old_tip, self.branch.repository.revision_tree(old_tip)))
2104
self.set_parent_trees(parent_trees)
2105
last_rev = parent_trees[0][0]
2107
# the working tree had the same last-revision as the master
2108
# branch did. We may still have pivot local work from the local
2109
# branch into old_tip:
2110
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2111
self.add_parent_tree_id(old_tip)
2112
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2113
and old_tip != last_rev):
2114
# our last revision was not the prior branch last revision
2115
# and we have converted that last revision to a pending merge.
2116
# base is somewhere between the branch tip now
2117
# and the now pending merge
2119
# Since we just modified the working tree and inventory, flush out
2120
# the current state, before we modify it again.
2121
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2122
# requires it only because TreeTransform directly munges the
2123
# inventory and calls tree._write_inventory(). Ultimately we
2124
# should be able to remove this extra flush.
2126
graph = self.branch.repository.get_graph()
2127
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2129
base_tree = self.branch.repository.revision_tree(base_rev_id)
2130
other_tree = self.branch.repository.revision_tree(old_tip)
2131
result += merge.merge_inner(
2136
change_reporter=change_reporter)
2139
def _write_hashcache_if_dirty(self):
2140
"""Write out the hashcache if it is dirty."""
2141
if self._hashcache.needs_write:
2143
self._hashcache.write()
2145
if e.errno not in (errno.EPERM, errno.EACCES):
2147
# TODO: jam 20061219 Should this be a warning? A single line
2148
# warning might be sufficient to let the user know what
2150
mutter('Could not write hashcache for %s\nError: %s',
2151
self._hashcache.cache_file_name(), e)
2153
@needs_tree_write_lock
2154
def _write_inventory(self, inv):
2155
"""Write inventory as the current inventory."""
2156
self._set_inventory(inv, dirty=True)
2159
def set_conflicts(self, arg):
2160
raise errors.UnsupportedOperation(self.set_conflicts, self)
2162
def add_conflicts(self, arg):
2163
raise errors.UnsupportedOperation(self.add_conflicts, self)
2166
def conflicts(self):
2167
conflicts = _mod_conflicts.ConflictList()
2168
for conflicted in self._iter_conflicts():
2171
if file_kind(self.abspath(conflicted)) != "file":
2173
except errors.NoSuchFile:
2176
for suffix in ('.THIS', '.OTHER'):
2178
kind = file_kind(self.abspath(conflicted+suffix))
2181
except errors.NoSuchFile:
2185
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2186
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2188
file_id=self.path2id(conflicted)))
2191
def walkdirs(self, prefix=""):
2192
"""Walk the directories of this tree.
2194
returns a generator which yields items in the form:
2195
((curren_directory_path, fileid),
2196
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2199
This API returns a generator, which is only valid during the current
2200
tree transaction - within a single lock_read or lock_write duration.
2202
If the tree is not locked, it may cause an error to be raised,
2203
depending on the tree implementation.
2205
disk_top = self.abspath(prefix)
2206
if disk_top.endswith('/'):
2207
disk_top = disk_top[:-1]
2208
top_strip_len = len(disk_top) + 1
2209
inventory_iterator = self._walkdirs(prefix)
2210
disk_iterator = osutils.walkdirs(disk_top, prefix)
2212
current_disk = disk_iterator.next()
2213
disk_finished = False
2215
if not (e.errno == errno.ENOENT or
2216
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2219
disk_finished = True
2221
current_inv = inventory_iterator.next()
2222
inv_finished = False
2223
except StopIteration:
2226
while not inv_finished or not disk_finished:
2227
if not disk_finished:
2228
# strip out .bzr dirs
2229
if current_disk[0][1][top_strip_len:] == '':
2230
# osutils.walkdirs can be made nicer -
2231
# yield the path-from-prefix rather than the pathjoined
2233
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2234
if current_disk[1][bzrdir_loc][0] == '.bzr':
2235
# we dont yield the contents of, or, .bzr itself.
2236
del current_disk[1][bzrdir_loc]
2238
# everything is unknown
2241
# everything is missing
2244
direction = cmp(current_inv[0][0], current_disk[0][0])
2246
# disk is before inventory - unknown
2247
dirblock = [(relpath, basename, kind, stat, None, None) for
2248
relpath, basename, kind, stat, top_path in current_disk[1]]
2249
yield (current_disk[0][0], None), dirblock
2251
current_disk = disk_iterator.next()
2252
except StopIteration:
2253
disk_finished = True
2255
# inventory is before disk - missing.
2256
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2257
for relpath, basename, dkind, stat, fileid, kind in
2259
yield (current_inv[0][0], current_inv[0][1]), dirblock
2261
current_inv = inventory_iterator.next()
2262
except StopIteration:
2265
# versioned present directory
2266
# merge the inventory and disk data together
2268
for relpath, subiterator in itertools.groupby(sorted(
2269
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2270
path_elements = list(subiterator)
2271
if len(path_elements) == 2:
2272
inv_row, disk_row = path_elements
2273
# versioned, present file
2274
dirblock.append((inv_row[0],
2275
inv_row[1], disk_row[2],
2276
disk_row[3], inv_row[4],
2278
elif len(path_elements[0]) == 5:
2280
dirblock.append((path_elements[0][0],
2281
path_elements[0][1], path_elements[0][2],
2282
path_elements[0][3], None, None))
2283
elif len(path_elements[0]) == 6:
2284
# versioned, absent file.
2285
dirblock.append((path_elements[0][0],
2286
path_elements[0][1], 'unknown', None,
2287
path_elements[0][4], path_elements[0][5]))
2289
raise NotImplementedError('unreachable code')
2290
yield current_inv[0], dirblock
2292
current_inv = inventory_iterator.next()
2293
except StopIteration:
2296
current_disk = disk_iterator.next()
2297
except StopIteration:
2298
disk_finished = True
2300
def _walkdirs(self, prefix=""):
2301
"""Walk the directories of this tree.
2303
:prefix: is used as the directrory to start with.
2304
returns a generator which yields items in the form:
2305
((curren_directory_path, fileid),
2306
[(file1_path, file1_name, file1_kind, None, file1_id,
2309
_directory = 'directory'
2310
# get the root in the inventory
2311
inv = self.inventory
2312
top_id = inv.path2id(prefix)
2316
pending = [(prefix, '', _directory, None, top_id, None)]
2319
currentdir = pending.pop()
2320
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2321
top_id = currentdir[4]
2323
relroot = currentdir[0] + '/'
2326
# FIXME: stash the node in pending
2328
for name, child in entry.sorted_children():
2329
dirblock.append((relroot + name, name, child.kind, None,
2330
child.file_id, child.kind
2332
yield (currentdir[0], entry.file_id), dirblock
2333
# push the user specified dirs from dirblock
2334
for dir in reversed(dirblock):
2335
if dir[2] == _directory:
2338
@needs_tree_write_lock
2339
def auto_resolve(self):
2340
"""Automatically resolve text conflicts according to contents.
2342
Only text conflicts are auto_resolvable. Files with no conflict markers
2343
are considered 'resolved', because bzr always puts conflict markers
2344
into files that have text conflicts. The corresponding .THIS .BASE and
2345
.OTHER files are deleted, as per 'resolve'.
2346
:return: a tuple of ConflictLists: (un_resolved, resolved).
2348
un_resolved = _mod_conflicts.ConflictList()
2349
resolved = _mod_conflicts.ConflictList()
2350
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2351
for conflict in self.conflicts():
2352
if (conflict.typestring != 'text conflict' or
2353
self.kind(conflict.file_id) != 'file'):
2354
un_resolved.append(conflict)
2356
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2358
for line in my_file:
2359
if conflict_re.search(line):
2360
un_resolved.append(conflict)
2363
resolved.append(conflict)
2366
resolved.remove_files(self)
2367
self.set_conflicts(un_resolved)
2368
return un_resolved, resolved
2370
def _validate(self):
2371
"""Validate internal structures.
2373
This is meant mostly for the test suite. To give it a chance to detect
2374
corruption after actions have occurred. The default implementation is a
2377
:return: None. An exception should be raised if there is an error.
2382
class WorkingTree2(WorkingTree):
2383
"""This is the Format 2 working tree.
2385
This was the first weave based working tree.
2386
- uses os locks for locking.
2387
- uses the branch last-revision.
2390
def __init__(self, *args, **kwargs):
2391
super(WorkingTree2, self).__init__(*args, **kwargs)
2392
# WorkingTree2 has more of a constraint that self._inventory must
2393
# exist. Because this is an older format, we don't mind the overhead
2394
# caused by the extra computation here.
2396
# Newer WorkingTree's should only have self._inventory set when they
2398
if self._inventory is None:
2399
self.read_working_inventory()
2401
def lock_tree_write(self):
2402
"""See WorkingTree.lock_tree_write().
2404
In Format2 WorkingTrees we have a single lock for the branch and tree
2405
so lock_tree_write() degrades to lock_write().
2407
self.branch.lock_write()
2409
return self._control_files.lock_write()
2411
self.branch.unlock()
2415
# we share control files:
2416
if self._control_files._lock_count == 3:
2417
# _inventory_is_modified is always False during a read lock.
2418
if self._inventory_is_modified:
2420
self._write_hashcache_if_dirty()
2422
# reverse order of locking.
2424
return self._control_files.unlock()
2426
self.branch.unlock()
2429
class WorkingTree3(WorkingTree):
2430
"""This is the Format 3 working tree.
2432
This differs from the base WorkingTree by:
2433
- having its own file lock
2434
- having its own last-revision property.
2436
This is new in bzr 0.8
2440
def _last_revision(self):
2441
"""See Mutable.last_revision."""
2443
return osutils.safe_revision_id(
2444
self._control_files.get('last-revision').read())
2445
except errors.NoSuchFile:
2448
def _change_last_revision(self, revision_id):
2449
"""See WorkingTree._change_last_revision."""
2450
if revision_id is None or revision_id == NULL_REVISION:
2452
self._control_files._transport.delete('last-revision')
2453
except errors.NoSuchFile:
2457
self._control_files.put_bytes('last-revision', revision_id)
2460
@needs_tree_write_lock
2461
def set_conflicts(self, conflicts):
2462
self._put_rio('conflicts', conflicts.to_stanzas(),
2465
@needs_tree_write_lock
2466
def add_conflicts(self, new_conflicts):
2467
conflict_set = set(self.conflicts())
2468
conflict_set.update(set(list(new_conflicts)))
2469
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2470
key=_mod_conflicts.Conflict.sort_key)))
2473
def conflicts(self):
2475
confile = self._control_files.get('conflicts')
2476
except errors.NoSuchFile:
2477
return _mod_conflicts.ConflictList()
2479
if confile.next() != CONFLICT_HEADER_1 + '\n':
2480
raise errors.ConflictFormatError()
2481
except StopIteration:
2482
raise errors.ConflictFormatError()
2483
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2486
if self._control_files._lock_count == 1:
2487
# _inventory_is_modified is always False during a read lock.
2488
if self._inventory_is_modified:
2490
self._write_hashcache_if_dirty()
2491
# reverse order of locking.
2493
return self._control_files.unlock()
2495
self.branch.unlock()
2498
def get_conflicted_stem(path):
2499
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2500
if path.endswith(suffix):
2501
return path[:-len(suffix)]
2504
@deprecated_function(zero_eight)
2505
def is_control_file(filename):
2506
"""See WorkingTree.is_control_filename(filename)."""
2507
## FIXME: better check
2508
filename = normpath(filename)
2509
while filename != '':
2510
head, tail = os.path.split(filename)
2511
## mutter('check %r for control file' % ((head, tail),))
2514
if filename == head:
2520
class WorkingTreeFormat(object):
2521
"""An encapsulation of the initialization and open routines for a format.
2523
Formats provide three things:
2524
* An initialization routine,
2528
Formats are placed in an dict by their format string for reference
2529
during workingtree opening. Its not required that these be instances, they
2530
can be classes themselves with class methods - it simply depends on
2531
whether state is needed for a given format or not.
2533
Once a format is deprecated, just deprecate the initialize and open
2534
methods on the format class. Do not deprecate the object, as the
2535
object will be created every time regardless.
2538
_default_format = None
2539
"""The default format used for new trees."""
2542
"""The known formats."""
2544
requires_rich_root = False
2546
upgrade_recommended = False
2549
def find_format(klass, a_bzrdir):
2550
"""Return the format for the working tree object in a_bzrdir."""
2552
transport = a_bzrdir.get_workingtree_transport(None)
2553
format_string = transport.get("format").read()
2554
return klass._formats[format_string]
2555
except errors.NoSuchFile:
2556
raise errors.NoWorkingTree(base=transport.base)
2558
raise errors.UnknownFormatError(format=format_string)
2560
def __eq__(self, other):
2561
return self.__class__ is other.__class__
2563
def __ne__(self, other):
2564
return not (self == other)
2567
def get_default_format(klass):
2568
"""Return the current default format."""
2569
return klass._default_format
2571
def get_format_string(self):
2572
"""Return the ASCII format string that identifies this format."""
2573
raise NotImplementedError(self.get_format_string)
2575
def get_format_description(self):
2576
"""Return the short description for this format."""
2577
raise NotImplementedError(self.get_format_description)
2579
def is_supported(self):
2580
"""Is this format supported?
2582
Supported formats can be initialized and opened.
2583
Unsupported formats may not support initialization or committing or
2584
some other features depending on the reason for not being supported.
2589
def register_format(klass, format):
2590
klass._formats[format.get_format_string()] = format
2593
def set_default_format(klass, format):
2594
klass._default_format = format
2597
def unregister_format(klass, format):
2598
assert klass._formats[format.get_format_string()] is format
2599
del klass._formats[format.get_format_string()]
2602
class WorkingTreeFormat2(WorkingTreeFormat):
2603
"""The second working tree format.
2605
This format modified the hash cache from the format 1 hash cache.
2608
upgrade_recommended = True
2610
def get_format_description(self):
2611
"""See WorkingTreeFormat.get_format_description()."""
2612
return "Working tree format 2"
2614
def stub_initialize_remote(self, control_files):
2615
"""As a special workaround create critical control files for a remote working tree
2617
This ensures that it can later be updated and dealt with locally,
2618
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2619
no working tree. (See bug #43064).
2623
xml5.serializer_v5.write_inventory(inv, sio)
2625
control_files.put('inventory', sio)
2627
control_files.put_bytes('pending-merges', '')
2630
def initialize(self, a_bzrdir, revision_id=None):
2631
"""See WorkingTreeFormat.initialize()."""
2632
if not isinstance(a_bzrdir.transport, LocalTransport):
2633
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2634
branch = a_bzrdir.open_branch()
2635
if revision_id is None:
2636
revision_id = _mod_revision.ensure_null(branch.last_revision())
2638
revision_id = osutils.safe_revision_id(revision_id)
2641
branch.generate_revision_history(revision_id)
2645
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2651
basis_tree = branch.repository.revision_tree(revision_id)
2652
if basis_tree.inventory.root is not None:
2653
wt.set_root_id(basis_tree.inventory.root.file_id)
2654
# set the parent list and cache the basis tree.
2655
if _mod_revision.is_null(revision_id):
2658
parent_trees = [(revision_id, basis_tree)]
2659
wt.set_parent_trees(parent_trees)
2660
transform.build_tree(basis_tree, wt)
2664
super(WorkingTreeFormat2, self).__init__()
2665
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2667
def open(self, a_bzrdir, _found=False):
2668
"""Return the WorkingTree object for a_bzrdir
2670
_found is a private parameter, do not use it. It is used to indicate
2671
if format probing has already been done.
2674
# we are being called directly and must probe.
2675
raise NotImplementedError
2676
if not isinstance(a_bzrdir.transport, LocalTransport):
2677
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2678
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2684
class WorkingTreeFormat3(WorkingTreeFormat):
2685
"""The second working tree format updated to record a format marker.
2688
- exists within a metadir controlling .bzr
2689
- includes an explicit version marker for the workingtree control
2690
files, separate from the BzrDir format
2691
- modifies the hash cache format
2693
- uses a LockDir to guard access for writes.
2696
upgrade_recommended = True
2698
def get_format_string(self):
2699
"""See WorkingTreeFormat.get_format_string()."""
2700
return "Bazaar-NG Working Tree format 3"
2702
def get_format_description(self):
2703
"""See WorkingTreeFormat.get_format_description()."""
2704
return "Working tree format 3"
2706
_lock_file_name = 'lock'
2707
_lock_class = LockDir
2709
_tree_class = WorkingTree3
2711
def __get_matchingbzrdir(self):
2712
return bzrdir.BzrDirMetaFormat1()
2714
_matchingbzrdir = property(__get_matchingbzrdir)
2716
def _open_control_files(self, a_bzrdir):
2717
transport = a_bzrdir.get_workingtree_transport(None)
2718
return LockableFiles(transport, self._lock_file_name,
2721
def initialize(self, a_bzrdir, revision_id=None):
2722
"""See WorkingTreeFormat.initialize().
2724
revision_id allows creating a working tree at a different
2725
revision than the branch is at.
2727
if not isinstance(a_bzrdir.transport, LocalTransport):
2728
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2729
transport = a_bzrdir.get_workingtree_transport(self)
2730
control_files = self._open_control_files(a_bzrdir)
2731
control_files.create_lock()
2732
control_files.lock_write()
2733
control_files.put_utf8('format', self.get_format_string())
2734
branch = a_bzrdir.open_branch()
2735
if revision_id is None:
2736
revision_id = _mod_revision.ensure_null(branch.last_revision())
2738
revision_id = osutils.safe_revision_id(revision_id)
2739
# WorkingTree3 can handle an inventory which has a unique root id.
2740
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2741
# those trees. And because there isn't a format bump inbetween, we
2742
# are maintaining compatibility with older clients.
2743
# inv = Inventory(root_id=gen_root_id())
2744
inv = self._initial_inventory()
2745
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2751
_control_files=control_files)
2752
wt.lock_tree_write()
2754
basis_tree = branch.repository.revision_tree(revision_id)
2755
# only set an explicit root id if there is one to set.
2756
if basis_tree.inventory.root is not None:
2757
wt.set_root_id(basis_tree.inventory.root.file_id)
2758
if revision_id == NULL_REVISION:
2759
wt.set_parent_trees([])
2761
wt.set_parent_trees([(revision_id, basis_tree)])
2762
transform.build_tree(basis_tree, wt)
2764
# Unlock in this order so that the unlock-triggers-flush in
2765
# WorkingTree is given a chance to fire.
2766
control_files.unlock()
2770
def _initial_inventory(self):
2774
super(WorkingTreeFormat3, self).__init__()
2776
def open(self, a_bzrdir, _found=False):
2777
"""Return the WorkingTree object for a_bzrdir
2779
_found is a private parameter, do not use it. It is used to indicate
2780
if format probing has already been done.
2783
# we are being called directly and must probe.
2784
raise NotImplementedError
2785
if not isinstance(a_bzrdir.transport, LocalTransport):
2786
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2787
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2790
def _open(self, a_bzrdir, control_files):
2791
"""Open the tree itself.
2793
:param a_bzrdir: the dir for the tree.
2794
:param control_files: the control files for the tree.
2796
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2800
_control_files=control_files)
2803
return self.get_format_string()
2806
__default_format = WorkingTreeFormat4()
2807
WorkingTreeFormat.register_format(__default_format)
2808
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2809
WorkingTreeFormat.set_default_format(__default_format)
2810
# formats which have no format string are not discoverable
2811
# and not independently creatable, so are not registered.
2812
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
