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):
804
"""Merge from a branch into this working tree.
806
:param branch: The branch to merge from.
807
:param to_revision: If non-None, the merge will merge to to_revision,
808
but not beyond it. to_revision does not need to be in the history
809
of the branch when it is supplied. If None, to_revision defaults to
810
branch.last_revision().
812
from bzrlib.merge import Merger, Merge3Merger
813
pb = bzrlib.ui.ui_factory.nested_progress_bar()
815
merger = Merger(self.branch, this_tree=self, pb=pb)
816
merger.pp = ProgressPhase("Merge phase", 5, pb)
817
merger.pp.next_phase()
818
# check that there are no
820
merger.check_basis(check_clean=True, require_commits=False)
821
if to_revision is None:
822
to_revision = _mod_revision.ensure_null(branch.last_revision())
824
to_revision = osutils.safe_revision_id(to_revision)
825
merger.other_rev_id = to_revision
826
if _mod_revision.is_null(merger.other_rev_id):
827
raise errors.NoCommits(branch)
828
self.branch.fetch(branch, last_revision=merger.other_rev_id)
829
merger.other_basis = merger.other_rev_id
830
merger.other_tree = self.branch.repository.revision_tree(
832
merger.other_branch = branch
833
merger.pp.next_phase()
835
if merger.base_rev_id == merger.other_rev_id:
836
raise errors.PointlessMerge
837
merger.backup_files = False
838
merger.merge_type = Merge3Merger
839
merger.set_interesting_files(None)
840
merger.show_base = False
841
merger.reprocess = False
842
conflicts = merger.do_merge()
849
def merge_modified(self):
850
"""Return a dictionary of files modified by a merge.
852
The list is initialized by WorkingTree.set_merge_modified, which is
853
typically called after we make some automatic updates to the tree
856
This returns a map of file_id->sha1, containing only files which are
857
still in the working inventory and have that text hash.
860
hashfile = self._control_files.get('merge-hashes')
861
except errors.NoSuchFile:
865
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
866
raise errors.MergeModifiedFormatError()
867
except StopIteration:
868
raise errors.MergeModifiedFormatError()
869
for s in RioReader(hashfile):
870
# RioReader reads in Unicode, so convert file_ids back to utf8
871
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
872
if file_id not in self.inventory:
874
text_hash = s.get("hash")
875
if text_hash == self.get_file_sha1(file_id):
876
merge_hashes[file_id] = text_hash
880
def mkdir(self, path, file_id=None):
881
"""See MutableTree.mkdir()."""
883
file_id = generate_ids.gen_file_id(os.path.basename(path))
884
os.mkdir(self.abspath(path))
885
self.add(path, file_id, 'directory')
888
def get_symlink_target(self, file_id):
889
file_id = osutils.safe_file_id(file_id)
890
return os.readlink(self.id2abspath(file_id))
893
def subsume(self, other_tree):
894
def add_children(inventory, entry):
895
for child_entry in entry.children.values():
896
inventory._byid[child_entry.file_id] = child_entry
897
if child_entry.kind == 'directory':
898
add_children(inventory, child_entry)
899
if other_tree.get_root_id() == self.get_root_id():
900
raise errors.BadSubsumeSource(self, other_tree,
901
'Trees have the same root')
903
other_tree_path = self.relpath(other_tree.basedir)
904
except errors.PathNotChild:
905
raise errors.BadSubsumeSource(self, other_tree,
906
'Tree is not contained by the other')
907
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
908
if new_root_parent is None:
909
raise errors.BadSubsumeSource(self, other_tree,
910
'Parent directory is not versioned.')
911
# We need to ensure that the result of a fetch will have a
912
# versionedfile for the other_tree root, and only fetching into
913
# RepositoryKnit2 guarantees that.
914
if not self.branch.repository.supports_rich_root():
915
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
916
other_tree.lock_tree_write()
918
new_parents = other_tree.get_parent_ids()
919
other_root = other_tree.inventory.root
920
other_root.parent_id = new_root_parent
921
other_root.name = osutils.basename(other_tree_path)
922
self.inventory.add(other_root)
923
add_children(self.inventory, other_root)
924
self._write_inventory(self.inventory)
925
# normally we don't want to fetch whole repositories, but i think
926
# here we really do want to consolidate the whole thing.
927
for parent_id in other_tree.get_parent_ids():
928
self.branch.fetch(other_tree.branch, parent_id)
929
self.add_parent_tree_id(parent_id)
932
other_tree.bzrdir.retire_bzrdir()
934
@needs_tree_write_lock
935
def extract(self, file_id, format=None):
936
"""Extract a subtree from this tree.
938
A new branch will be created, relative to the path for this tree.
942
segments = osutils.splitpath(path)
943
transport = self.branch.bzrdir.root_transport
944
for name in segments:
945
transport = transport.clone(name)
946
transport.ensure_base()
949
sub_path = self.id2path(file_id)
950
branch_transport = mkdirs(sub_path)
952
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
953
branch_transport.ensure_base()
954
branch_bzrdir = format.initialize_on_transport(branch_transport)
956
repo = branch_bzrdir.find_repository()
957
except errors.NoRepositoryPresent:
958
repo = branch_bzrdir.create_repository()
959
assert repo.supports_rich_root()
961
if not repo.supports_rich_root():
962
raise errors.RootNotRich()
963
new_branch = branch_bzrdir.create_branch()
964
new_branch.pull(self.branch)
965
for parent_id in self.get_parent_ids():
966
new_branch.fetch(self.branch, parent_id)
967
tree_transport = self.bzrdir.root_transport.clone(sub_path)
968
if tree_transport.base != branch_transport.base:
969
tree_bzrdir = format.initialize_on_transport(tree_transport)
970
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
972
tree_bzrdir = branch_bzrdir
973
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
974
wt.set_parent_ids(self.get_parent_ids())
975
my_inv = self.inventory
976
child_inv = Inventory(root_id=None)
977
new_root = my_inv[file_id]
978
my_inv.remove_recursive_id(file_id)
979
new_root.parent_id = None
980
child_inv.add(new_root)
981
self._write_inventory(my_inv)
982
wt._write_inventory(child_inv)
985
def _serialize(self, inventory, out_file):
986
xml5.serializer_v5.write_inventory(self._inventory, out_file)
988
def _deserialize(selt, in_file):
989
return xml5.serializer_v5.read_inventory(in_file)
992
"""Write the in memory inventory to disk."""
993
# TODO: Maybe this should only write on dirty ?
994
if self._control_files._lock_mode != 'w':
995
raise errors.NotWriteLocked(self)
997
self._serialize(self._inventory, sio)
999
self._control_files.put('inventory', sio)
1000
self._inventory_is_modified = False
1002
def _kind(self, relpath):
1003
return osutils.file_kind(self.abspath(relpath))
1005
def list_files(self, include_root=False):
1006
"""Recursively list all files as (path, class, kind, id, entry).
1008
Lists, but does not descend into unversioned directories.
1010
This does not include files that have been deleted in this
1013
Skips the control directory.
1015
# list_files is an iterator, so @needs_read_lock doesn't work properly
1016
# with it. So callers should be careful to always read_lock the tree.
1017
if not self.is_locked():
1018
raise errors.ObjectNotLocked(self)
1020
inv = self.inventory
1021
if include_root is True:
1022
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1023
# Convert these into local objects to save lookup times
1024
pathjoin = osutils.pathjoin
1025
file_kind = self._kind
1027
# transport.base ends in a slash, we want the piece
1028
# between the last two slashes
1029
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1031
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1033
# directory file_id, relative path, absolute path, reverse sorted children
1034
children = os.listdir(self.basedir)
1036
# jam 20060527 The kernel sized tree seems equivalent whether we
1037
# use a deque and popleft to keep them sorted, or if we use a plain
1038
# list and just reverse() them.
1039
children = collections.deque(children)
1040
stack = [(inv.root.file_id, u'', self.basedir, children)]
1042
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1045
f = children.popleft()
1046
## TODO: If we find a subdirectory with its own .bzr
1047
## directory, then that is a separate tree and we
1048
## should exclude it.
1050
# the bzrdir for this tree
1051
if transport_base_dir == f:
1054
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1055
# and 'f' doesn't begin with one, we can do a string op, rather
1056
# than the checks of pathjoin(), all relative paths will have an extra slash
1058
fp = from_dir_relpath + '/' + f
1061
fap = from_dir_abspath + '/' + f
1063
f_ie = inv.get_child(from_dir_id, f)
1066
elif self.is_ignored(fp[1:]):
1069
# we may not have found this file, because of a unicode issue
1070
f_norm, can_access = osutils.normalized_filename(f)
1071
if f == f_norm or not can_access:
1072
# No change, so treat this file normally
1075
# this file can be accessed by a normalized path
1076
# check again if it is versioned
1077
# these lines are repeated here for performance
1079
fp = from_dir_relpath + '/' + f
1080
fap = from_dir_abspath + '/' + f
1081
f_ie = inv.get_child(from_dir_id, f)
1084
elif self.is_ignored(fp[1:]):
1091
# make a last minute entry
1093
yield fp[1:], c, fk, f_ie.file_id, f_ie
1096
yield fp[1:], c, fk, None, fk_entries[fk]()
1098
yield fp[1:], c, fk, None, TreeEntry()
1101
if fk != 'directory':
1104
# But do this child first
1105
new_children = os.listdir(fap)
1107
new_children = collections.deque(new_children)
1108
stack.append((f_ie.file_id, fp, fap, new_children))
1109
# Break out of inner loop,
1110
# so that we start outer loop with child
1113
# if we finished all children, pop it off the stack
1116
@needs_tree_write_lock
1117
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1120
to_dir must exist in the inventory.
1122
If to_dir exists and is a directory, the files are moved into
1123
it, keeping their old names.
1125
Note that to_dir is only the last component of the new name;
1126
this doesn't change the directory.
1128
For each entry in from_paths the move mode will be determined
1131
The first mode moves the file in the filesystem and updates the
1132
inventory. The second mode only updates the inventory without
1133
touching the file on the filesystem. This is the new mode introduced
1136
move uses the second mode if 'after == True' and the target is not
1137
versioned but present in the working tree.
1139
move uses the second mode if 'after == False' and the source is
1140
versioned but no longer in the working tree, and the target is not
1141
versioned but present in the working tree.
1143
move uses the first mode if 'after == False' and the source is
1144
versioned and present in the working tree, and the target is not
1145
versioned and not present in the working tree.
1147
Everything else results in an error.
1149
This returns a list of (from_path, to_path) pairs for each
1150
entry that is moved.
1155
# check for deprecated use of signature
1157
to_dir = kwargs.get('to_name', None)
1159
raise TypeError('You must supply a target directory')
1161
symbol_versioning.warn('The parameter to_name was deprecated'
1162
' in version 0.13. Use to_dir instead',
1165
# check destination directory
1166
assert not isinstance(from_paths, basestring)
1167
inv = self.inventory
1168
to_abs = self.abspath(to_dir)
1169
if not isdir(to_abs):
1170
raise errors.BzrMoveFailedError('',to_dir,
1171
errors.NotADirectory(to_abs))
1172
if not self.has_filename(to_dir):
1173
raise errors.BzrMoveFailedError('',to_dir,
1174
errors.NotInWorkingDirectory(to_dir))
1175
to_dir_id = inv.path2id(to_dir)
1176
if to_dir_id is None:
1177
raise errors.BzrMoveFailedError('',to_dir,
1178
errors.NotVersionedError(path=str(to_dir)))
1180
to_dir_ie = inv[to_dir_id]
1181
if to_dir_ie.kind != 'directory':
1182
raise errors.BzrMoveFailedError('',to_dir,
1183
errors.NotADirectory(to_abs))
1185
# create rename entries and tuples
1186
for from_rel in from_paths:
1187
from_tail = splitpath(from_rel)[-1]
1188
from_id = inv.path2id(from_rel)
1190
raise errors.BzrMoveFailedError(from_rel,to_dir,
1191
errors.NotVersionedError(path=str(from_rel)))
1193
from_entry = inv[from_id]
1194
from_parent_id = from_entry.parent_id
1195
to_rel = pathjoin(to_dir, from_tail)
1196
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1198
from_tail=from_tail,
1199
from_parent_id=from_parent_id,
1200
to_rel=to_rel, to_tail=from_tail,
1201
to_parent_id=to_dir_id)
1202
rename_entries.append(rename_entry)
1203
rename_tuples.append((from_rel, to_rel))
1205
# determine which move mode to use. checks also for movability
1206
rename_entries = self._determine_mv_mode(rename_entries, after)
1208
original_modified = self._inventory_is_modified
1211
self._inventory_is_modified = True
1212
self._move(rename_entries)
1214
# restore the inventory on error
1215
self._inventory_is_modified = original_modified
1217
self._write_inventory(inv)
1218
return rename_tuples
1220
def _determine_mv_mode(self, rename_entries, after=False):
1221
"""Determines for each from-to pair if both inventory and working tree
1222
or only the inventory has to be changed.
1224
Also does basic plausability tests.
1226
inv = self.inventory
1228
for rename_entry in rename_entries:
1229
# store to local variables for easier reference
1230
from_rel = rename_entry.from_rel
1231
from_id = rename_entry.from_id
1232
to_rel = rename_entry.to_rel
1233
to_id = inv.path2id(to_rel)
1234
only_change_inv = False
1236
# check the inventory for source and destination
1238
raise errors.BzrMoveFailedError(from_rel,to_rel,
1239
errors.NotVersionedError(path=str(from_rel)))
1240
if to_id is not None:
1241
raise errors.BzrMoveFailedError(from_rel,to_rel,
1242
errors.AlreadyVersionedError(path=str(to_rel)))
1244
# try to determine the mode for rename (only change inv or change
1245
# inv and file system)
1247
if not self.has_filename(to_rel):
1248
raise errors.BzrMoveFailedError(from_id,to_rel,
1249
errors.NoSuchFile(path=str(to_rel),
1250
extra="New file has not been created yet"))
1251
only_change_inv = True
1252
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1253
only_change_inv = True
1254
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1255
only_change_inv = False
1257
# something is wrong, so lets determine what exactly
1258
if not self.has_filename(from_rel) and \
1259
not self.has_filename(to_rel):
1260
raise errors.BzrRenameFailedError(from_rel,to_rel,
1261
errors.PathsDoNotExist(paths=(str(from_rel),
1264
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1265
extra="(Use --after to update the Bazaar id)")
1266
rename_entry.only_change_inv = only_change_inv
1267
return rename_entries
1269
def _move(self, rename_entries):
1270
"""Moves a list of files.
1272
Depending on the value of the flag 'only_change_inv', the
1273
file will be moved on the file system or not.
1275
inv = self.inventory
1278
for entry in rename_entries:
1280
self._move_entry(entry)
1282
self._rollback_move(moved)
1286
def _rollback_move(self, moved):
1287
"""Try to rollback a previous move in case of an filesystem error."""
1288
inv = self.inventory
1291
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1292
entry.to_tail, entry.to_parent_id, entry.from_rel,
1293
entry.from_tail, entry.from_parent_id,
1294
entry.only_change_inv))
1295
except errors.BzrMoveFailedError, e:
1296
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1297
" The working tree is in an inconsistent state."
1298
" Please consider doing a 'bzr revert'."
1299
" Error message is: %s" % e)
1301
def _move_entry(self, entry):
1302
inv = self.inventory
1303
from_rel_abs = self.abspath(entry.from_rel)
1304
to_rel_abs = self.abspath(entry.to_rel)
1305
if from_rel_abs == to_rel_abs:
1306
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1307
"Source and target are identical.")
1309
if not entry.only_change_inv:
1311
osutils.rename(from_rel_abs, to_rel_abs)
1313
raise errors.BzrMoveFailedError(entry.from_rel,
1315
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1317
@needs_tree_write_lock
1318
def rename_one(self, from_rel, to_rel, after=False):
1321
This can change the directory or the filename or both.
1323
rename_one has several 'modes' to work. First, it can rename a physical
1324
file and change the file_id. That is the normal mode. Second, it can
1325
only change the file_id without touching any physical file. This is
1326
the new mode introduced in version 0.15.
1328
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1329
versioned but present in the working tree.
1331
rename_one uses the second mode if 'after == False' and 'from_rel' is
1332
versioned but no longer in the working tree, and 'to_rel' is not
1333
versioned but present in the working tree.
1335
rename_one uses the first mode if 'after == False' and 'from_rel' is
1336
versioned and present in the working tree, and 'to_rel' is not
1337
versioned and not present in the working tree.
1339
Everything else results in an error.
1341
inv = self.inventory
1344
# create rename entries and tuples
1345
from_tail = splitpath(from_rel)[-1]
1346
from_id = inv.path2id(from_rel)
1348
raise errors.BzrRenameFailedError(from_rel,to_rel,
1349
errors.NotVersionedError(path=str(from_rel)))
1350
from_entry = inv[from_id]
1351
from_parent_id = from_entry.parent_id
1352
to_dir, to_tail = os.path.split(to_rel)
1353
to_dir_id = inv.path2id(to_dir)
1354
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1356
from_tail=from_tail,
1357
from_parent_id=from_parent_id,
1358
to_rel=to_rel, to_tail=to_tail,
1359
to_parent_id=to_dir_id)
1360
rename_entries.append(rename_entry)
1362
# determine which move mode to use. checks also for movability
1363
rename_entries = self._determine_mv_mode(rename_entries, after)
1365
# check if the target changed directory and if the target directory is
1367
if to_dir_id is None:
1368
raise errors.BzrMoveFailedError(from_rel,to_rel,
1369
errors.NotVersionedError(path=str(to_dir)))
1371
# all checks done. now we can continue with our actual work
1372
mutter('rename_one:\n'
1377
' to_dir_id {%s}\n',
1378
from_id, from_rel, to_rel, to_dir, to_dir_id)
1380
self._move(rename_entries)
1381
self._write_inventory(inv)
1383
class _RenameEntry(object):
1384
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1385
to_rel, to_tail, to_parent_id, only_change_inv=False):
1386
self.from_rel = from_rel
1387
self.from_id = from_id
1388
self.from_tail = from_tail
1389
self.from_parent_id = from_parent_id
1390
self.to_rel = to_rel
1391
self.to_tail = to_tail
1392
self.to_parent_id = to_parent_id
1393
self.only_change_inv = only_change_inv
1397
"""Return all unknown files.
1399
These are files in the working directory that are not versioned or
1400
control files or ignored.
1402
# force the extras method to be fully executed before returning, to
1403
# prevent race conditions with the lock
1405
[subp for subp in self.extras() if not self.is_ignored(subp)])
1407
@needs_tree_write_lock
1408
def unversion(self, file_ids):
1409
"""Remove the file ids in file_ids from the current versioned set.
1411
When a file_id is unversioned, all of its children are automatically
1414
:param file_ids: The file ids to stop versioning.
1415
:raises: NoSuchId if any fileid is not currently versioned.
1417
for file_id in file_ids:
1418
file_id = osutils.safe_file_id(file_id)
1419
if self._inventory.has_id(file_id):
1420
self._inventory.remove_recursive_id(file_id)
1422
raise errors.NoSuchId(self, file_id)
1424
# in the future this should just set a dirty bit to wait for the
1425
# final unlock. However, until all methods of workingtree start
1426
# with the current in -memory inventory rather than triggering
1427
# a read, it is more complex - we need to teach read_inventory
1428
# to know when to read, and when to not read first... and possibly
1429
# to save first when the in memory one may be corrupted.
1430
# so for now, we just only write it if it is indeed dirty.
1432
self._write_inventory(self._inventory)
1434
@deprecated_method(zero_eight)
1435
def iter_conflicts(self):
1436
"""List all files in the tree that have text or content conflicts.
1437
DEPRECATED. Use conflicts instead."""
1438
return self._iter_conflicts()
1440
def _iter_conflicts(self):
1442
for info in self.list_files():
1444
stem = get_conflicted_stem(path)
1447
if stem not in conflicted:
1448
conflicted.add(stem)
1452
def pull(self, source, overwrite=False, stop_revision=None,
1453
change_reporter=None):
1454
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1457
pp = ProgressPhase("Pull phase", 2, top_pb)
1459
old_revision_info = self.branch.last_revision_info()
1460
basis_tree = self.basis_tree()
1461
count = self.branch.pull(source, overwrite, stop_revision)
1462
new_revision_info = self.branch.last_revision_info()
1463
if new_revision_info != old_revision_info:
1465
repository = self.branch.repository
1466
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1467
basis_tree.lock_read()
1469
new_basis_tree = self.branch.basis_tree()
1476
change_reporter=change_reporter)
1477
if (basis_tree.inventory.root is None and
1478
new_basis_tree.inventory.root is not None):
1479
self.set_root_id(new_basis_tree.inventory.root.file_id)
1483
# TODO - dedup parents list with things merged by pull ?
1484
# reuse the revisiontree we merged against to set the new
1486
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1487
# we have to pull the merge trees out again, because
1488
# merge_inner has set the ids. - this corner is not yet
1489
# layered well enough to prevent double handling.
1490
# XXX TODO: Fix the double handling: telling the tree about
1491
# the already known parent data is wasteful.
1492
merges = self.get_parent_ids()[1:]
1493
parent_trees.extend([
1494
(parent, repository.revision_tree(parent)) for
1496
self.set_parent_trees(parent_trees)
1503
def put_file_bytes_non_atomic(self, file_id, bytes):
1504
"""See MutableTree.put_file_bytes_non_atomic."""
1505
file_id = osutils.safe_file_id(file_id)
1506
stream = file(self.id2abspath(file_id), 'wb')
1511
# TODO: update the hashcache here ?
1514
"""Yield all unversioned files in this WorkingTree.
1516
If there are any unversioned directories then only the directory is
1517
returned, not all its children. But if there are unversioned files
1518
under a versioned subdirectory, they are returned.
1520
Currently returned depth-first, sorted by name within directories.
1521
This is the same order used by 'osutils.walkdirs'.
1523
## TODO: Work from given directory downwards
1524
for path, dir_entry in self.inventory.directories():
1525
# mutter("search for unknowns in %r", path)
1526
dirabs = self.abspath(path)
1527
if not isdir(dirabs):
1528
# e.g. directory deleted
1532
for subf in os.listdir(dirabs):
1535
if subf not in dir_entry.children:
1536
subf_norm, can_access = osutils.normalized_filename(subf)
1537
if subf_norm != subf and can_access:
1538
if subf_norm not in dir_entry.children:
1539
fl.append(subf_norm)
1545
subp = pathjoin(path, subf)
1548
def ignored_files(self):
1549
"""Yield list of PATH, IGNORE_PATTERN"""
1550
for subp in self.extras():
1551
pat = self.is_ignored(subp)
1555
def get_ignore_list(self):
1556
"""Return list of ignore patterns.
1558
Cached in the Tree object after the first call.
1560
ignoreset = getattr(self, '_ignoreset', None)
1561
if ignoreset is not None:
1564
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1565
ignore_globs.update(ignores.get_runtime_ignores())
1566
ignore_globs.update(ignores.get_user_ignores())
1567
if self.has_filename(bzrlib.IGNORE_FILENAME):
1568
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1570
ignore_globs.update(ignores.parse_ignore_file(f))
1573
self._ignoreset = ignore_globs
1576
def _flush_ignore_list_cache(self):
1577
"""Resets the cached ignore list to force a cache rebuild."""
1578
self._ignoreset = None
1579
self._ignoreglobster = None
1581
def is_ignored(self, filename):
1582
r"""Check whether the filename matches an ignore pattern.
1584
Patterns containing '/' or '\' need to match the whole path;
1585
others match against only the last component.
1587
If the file is ignored, returns the pattern which caused it to
1588
be ignored, otherwise None. So this can simply be used as a
1589
boolean if desired."""
1590
if getattr(self, '_ignoreglobster', None) is None:
1591
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1592
return self._ignoreglobster.match(filename)
1594
def kind(self, file_id):
1595
return file_kind(self.id2abspath(file_id))
1597
def _comparison_data(self, entry, path):
1598
abspath = self.abspath(path)
1600
stat_value = os.lstat(abspath)
1602
if getattr(e, 'errno', None) == errno.ENOENT:
1609
mode = stat_value.st_mode
1610
kind = osutils.file_kind_from_stat_mode(mode)
1611
if not supports_executable():
1612
executable = entry is not None and entry.executable
1614
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1615
return kind, executable, stat_value
1617
def _file_size(self, entry, stat_value):
1618
return stat_value.st_size
1620
def last_revision(self):
1621
"""Return the last revision of the branch for this tree.
1623
This format tree does not support a separate marker for last-revision
1624
compared to the branch.
1626
See MutableTree.last_revision
1628
return self._last_revision()
1631
def _last_revision(self):
1632
"""helper for get_parent_ids."""
1633
return self.branch.last_revision()
1635
def is_locked(self):
1636
return self._control_files.is_locked()
1638
def _must_be_locked(self):
1639
if not self.is_locked():
1640
raise errors.ObjectNotLocked(self)
1642
def lock_read(self):
1643
"""See Branch.lock_read, and WorkingTree.unlock."""
1644
if not self.is_locked():
1646
self.branch.lock_read()
1648
return self._control_files.lock_read()
1650
self.branch.unlock()
1653
def lock_tree_write(self):
1654
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1655
if not self.is_locked():
1657
self.branch.lock_read()
1659
return self._control_files.lock_write()
1661
self.branch.unlock()
1664
def lock_write(self):
1665
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1666
if not self.is_locked():
1668
self.branch.lock_write()
1670
return self._control_files.lock_write()
1672
self.branch.unlock()
1675
def get_physical_lock_status(self):
1676
return self._control_files.get_physical_lock_status()
1678
def _basis_inventory_name(self):
1679
return 'basis-inventory-cache'
1681
def _reset_data(self):
1682
"""Reset transient data that cannot be revalidated."""
1683
self._inventory_is_modified = False
1684
result = self._deserialize(self._control_files.get('inventory'))
1685
self._set_inventory(result, dirty=False)
1687
@needs_tree_write_lock
1688
def set_last_revision(self, new_revision):
1689
"""Change the last revision in the working tree."""
1690
new_revision = osutils.safe_revision_id(new_revision)
1691
if self._change_last_revision(new_revision):
1692
self._cache_basis_inventory(new_revision)
1694
def _change_last_revision(self, new_revision):
1695
"""Template method part of set_last_revision to perform the change.
1697
This is used to allow WorkingTree3 instances to not affect branch
1698
when their last revision is set.
1700
if _mod_revision.is_null(new_revision):
1701
self.branch.set_revision_history([])
1704
self.branch.generate_revision_history(new_revision)
1705
except errors.NoSuchRevision:
1706
# not present in the repo - dont try to set it deeper than the tip
1707
self.branch.set_revision_history([new_revision])
1710
def _write_basis_inventory(self, xml):
1711
"""Write the basis inventory XML to the basis-inventory file"""
1712
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1713
path = self._basis_inventory_name()
1715
self._control_files.put(path, sio)
1717
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1718
"""Create the text that will be saved in basis-inventory"""
1719
# TODO: jam 20070209 This should be redundant, as the revision_id
1720
# as all callers should have already converted the revision_id to
1722
inventory.revision_id = osutils.safe_revision_id(revision_id)
1723
return xml7.serializer_v7.write_inventory_to_string(inventory)
1725
def _cache_basis_inventory(self, new_revision):
1726
"""Cache new_revision as the basis inventory."""
1727
# TODO: this should allow the ready-to-use inventory to be passed in,
1728
# as commit already has that ready-to-use [while the format is the
1731
# this double handles the inventory - unpack and repack -
1732
# but is easier to understand. We can/should put a conditional
1733
# in here based on whether the inventory is in the latest format
1734
# - perhaps we should repack all inventories on a repository
1736
# the fast path is to copy the raw xml from the repository. If the
1737
# xml contains 'revision_id="', then we assume the right
1738
# revision_id is set. We must check for this full string, because a
1739
# root node id can legitimately look like 'revision_id' but cannot
1741
xml = self.branch.repository.get_inventory_xml(new_revision)
1742
firstline = xml.split('\n', 1)[0]
1743
if (not 'revision_id="' in firstline or
1744
'format="7"' not in firstline):
1745
inv = self.branch.repository.deserialise_inventory(
1747
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1748
self._write_basis_inventory(xml)
1749
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1752
def read_basis_inventory(self):
1753
"""Read the cached basis inventory."""
1754
path = self._basis_inventory_name()
1755
return self._control_files.get(path).read()
1758
def read_working_inventory(self):
1759
"""Read the working inventory.
1761
:raises errors.InventoryModified: read_working_inventory will fail
1762
when the current in memory inventory has been modified.
1764
# conceptually this should be an implementation detail of the tree.
1765
# XXX: Deprecate this.
1766
# ElementTree does its own conversion from UTF-8, so open in
1768
if self._inventory_is_modified:
1769
raise errors.InventoryModified(self)
1770
result = self._deserialize(self._control_files.get('inventory'))
1771
self._set_inventory(result, dirty=False)
1774
@needs_tree_write_lock
1775
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1777
"""Remove nominated files from the working inventory.
1779
:files: File paths relative to the basedir.
1780
:keep_files: If true, the files will also be kept.
1781
:force: Delete files and directories, even if they are changed and
1782
even if the directories are not empty.
1784
## TODO: Normalize names
1786
if isinstance(files, basestring):
1792
unknown_files_in_directory=set()
1794
def recurse_directory_to_add_files(directory):
1795
# recurse directory and add all files
1796
# so we can check if they have changed.
1797
for parent_info, file_infos in\
1798
osutils.walkdirs(self.abspath(directory),
1800
for relpath, basename, kind, lstat, abspath in file_infos:
1802
if self.path2id(relpath): #is it versioned?
1803
new_files.add(relpath)
1805
unknown_files_in_directory.add(
1806
(relpath, None, kind))
1808
for filename in files:
1809
# Get file name into canonical form.
1810
abspath = self.abspath(filename)
1811
filename = self.relpath(abspath)
1812
if len(filename) > 0:
1813
new_files.add(filename)
1814
if osutils.isdir(abspath):
1815
recurse_directory_to_add_files(filename)
1816
files = [f for f in new_files]
1819
return # nothing to do
1821
# Sort needed to first handle directory content before the directory
1822
files.sort(reverse=True)
1823
if not keep_files and not force:
1824
has_changed_files = len(unknown_files_in_directory) > 0
1825
if not has_changed_files:
1826
for (file_id, path, content_change, versioned, parent_id, name,
1827
kind, executable) in self._iter_changes(self.basis_tree(),
1828
include_unchanged=True, require_versioned=False,
1829
want_unversioned=True, specific_files=files):
1830
# check if it's unknown OR changed but not deleted:
1831
if (versioned == (False, False)
1832
or (content_change and kind[1] != None)):
1833
has_changed_files = True
1836
if has_changed_files:
1837
# make delta to show ALL applicable changes in error message.
1838
tree_delta = self.changes_from(self.basis_tree(),
1839
specific_files=files)
1840
for unknown_file in unknown_files_in_directory:
1841
tree_delta.unversioned.extend((unknown_file,))
1842
raise errors.BzrRemoveChangedFilesError(tree_delta)
1844
# do this before any modifications
1846
fid = self.path2id(f)
1849
message="%s is not versioned." % (f,)
1852
# having removed it, it must be either ignored or unknown
1853
if self.is_ignored(f):
1857
textui.show_status(new_status, self.kind(fid), f,
1860
inv_delta.append((f, None, fid, None))
1861
message="removed %s" % (f,)
1864
abs_path = self.abspath(f)
1865
if osutils.lexists(abs_path):
1866
if (osutils.isdir(abs_path) and
1867
len(os.listdir(abs_path)) > 0):
1868
message="%s is not 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, old_tree=None, backups=True,
1884
pb=DummyProgress(), report_changes=False):
1885
from bzrlib.conflicts import resolve
1886
if old_tree is None:
1887
old_tree = self.basis_tree()
1888
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1890
if not len(filenames):
1891
self.set_parent_ids(self.get_parent_ids()[:1])
1894
resolve(self, filenames, ignore_misses=True)
1897
def revision_tree(self, revision_id):
1898
"""See Tree.revision_tree.
1900
WorkingTree can supply revision_trees for the basis revision only
1901
because there is only one cached inventory in the bzr directory.
1903
if revision_id == self.last_revision():
1905
xml = self.read_basis_inventory()
1906
except errors.NoSuchFile:
1910
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1911
# dont use the repository revision_tree api because we want
1912
# to supply the inventory.
1913
if inv.revision_id == revision_id:
1914
return revisiontree.RevisionTree(self.branch.repository,
1916
except errors.BadInventoryFormat:
1918
# raise if there was no inventory, or if we read the wrong inventory.
1919
raise errors.NoSuchRevisionInTree(self, revision_id)
1921
# XXX: This method should be deprecated in favour of taking in a proper
1922
# new Inventory object.
1923
@needs_tree_write_lock
1924
def set_inventory(self, new_inventory_list):
1925
from bzrlib.inventory import (Inventory,
1930
inv = Inventory(self.get_root_id())
1931
for path, file_id, parent, kind in new_inventory_list:
1932
name = os.path.basename(path)
1935
# fixme, there should be a factory function inv,add_??
1936
if kind == 'directory':
1937
inv.add(InventoryDirectory(file_id, name, parent))
1938
elif kind == 'file':
1939
inv.add(InventoryFile(file_id, name, parent))
1940
elif kind == 'symlink':
1941
inv.add(InventoryLink(file_id, name, parent))
1943
raise errors.BzrError("unknown kind %r" % kind)
1944
self._write_inventory(inv)
1946
@needs_tree_write_lock
1947
def set_root_id(self, file_id):
1948
"""Set the root id for this tree."""
1951
symbol_versioning.warn(symbol_versioning.zero_twelve
1952
% 'WorkingTree.set_root_id with fileid=None',
1957
file_id = osutils.safe_file_id(file_id)
1958
self._set_root_id(file_id)
1960
def _set_root_id(self, file_id):
1961
"""Set the root id for this tree, in a format specific manner.
1963
:param file_id: The file id to assign to the root. It must not be
1964
present in the current inventory or an error will occur. It must
1965
not be None, but rather a valid file id.
1967
inv = self._inventory
1968
orig_root_id = inv.root.file_id
1969
# TODO: it might be nice to exit early if there was nothing
1970
# to do, saving us from trigger a sync on unlock.
1971
self._inventory_is_modified = True
1972
# we preserve the root inventory entry object, but
1973
# unlinkit from the byid index
1974
del inv._byid[inv.root.file_id]
1975
inv.root.file_id = file_id
1976
# and link it into the index with the new changed id.
1977
inv._byid[inv.root.file_id] = inv.root
1978
# and finally update all children to reference the new id.
1979
# XXX: this should be safe to just look at the root.children
1980
# list, not the WHOLE INVENTORY.
1983
if entry.parent_id == orig_root_id:
1984
entry.parent_id = inv.root.file_id
1987
"""See Branch.unlock.
1989
WorkingTree locking just uses the Branch locking facilities.
1990
This is current because all working trees have an embedded branch
1991
within them. IF in the future, we were to make branch data shareable
1992
between multiple working trees, i.e. via shared storage, then we
1993
would probably want to lock both the local tree, and the branch.
1995
raise NotImplementedError(self.unlock)
1997
def update(self, change_reporter=None):
1998
"""Update a working tree along its branch.
2000
This will update the branch if its bound too, which means we have
2001
multiple trees involved:
2003
- The new basis tree of the master.
2004
- The old basis tree of the branch.
2005
- The old basis tree of the working tree.
2006
- The current working tree state.
2008
Pathologically, all three may be different, and non-ancestors of each
2009
other. Conceptually we want to:
2011
- Preserve the wt.basis->wt.state changes
2012
- Transform the wt.basis to the new master basis.
2013
- Apply a merge of the old branch basis to get any 'local' changes from
2015
- Restore the wt.basis->wt.state changes.
2017
There isn't a single operation at the moment to do that, so we:
2018
- Merge current state -> basis tree of the master w.r.t. the old tree
2020
- Do a 'normal' merge of the old branch basis if it is relevant.
2022
if self.branch.get_master_branch() is not None:
2024
update_branch = True
2026
self.lock_tree_write()
2027
update_branch = False
2030
old_tip = self.branch.update()
2033
return self._update_tree(old_tip, change_reporter)
2037
@needs_tree_write_lock
2038
def _update_tree(self, old_tip=None, change_reporter=None):
2039
"""Update a tree to the master branch.
2041
:param old_tip: if supplied, the previous tip revision the branch,
2042
before it was changed to the master branch's tip.
2044
# here if old_tip is not None, it is the old tip of the branch before
2045
# it was updated from the master branch. This should become a pending
2046
# merge in the working tree to preserve the user existing work. we
2047
# cant set that until we update the working trees last revision to be
2048
# one from the new branch, because it will just get absorbed by the
2049
# parent de-duplication logic.
2051
# We MUST save it even if an error occurs, because otherwise the users
2052
# local work is unreferenced and will appear to have been lost.
2056
last_rev = self.get_parent_ids()[0]
2058
last_rev = _mod_revision.NULL_REVISION
2059
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2060
# merge tree state up to new branch tip.
2061
basis = self.basis_tree()
2064
to_tree = self.branch.basis_tree()
2065
if basis.inventory.root is None:
2066
self.set_root_id(to_tree.inventory.root.file_id)
2068
result += merge.merge_inner(
2073
change_reporter=change_reporter)
2076
# TODO - dedup parents list with things merged by pull ?
2077
# reuse the tree we've updated to to set the basis:
2078
parent_trees = [(self.branch.last_revision(), to_tree)]
2079
merges = self.get_parent_ids()[1:]
2080
# Ideally we ask the tree for the trees here, that way the working
2081
# tree can decide whether to give us teh entire tree or give us a
2082
# lazy initialised tree. dirstate for instance will have the trees
2083
# in ram already, whereas a last-revision + basis-inventory tree
2084
# will not, but also does not need them when setting parents.
2085
for parent in merges:
2086
parent_trees.append(
2087
(parent, self.branch.repository.revision_tree(parent)))
2088
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2089
parent_trees.append(
2090
(old_tip, self.branch.repository.revision_tree(old_tip)))
2091
self.set_parent_trees(parent_trees)
2092
last_rev = parent_trees[0][0]
2094
# the working tree had the same last-revision as the master
2095
# branch did. We may still have pivot local work from the local
2096
# branch into old_tip:
2097
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2098
self.add_parent_tree_id(old_tip)
2099
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2100
and old_tip != last_rev):
2101
# our last revision was not the prior branch last revision
2102
# and we have converted that last revision to a pending merge.
2103
# base is somewhere between the branch tip now
2104
# and the now pending merge
2106
# Since we just modified the working tree and inventory, flush out
2107
# the current state, before we modify it again.
2108
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2109
# requires it only because TreeTransform directly munges the
2110
# inventory and calls tree._write_inventory(). Ultimately we
2111
# should be able to remove this extra flush.
2113
graph = self.branch.repository.get_graph()
2114
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2116
base_tree = self.branch.repository.revision_tree(base_rev_id)
2117
other_tree = self.branch.repository.revision_tree(old_tip)
2118
result += merge.merge_inner(
2123
change_reporter=change_reporter)
2126
def _write_hashcache_if_dirty(self):
2127
"""Write out the hashcache if it is dirty."""
2128
if self._hashcache.needs_write:
2130
self._hashcache.write()
2132
if e.errno not in (errno.EPERM, errno.EACCES):
2134
# TODO: jam 20061219 Should this be a warning? A single line
2135
# warning might be sufficient to let the user know what
2137
mutter('Could not write hashcache for %s\nError: %s',
2138
self._hashcache.cache_file_name(), e)
2140
@needs_tree_write_lock
2141
def _write_inventory(self, inv):
2142
"""Write inventory as the current inventory."""
2143
self._set_inventory(inv, dirty=True)
2146
def set_conflicts(self, arg):
2147
raise errors.UnsupportedOperation(self.set_conflicts, self)
2149
def add_conflicts(self, arg):
2150
raise errors.UnsupportedOperation(self.add_conflicts, self)
2153
def conflicts(self):
2154
conflicts = _mod_conflicts.ConflictList()
2155
for conflicted in self._iter_conflicts():
2158
if file_kind(self.abspath(conflicted)) != "file":
2160
except errors.NoSuchFile:
2163
for suffix in ('.THIS', '.OTHER'):
2165
kind = file_kind(self.abspath(conflicted+suffix))
2168
except errors.NoSuchFile:
2172
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2173
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2175
file_id=self.path2id(conflicted)))
2178
def walkdirs(self, prefix=""):
2179
"""Walk the directories of this tree.
2181
returns a generator which yields items in the form:
2182
((curren_directory_path, fileid),
2183
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2186
This API returns a generator, which is only valid during the current
2187
tree transaction - within a single lock_read or lock_write duration.
2189
If the tree is not locked, it may cause an error to be raised,
2190
depending on the tree implementation.
2192
disk_top = self.abspath(prefix)
2193
if disk_top.endswith('/'):
2194
disk_top = disk_top[:-1]
2195
top_strip_len = len(disk_top) + 1
2196
inventory_iterator = self._walkdirs(prefix)
2197
disk_iterator = osutils.walkdirs(disk_top, prefix)
2199
current_disk = disk_iterator.next()
2200
disk_finished = False
2202
if not (e.errno == errno.ENOENT or
2203
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2206
disk_finished = True
2208
current_inv = inventory_iterator.next()
2209
inv_finished = False
2210
except StopIteration:
2213
while not inv_finished or not disk_finished:
2214
if not disk_finished:
2215
# strip out .bzr dirs
2216
if current_disk[0][1][top_strip_len:] == '':
2217
# osutils.walkdirs can be made nicer -
2218
# yield the path-from-prefix rather than the pathjoined
2220
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2221
if current_disk[1][bzrdir_loc][0] == '.bzr':
2222
# we dont yield the contents of, or, .bzr itself.
2223
del current_disk[1][bzrdir_loc]
2225
# everything is unknown
2228
# everything is missing
2231
direction = cmp(current_inv[0][0], current_disk[0][0])
2233
# disk is before inventory - unknown
2234
dirblock = [(relpath, basename, kind, stat, None, None) for
2235
relpath, basename, kind, stat, top_path in current_disk[1]]
2236
yield (current_disk[0][0], None), dirblock
2238
current_disk = disk_iterator.next()
2239
except StopIteration:
2240
disk_finished = True
2242
# inventory is before disk - missing.
2243
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2244
for relpath, basename, dkind, stat, fileid, kind in
2246
yield (current_inv[0][0], current_inv[0][1]), dirblock
2248
current_inv = inventory_iterator.next()
2249
except StopIteration:
2252
# versioned present directory
2253
# merge the inventory and disk data together
2255
for relpath, subiterator in itertools.groupby(sorted(
2256
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2257
path_elements = list(subiterator)
2258
if len(path_elements) == 2:
2259
inv_row, disk_row = path_elements
2260
# versioned, present file
2261
dirblock.append((inv_row[0],
2262
inv_row[1], disk_row[2],
2263
disk_row[3], inv_row[4],
2265
elif len(path_elements[0]) == 5:
2267
dirblock.append((path_elements[0][0],
2268
path_elements[0][1], path_elements[0][2],
2269
path_elements[0][3], None, None))
2270
elif len(path_elements[0]) == 6:
2271
# versioned, absent file.
2272
dirblock.append((path_elements[0][0],
2273
path_elements[0][1], 'unknown', None,
2274
path_elements[0][4], path_elements[0][5]))
2276
raise NotImplementedError('unreachable code')
2277
yield current_inv[0], dirblock
2279
current_inv = inventory_iterator.next()
2280
except StopIteration:
2283
current_disk = disk_iterator.next()
2284
except StopIteration:
2285
disk_finished = True
2287
def _walkdirs(self, prefix=""):
2288
"""Walk the directories of this tree.
2290
:prefix: is used as the directrory to start with.
2291
returns a generator which yields items in the form:
2292
((curren_directory_path, fileid),
2293
[(file1_path, file1_name, file1_kind, None, file1_id,
2296
_directory = 'directory'
2297
# get the root in the inventory
2298
inv = self.inventory
2299
top_id = inv.path2id(prefix)
2303
pending = [(prefix, '', _directory, None, top_id, None)]
2306
currentdir = pending.pop()
2307
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2308
top_id = currentdir[4]
2310
relroot = currentdir[0] + '/'
2313
# FIXME: stash the node in pending
2315
for name, child in entry.sorted_children():
2316
dirblock.append((relroot + name, name, child.kind, None,
2317
child.file_id, child.kind
2319
yield (currentdir[0], entry.file_id), dirblock
2320
# push the user specified dirs from dirblock
2321
for dir in reversed(dirblock):
2322
if dir[2] == _directory:
2325
@needs_tree_write_lock
2326
def auto_resolve(self):
2327
"""Automatically resolve text conflicts according to contents.
2329
Only text conflicts are auto_resolvable. Files with no conflict markers
2330
are considered 'resolved', because bzr always puts conflict markers
2331
into files that have text conflicts. The corresponding .THIS .BASE and
2332
.OTHER files are deleted, as per 'resolve'.
2333
:return: a tuple of ConflictLists: (un_resolved, resolved).
2335
un_resolved = _mod_conflicts.ConflictList()
2336
resolved = _mod_conflicts.ConflictList()
2337
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2338
for conflict in self.conflicts():
2339
if (conflict.typestring != 'text conflict' or
2340
self.kind(conflict.file_id) != 'file'):
2341
un_resolved.append(conflict)
2343
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2345
for line in my_file:
2346
if conflict_re.search(line):
2347
un_resolved.append(conflict)
2350
resolved.append(conflict)
2353
resolved.remove_files(self)
2354
self.set_conflicts(un_resolved)
2355
return un_resolved, resolved
2357
def _validate(self):
2358
"""Validate internal structures.
2360
This is meant mostly for the test suite. To give it a chance to detect
2361
corruption after actions have occurred. The default implementation is a
2364
:return: None. An exception should be raised if there is an error.
2369
class WorkingTree2(WorkingTree):
2370
"""This is the Format 2 working tree.
2372
This was the first weave based working tree.
2373
- uses os locks for locking.
2374
- uses the branch last-revision.
2377
def __init__(self, *args, **kwargs):
2378
super(WorkingTree2, self).__init__(*args, **kwargs)
2379
# WorkingTree2 has more of a constraint that self._inventory must
2380
# exist. Because this is an older format, we don't mind the overhead
2381
# caused by the extra computation here.
2383
# Newer WorkingTree's should only have self._inventory set when they
2385
if self._inventory is None:
2386
self.read_working_inventory()
2388
def lock_tree_write(self):
2389
"""See WorkingTree.lock_tree_write().
2391
In Format2 WorkingTrees we have a single lock for the branch and tree
2392
so lock_tree_write() degrades to lock_write().
2394
self.branch.lock_write()
2396
return self._control_files.lock_write()
2398
self.branch.unlock()
2402
# we share control files:
2403
if self._control_files._lock_count == 3:
2404
# _inventory_is_modified is always False during a read lock.
2405
if self._inventory_is_modified:
2407
self._write_hashcache_if_dirty()
2409
# reverse order of locking.
2411
return self._control_files.unlock()
2413
self.branch.unlock()
2416
class WorkingTree3(WorkingTree):
2417
"""This is the Format 3 working tree.
2419
This differs from the base WorkingTree by:
2420
- having its own file lock
2421
- having its own last-revision property.
2423
This is new in bzr 0.8
2427
def _last_revision(self):
2428
"""See Mutable.last_revision."""
2430
return osutils.safe_revision_id(
2431
self._control_files.get('last-revision').read())
2432
except errors.NoSuchFile:
2435
def _change_last_revision(self, revision_id):
2436
"""See WorkingTree._change_last_revision."""
2437
if revision_id is None or revision_id == NULL_REVISION:
2439
self._control_files._transport.delete('last-revision')
2440
except errors.NoSuchFile:
2444
self._control_files.put_bytes('last-revision', revision_id)
2447
@needs_tree_write_lock
2448
def set_conflicts(self, conflicts):
2449
self._put_rio('conflicts', conflicts.to_stanzas(),
2452
@needs_tree_write_lock
2453
def add_conflicts(self, new_conflicts):
2454
conflict_set = set(self.conflicts())
2455
conflict_set.update(set(list(new_conflicts)))
2456
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2457
key=_mod_conflicts.Conflict.sort_key)))
2460
def conflicts(self):
2462
confile = self._control_files.get('conflicts')
2463
except errors.NoSuchFile:
2464
return _mod_conflicts.ConflictList()
2466
if confile.next() != CONFLICT_HEADER_1 + '\n':
2467
raise errors.ConflictFormatError()
2468
except StopIteration:
2469
raise errors.ConflictFormatError()
2470
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
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)
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())
2625
revision_id = osutils.safe_revision_id(revision_id)
2628
branch.generate_revision_history(revision_id)
2632
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2638
basis_tree = branch.repository.revision_tree(revision_id)
2639
if basis_tree.inventory.root is not None:
2640
wt.set_root_id(basis_tree.inventory.root.file_id)
2641
# set the parent list and cache the basis tree.
2642
if _mod_revision.is_null(revision_id):
2645
parent_trees = [(revision_id, basis_tree)]
2646
wt.set_parent_trees(parent_trees)
2647
transform.build_tree(basis_tree, wt)
2651
super(WorkingTreeFormat2, self).__init__()
2652
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2654
def open(self, a_bzrdir, _found=False):
2655
"""Return the WorkingTree object for a_bzrdir
2657
_found is a private parameter, do not use it. It is used to indicate
2658
if format probing has already been done.
2661
# we are being called directly and must probe.
2662
raise NotImplementedError
2663
if not isinstance(a_bzrdir.transport, LocalTransport):
2664
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2665
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2671
class WorkingTreeFormat3(WorkingTreeFormat):
2672
"""The second working tree format updated to record a format marker.
2675
- exists within a metadir controlling .bzr
2676
- includes an explicit version marker for the workingtree control
2677
files, separate from the BzrDir format
2678
- modifies the hash cache format
2680
- uses a LockDir to guard access for writes.
2683
upgrade_recommended = True
2685
def get_format_string(self):
2686
"""See WorkingTreeFormat.get_format_string()."""
2687
return "Bazaar-NG Working Tree format 3"
2689
def get_format_description(self):
2690
"""See WorkingTreeFormat.get_format_description()."""
2691
return "Working tree format 3"
2693
_lock_file_name = 'lock'
2694
_lock_class = LockDir
2696
_tree_class = WorkingTree3
2698
def __get_matchingbzrdir(self):
2699
return bzrdir.BzrDirMetaFormat1()
2701
_matchingbzrdir = property(__get_matchingbzrdir)
2703
def _open_control_files(self, a_bzrdir):
2704
transport = a_bzrdir.get_workingtree_transport(None)
2705
return LockableFiles(transport, self._lock_file_name,
2708
def initialize(self, a_bzrdir, revision_id=None):
2709
"""See WorkingTreeFormat.initialize().
2711
revision_id allows creating a working tree at a different
2712
revision than the branch is at.
2714
if not isinstance(a_bzrdir.transport, LocalTransport):
2715
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2716
transport = a_bzrdir.get_workingtree_transport(self)
2717
control_files = self._open_control_files(a_bzrdir)
2718
control_files.create_lock()
2719
control_files.lock_write()
2720
control_files.put_utf8('format', self.get_format_string())
2721
branch = a_bzrdir.open_branch()
2722
if revision_id is None:
2723
revision_id = _mod_revision.ensure_null(branch.last_revision())
2725
revision_id = osutils.safe_revision_id(revision_id)
2726
# WorkingTree3 can handle an inventory which has a unique root id.
2727
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2728
# those trees. And because there isn't a format bump inbetween, we
2729
# are maintaining compatibility with older clients.
2730
# inv = Inventory(root_id=gen_root_id())
2731
inv = self._initial_inventory()
2732
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2738
_control_files=control_files)
2739
wt.lock_tree_write()
2741
basis_tree = branch.repository.revision_tree(revision_id)
2742
# only set an explicit root id if there is one to set.
2743
if basis_tree.inventory.root is not None:
2744
wt.set_root_id(basis_tree.inventory.root.file_id)
2745
if revision_id == NULL_REVISION:
2746
wt.set_parent_trees([])
2748
wt.set_parent_trees([(revision_id, basis_tree)])
2749
transform.build_tree(basis_tree, wt)
2751
# Unlock in this order so that the unlock-triggers-flush in
2752
# WorkingTree is given a chance to fire.
2753
control_files.unlock()
2757
def _initial_inventory(self):
2761
super(WorkingTreeFormat3, self).__init__()
2763
def open(self, a_bzrdir, _found=False):
2764
"""Return the WorkingTree object for a_bzrdir
2766
_found is a private parameter, do not use it. It is used to indicate
2767
if format probing has already been done.
2770
# we are being called directly and must probe.
2771
raise NotImplementedError
2772
if not isinstance(a_bzrdir.transport, LocalTransport):
2773
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2774
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2777
def _open(self, a_bzrdir, control_files):
2778
"""Open the tree itself.
2780
:param a_bzrdir: the dir for the tree.
2781
:param control_files: the control files for the tree.
2783
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2787
_control_files=control_files)
2790
return self.get_format_string()
2793
__default_format = WorkingTreeFormat4()
2794
WorkingTreeFormat.register_format(__default_format)
2795
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2796
WorkingTreeFormat.set_default_format(__default_format)
2797
# formats which have no format string are not discoverable
2798
# and not independently creatable, so are not registered.
2799
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
