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
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
59
conflicts as _mod_conflicts,
78
from bzrlib.transport import get_transport
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
from bzrlib import symbol_versioning
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib.osutils import (
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
139
class TreeEntry(object):
140
"""An entry that implements the minimum interface used by commands.
142
This needs further inspection, it may be better to have
143
InventoryEntries without ids - though that seems wrong. For now,
144
this is a parallel hierarchy to InventoryEntry, and needs to become
145
one of several things: decorates to that hierarchy, children of, or
147
Another note is that these objects are currently only used when there is
148
no InventoryEntry available - i.e. for unversioned objects.
149
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
152
def __eq__(self, other):
153
# yes, this us ugly, TODO: best practice __eq__ style.
154
return (isinstance(other, TreeEntry)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class TreeDirectory(TreeEntry):
162
"""See TreeEntry. This is a directory in a working tree."""
164
def __eq__(self, other):
165
return (isinstance(other, TreeDirectory)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeFile(TreeEntry):
173
"""See TreeEntry. This is a regular file in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeFile)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeLink(TreeEntry):
184
"""See TreeEntry. This is a symlink in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeLink)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
195
"""Working copy tree.
197
The inventory is held in the `Branch` working-inventory, and the
198
files are in a directory on disk.
200
It is possible for a `WorkingTree` to have a filename which is
201
not listed in the Inventory and vice versa.
204
def __init__(self, basedir='.',
205
branch=DEPRECATED_PARAMETER,
211
"""Construct a WorkingTree for basedir.
213
If the branch is not supplied, it is opened automatically.
214
If the branch is supplied, it must be the branch for this basedir.
215
(branch.base is not cross checked, because for remote branches that
216
would be meaningless).
218
self._format = _format
219
self.bzrdir = _bzrdir
221
# not created via open etc.
222
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
223
"Please use bzrdir.open_workingtree or WorkingTree.open().",
226
wt = WorkingTree.open(basedir)
227
self._branch = wt.branch
228
self.basedir = wt.basedir
229
self._control_files = wt._control_files
230
self._hashcache = wt._hashcache
231
self._set_inventory(wt._inventory, dirty=False)
232
self._format = wt._format
233
self.bzrdir = wt.bzrdir
234
assert isinstance(basedir, basestring), \
235
"base directory %r is not a string" % basedir
236
basedir = safe_unicode(basedir)
237
mutter("opening working tree %r", basedir)
238
if deprecated_passed(branch):
240
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
241
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
242
" WorkingTree.open().",
246
self._branch = branch
248
self._branch = self.bzrdir.open_branch()
249
self.basedir = realpath(basedir)
250
# if branch is at our basedir and is a format 6 or less
251
if isinstance(self._format, WorkingTreeFormat2):
252
# share control object
253
self._control_files = self.branch.control_files
255
# assume all other formats have their own control files.
256
assert isinstance(_control_files, LockableFiles), \
257
"_control_files must be a LockableFiles, not %r" \
259
self._control_files = _control_files
260
# update the whole cache up front and write to disk if anything changed;
261
# in the future we might want to do this more selectively
262
# two possible ways offer themselves : in self._unlock, write the cache
263
# if needed, or, when the cache sees a change, append it to the hash
264
# cache file, and have the parser take the most recent entry for a
266
wt_trans = self.bzrdir.get_workingtree_transport(None)
267
cache_filename = wt_trans.local_abspath('stat-cache')
268
self._hashcache = hashcache.HashCache(basedir, cache_filename,
269
self._control_files._file_mode)
272
# is this scan needed ? it makes things kinda slow.
279
if _inventory is None:
280
# This will be acquired on lock_read() or lock_write()
281
self._inventory_is_modified = False
282
self._inventory = None
283
self._inventory_fp = None
285
# the caller of __init__ has provided an inventory,
286
# we assume they know what they are doing - as its only
287
# the Format factory and creation methods that are
288
# permitted to do this.
289
self._set_inventory(_inventory, dirty=False)
292
fget=lambda self: self._branch,
293
doc="""The branch this WorkingTree is connected to.
295
This cannot be set - it is reflective of the actual disk structure
296
the working tree has been constructed from.
299
def break_lock(self):
300
"""Break a lock if one is present from another instance.
302
Uses the ui factory to ask for confirmation if the lock may be from
305
This will probe the repository for its lock as well.
307
self._control_files.break_lock()
308
self.branch.break_lock()
310
def requires_rich_root(self):
311
return self._format.requires_rich_root
313
def supports_tree_reference(self):
316
def _set_inventory(self, inv, dirty):
317
"""Set the internal cached inventory.
319
:param inv: The inventory to set.
320
:param dirty: A boolean indicating whether the inventory is the same
321
logical inventory as whats on disk. If True the inventory is not
322
the same and should be written to disk or data will be lost, if
323
False then the inventory is the same as that on disk and any
324
serialisation would be unneeded overhead.
326
assert inv.root is not None
327
self._inventory = inv
328
self._inventory_is_modified = dirty
331
def open(path=None, _unsupported=False):
332
"""Open an existing working tree at path.
336
path = os.path.getcwdu()
337
control = bzrdir.BzrDir.open(path, _unsupported)
338
return control.open_workingtree(_unsupported)
341
def open_containing(path=None):
342
"""Open an existing working tree which has its root about path.
344
This probes for a working tree at path and searches upwards from there.
346
Basically we keep looking up until we find the control directory or
347
run into /. If there isn't one, raises NotBranchError.
348
TODO: give this a new exception.
349
If there is one, it is returned, along with the unused portion of path.
351
:return: The WorkingTree that contains 'path', and the rest of path
354
path = osutils.getcwd()
355
control, relpath = bzrdir.BzrDir.open_containing(path)
357
return control.open_workingtree(), relpath
360
def open_downlevel(path=None):
361
"""Open an unsupported working tree.
363
Only intended for advanced situations like upgrading part of a bzrdir.
365
return WorkingTree.open(path, _unsupported=True)
367
# should be deprecated - this is slow and in any case treating them as a
368
# container is (we now know) bad style -- mbp 20070302
369
## @deprecated_method(zero_fifteen)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if osutils.lexists(self.abspath(path)):
382
return "<%s of %s>" % (self.__class__.__name__,
383
getattr(self, 'basedir', None))
385
def abspath(self, filename):
386
return pathjoin(self.basedir, filename)
388
def basis_tree(self):
389
"""Return RevisionTree for the current last revision.
391
If the left most parent is a ghost then the returned tree will be an
392
empty tree - one obtained by calling repository.revision_tree(None).
395
revision_id = self.get_parent_ids()[0]
397
# no parents, return an empty revision tree.
398
# in the future this should return the tree for
399
# 'empty:' - the implicit root empty tree.
400
return self.branch.repository.revision_tree(None)
402
return self.revision_tree(revision_id)
403
except errors.NoSuchRevision:
405
# No cached copy available, retrieve from the repository.
406
# FIXME? RBC 20060403 should we cache the inventory locally
409
return self.branch.repository.revision_tree(revision_id)
410
except errors.RevisionNotPresent:
411
# the basis tree *may* be a ghost or a low level error may have
412
# occured. If the revision is present, its a problem, if its not
414
if self.branch.repository.has_revision(revision_id):
416
# the basis tree is a ghost so return an empty tree.
417
return self.branch.repository.revision_tree(None)
420
@deprecated_method(zero_eight)
421
def create(branch, directory):
422
"""Create a workingtree for branch at directory.
424
If existing_directory already exists it must have a .bzr directory.
425
If it does not exist, it will be created.
427
This returns a new WorkingTree object for the new checkout.
429
TODO FIXME RBC 20060124 when we have checkout formats in place this
430
should accept an optional revisionid to checkout [and reject this if
431
checking out into the same dir as a pre-checkout-aware branch format.]
433
XXX: When BzrDir is present, these should be created through that
436
warnings.warn('delete WorkingTree.create', stacklevel=3)
437
transport = get_transport(directory)
438
if branch.bzrdir.root_transport.base == transport.base:
440
return branch.bzrdir.create_workingtree()
441
# different directory,
442
# create a branch reference
443
# and now a working tree.
444
raise NotImplementedError
447
@deprecated_method(zero_eight)
448
def create_standalone(directory):
449
"""Create a checkout and a branch and a repo at directory.
451
Directory must exist and be empty.
453
please use BzrDir.create_standalone_workingtree
455
return bzrdir.BzrDir.create_standalone_workingtree(directory)
457
def relpath(self, path):
458
"""Return the local path portion from a given path.
460
The path may be absolute or relative. If its a relative path it is
461
interpreted relative to the python current working directory.
463
return osutils.relpath(self.basedir, path)
465
def has_filename(self, filename):
466
return osutils.lexists(self.abspath(filename))
468
def get_file(self, file_id):
469
file_id = osutils.safe_file_id(file_id)
470
return self.get_file_byname(self.id2path(file_id))
472
def get_file_text(self, file_id):
473
file_id = osutils.safe_file_id(file_id)
474
return self.get_file(file_id).read()
476
def get_file_byname(self, filename):
477
return file(self.abspath(filename), 'rb')
480
def annotate_iter(self, file_id):
481
"""See Tree.annotate_iter
483
This implementation will use the basis tree implementation if possible.
484
Lines not in the basis are attributed to CURRENT_REVISION
486
If there are pending merges, lines added by those merges will be
487
incorrectly attributed to CURRENT_REVISION (but after committing, the
488
attribution will be correct).
490
file_id = osutils.safe_file_id(file_id)
491
basis = self.basis_tree()
494
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
495
require_versioned=True).next()
496
changed_content, kind = changes[2], changes[6]
497
if not changed_content:
498
return basis.annotate_iter(file_id)
502
if kind[0] != 'file':
505
old_lines = list(basis.annotate_iter(file_id))
507
for tree in self.branch.repository.revision_trees(
508
self.get_parent_ids()[1:]):
509
if file_id not in tree:
511
old.append(list(tree.annotate_iter(file_id)))
512
return annotate.reannotate(old, self.get_file(file_id).readlines(),
517
def get_parent_ids(self):
518
"""See Tree.get_parent_ids.
520
This implementation reads the pending merges list and last_revision
521
value and uses that to decide what the parents list should be.
523
last_rev = self._last_revision()
529
merges_file = self._control_files.get('pending-merges')
530
except errors.NoSuchFile:
533
for l in merges_file.readlines():
534
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
535
parents.append(revision_id)
539
def get_root_id(self):
540
"""Return the id of this trees root"""
541
return self._inventory.root.file_id
543
def _get_store_filename(self, file_id):
544
## XXX: badly named; this is not in the store at all
545
file_id = osutils.safe_file_id(file_id)
546
return self.abspath(self.id2path(file_id))
549
def clone(self, to_bzrdir, revision_id=None, basis=None):
550
"""Duplicate this working tree into to_bzr, including all state.
552
Specifically modified files are kept as modified, but
553
ignored and unknown files are discarded.
555
If you want to make a new line of development, see bzrdir.sprout()
558
If not None, the cloned tree will have its last revision set to
559
revision, and and difference between the source trees last revision
560
and this one merged in.
563
If not None, a closer copy of a tree which may have some files in
564
common, and which file content should be preferentially copied from.
566
# assumes the target bzr dir format is compatible.
567
result = self._format.initialize(to_bzrdir)
568
self.copy_content_into(result, revision_id)
572
def copy_content_into(self, tree, revision_id=None):
573
"""Copy the current content and user files of this tree into tree."""
574
tree.set_root_id(self.get_root_id())
575
if revision_id is None:
576
merge.transform_tree(tree, self)
578
# TODO now merge from tree.last_revision to revision (to preserve
579
# user local changes)
580
merge.transform_tree(tree, self)
581
tree.set_parent_ids([revision_id])
583
def id2abspath(self, file_id):
584
file_id = osutils.safe_file_id(file_id)
585
return self.abspath(self.id2path(file_id))
587
def has_id(self, file_id):
588
# files that have been deleted are excluded
589
file_id = osutils.safe_file_id(file_id)
591
if not inv.has_id(file_id):
593
path = inv.id2path(file_id)
594
return osutils.lexists(self.abspath(path))
596
def has_or_had_id(self, file_id):
597
file_id = osutils.safe_file_id(file_id)
598
if file_id == self.inventory.root.file_id:
600
return self.inventory.has_id(file_id)
602
__contains__ = has_id
604
def get_file_size(self, file_id):
605
file_id = osutils.safe_file_id(file_id)
606
return os.path.getsize(self.id2abspath(file_id))
609
def get_file_sha1(self, file_id, path=None, stat_value=None):
610
file_id = osutils.safe_file_id(file_id)
612
path = self._inventory.id2path(file_id)
613
return self._hashcache.get_sha1(path, stat_value)
615
def get_file_mtime(self, file_id, path=None):
616
file_id = osutils.safe_file_id(file_id)
618
path = self.inventory.id2path(file_id)
619
return os.lstat(self.abspath(path)).st_mtime
621
if not supports_executable():
622
def is_executable(self, file_id, path=None):
623
file_id = osutils.safe_file_id(file_id)
624
return self._inventory[file_id].executable
626
def is_executable(self, file_id, path=None):
628
file_id = osutils.safe_file_id(file_id)
629
path = self.id2path(file_id)
630
mode = os.lstat(self.abspath(path)).st_mode
631
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
633
@needs_tree_write_lock
634
def _add(self, files, ids, kinds):
635
"""See MutableTree._add."""
636
# TODO: Re-adding a file that is removed in the working copy
637
# should probably put it back with the previous ID.
638
# the read and write working inventory should not occur in this
639
# function - they should be part of lock_write and unlock.
640
inv = self.read_working_inventory()
641
for f, file_id, kind in zip(files, ids, kinds):
642
assert kind is not None
644
inv.add_path(f, kind=kind)
646
file_id = osutils.safe_file_id(file_id)
647
inv.add_path(f, kind=kind, file_id=file_id)
648
self._write_inventory(inv)
650
@needs_tree_write_lock
651
def _gather_kinds(self, files, kinds):
652
"""See MutableTree._gather_kinds."""
653
for pos, f in enumerate(files):
654
if kinds[pos] is None:
655
fullpath = normpath(self.abspath(f))
657
kinds[pos] = file_kind(fullpath)
659
if e.errno == errno.ENOENT:
660
raise errors.NoSuchFile(fullpath)
663
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
664
"""Add revision_id as a parent.
666
This is equivalent to retrieving the current list of parent ids
667
and setting the list to its value plus revision_id.
669
:param revision_id: The revision id to add to the parent list. It may
670
be a ghost revision as long as its not the first parent to be added,
671
or the allow_leftmost_as_ghost parameter is set True.
672
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
674
parents = self.get_parent_ids() + [revision_id]
675
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
676
or allow_leftmost_as_ghost)
678
@needs_tree_write_lock
679
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
680
"""Add revision_id, tree tuple as a parent.
682
This is equivalent to retrieving the current list of parent trees
683
and setting the list to its value plus parent_tuple. See also
684
add_parent_tree_id - if you only have a parent id available it will be
685
simpler to use that api. If you have the parent already available, using
686
this api is preferred.
688
:param parent_tuple: The (revision id, tree) to add to the parent list.
689
If the revision_id is a ghost, pass None for the tree.
690
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
692
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
693
if len(parent_ids) > 1:
694
# the leftmost may have already been a ghost, preserve that if it
696
allow_leftmost_as_ghost = True
697
self.set_parent_ids(parent_ids,
698
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
700
@needs_tree_write_lock
701
def add_pending_merge(self, *revision_ids):
702
# TODO: Perhaps should check at this point that the
703
# history of the revision is actually present?
704
parents = self.get_parent_ids()
706
for rev_id in revision_ids:
707
if rev_id in parents:
709
parents.append(rev_id)
712
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
714
@deprecated_method(zero_eleven)
716
def pending_merges(self):
717
"""Return a list of pending merges.
719
These are revisions that have been merged into the working
720
directory but not yet committed.
722
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
723
instead - which is available on all tree objects.
725
return self.get_parent_ids()[1:]
727
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
728
"""Common ghost checking functionality from set_parent_*.
730
This checks that the left hand-parent exists if there are any
733
if len(revision_ids) > 0:
734
leftmost_id = revision_ids[0]
735
if (not allow_leftmost_as_ghost and not
736
self.branch.repository.has_revision(leftmost_id)):
737
raise errors.GhostRevisionUnusableHere(leftmost_id)
739
def _set_merges_from_parent_ids(self, parent_ids):
740
merges = parent_ids[1:]
741
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
743
@needs_tree_write_lock
744
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
745
"""Set the parent ids to revision_ids.
747
See also set_parent_trees. This api will try to retrieve the tree data
748
for each element of revision_ids from the trees repository. If you have
749
tree data already available, it is more efficient to use
750
set_parent_trees rather than set_parent_ids. set_parent_ids is however
751
an easier API to use.
753
:param revision_ids: The revision_ids to set as the parent ids of this
754
working tree. Any of these may be ghosts.
756
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
757
self._check_parents_for_ghosts(revision_ids,
758
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
760
if len(revision_ids) > 0:
761
self.set_last_revision(revision_ids[0])
763
self.set_last_revision(None)
765
self._set_merges_from_parent_ids(revision_ids)
767
@needs_tree_write_lock
768
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
769
"""See MutableTree.set_parent_trees."""
770
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
772
self._check_parents_for_ghosts(parent_ids,
773
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
775
if len(parent_ids) == 0:
776
leftmost_parent_id = None
777
leftmost_parent_tree = None
779
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
781
if self._change_last_revision(leftmost_parent_id):
782
if leftmost_parent_tree is None:
783
# If we don't have a tree, fall back to reading the
784
# parent tree from the repository.
785
self._cache_basis_inventory(leftmost_parent_id)
787
inv = leftmost_parent_tree.inventory
788
xml = self._create_basis_xml_from_inventory(
789
leftmost_parent_id, inv)
790
self._write_basis_inventory(xml)
791
self._set_merges_from_parent_ids(parent_ids)
793
@needs_tree_write_lock
794
def set_pending_merges(self, rev_list):
795
parents = self.get_parent_ids()
796
leftmost = parents[:1]
797
new_parents = leftmost + rev_list
798
self.set_parent_ids(new_parents)
800
@needs_tree_write_lock
801
def set_merge_modified(self, modified_hashes):
803
for file_id, hash in modified_hashes.iteritems():
804
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
805
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
807
def _put_rio(self, filename, stanzas, header):
808
self._must_be_locked()
809
my_file = rio_file(stanzas, header)
810
self._control_files.put(filename, my_file)
812
@needs_write_lock # because merge pulls data into the branch.
813
def merge_from_branch(self, branch, to_revision=None):
814
"""Merge from a branch into this working tree.
816
:param branch: The branch to merge from.
817
:param to_revision: If non-None, the merge will merge to to_revision,
818
but not beyond it. to_revision does not need to be in the history
819
of the branch when it is supplied. If None, to_revision defaults to
820
branch.last_revision().
822
from bzrlib.merge import Merger, Merge3Merger
823
pb = bzrlib.ui.ui_factory.nested_progress_bar()
825
merger = Merger(self.branch, this_tree=self, pb=pb)
826
merger.pp = ProgressPhase("Merge phase", 5, pb)
827
merger.pp.next_phase()
828
# check that there are no
830
merger.check_basis(check_clean=True, require_commits=False)
831
if to_revision is None:
832
to_revision = branch.last_revision()
834
to_revision = osutils.safe_revision_id(to_revision)
835
merger.other_rev_id = to_revision
836
if merger.other_rev_id is None:
837
raise error.NoCommits(branch)
838
self.branch.fetch(branch, last_revision=merger.other_rev_id)
839
merger.other_basis = merger.other_rev_id
840
merger.other_tree = self.branch.repository.revision_tree(
842
merger.other_branch = branch
843
merger.pp.next_phase()
845
if merger.base_rev_id == merger.other_rev_id:
846
raise errors.PointlessMerge
847
merger.backup_files = False
848
merger.merge_type = Merge3Merger
849
merger.set_interesting_files(None)
850
merger.show_base = False
851
merger.reprocess = False
852
conflicts = merger.do_merge()
859
def merge_modified(self):
860
"""Return a dictionary of files modified by a merge.
862
The list is initialized by WorkingTree.set_merge_modified, which is
863
typically called after we make some automatic updates to the tree
866
This returns a map of file_id->sha1, containing only files which are
867
still in the working inventory and have that text hash.
870
hashfile = self._control_files.get('merge-hashes')
871
except errors.NoSuchFile:
875
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
876
raise errors.MergeModifiedFormatError()
877
except StopIteration:
878
raise errors.MergeModifiedFormatError()
879
for s in RioReader(hashfile):
880
# RioReader reads in Unicode, so convert file_ids back to utf8
881
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
882
if file_id not in self.inventory:
884
text_hash = s.get("hash")
885
if text_hash == self.get_file_sha1(file_id):
886
merge_hashes[file_id] = text_hash
890
def mkdir(self, path, file_id=None):
891
"""See MutableTree.mkdir()."""
893
file_id = generate_ids.gen_file_id(os.path.basename(path))
894
os.mkdir(self.abspath(path))
895
self.add(path, file_id, 'directory')
898
def get_symlink_target(self, file_id):
899
file_id = osutils.safe_file_id(file_id)
900
return os.readlink(self.id2abspath(file_id))
903
def subsume(self, other_tree):
904
def add_children(inventory, entry):
905
for child_entry in entry.children.values():
906
inventory._byid[child_entry.file_id] = child_entry
907
if child_entry.kind == 'directory':
908
add_children(inventory, child_entry)
909
if other_tree.get_root_id() == self.get_root_id():
910
raise errors.BadSubsumeSource(self, other_tree,
911
'Trees have the same root')
913
other_tree_path = self.relpath(other_tree.basedir)
914
except errors.PathNotChild:
915
raise errors.BadSubsumeSource(self, other_tree,
916
'Tree is not contained by the other')
917
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
918
if new_root_parent is None:
919
raise errors.BadSubsumeSource(self, other_tree,
920
'Parent directory is not versioned.')
921
# We need to ensure that the result of a fetch will have a
922
# versionedfile for the other_tree root, and only fetching into
923
# RepositoryKnit2 guarantees that.
924
if not self.branch.repository.supports_rich_root():
925
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
926
other_tree.lock_tree_write()
928
new_parents = other_tree.get_parent_ids()
929
other_root = other_tree.inventory.root
930
other_root.parent_id = new_root_parent
931
other_root.name = osutils.basename(other_tree_path)
932
self.inventory.add(other_root)
933
add_children(self.inventory, other_root)
934
self._write_inventory(self.inventory)
935
# normally we don't want to fetch whole repositories, but i think
936
# here we really do want to consolidate the whole thing.
937
for parent_id in other_tree.get_parent_ids():
938
self.branch.fetch(other_tree.branch, parent_id)
939
self.add_parent_tree_id(parent_id)
942
other_tree.bzrdir.retire_bzrdir()
944
@needs_tree_write_lock
945
def extract(self, file_id, format=None):
946
"""Extract a subtree from this tree.
948
A new branch will be created, relative to the path for this tree.
952
segments = osutils.splitpath(path)
953
transport = self.branch.bzrdir.root_transport
954
for name in segments:
955
transport = transport.clone(name)
958
except errors.FileExists:
962
sub_path = self.id2path(file_id)
963
branch_transport = mkdirs(sub_path)
965
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
967
branch_transport.mkdir('.')
968
except errors.FileExists:
970
branch_bzrdir = format.initialize_on_transport(branch_transport)
972
repo = branch_bzrdir.find_repository()
973
except errors.NoRepositoryPresent:
974
repo = branch_bzrdir.create_repository()
975
assert repo.supports_rich_root()
977
if not repo.supports_rich_root():
978
raise errors.RootNotRich()
979
new_branch = branch_bzrdir.create_branch()
980
new_branch.pull(self.branch)
981
for parent_id in self.get_parent_ids():
982
new_branch.fetch(self.branch, parent_id)
983
tree_transport = self.bzrdir.root_transport.clone(sub_path)
984
if tree_transport.base != branch_transport.base:
985
tree_bzrdir = format.initialize_on_transport(tree_transport)
986
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
988
tree_bzrdir = branch_bzrdir
989
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
990
wt.set_parent_ids(self.get_parent_ids())
991
my_inv = self.inventory
992
child_inv = Inventory(root_id=None)
993
new_root = my_inv[file_id]
994
my_inv.remove_recursive_id(file_id)
995
new_root.parent_id = None
996
child_inv.add(new_root)
997
self._write_inventory(my_inv)
998
wt._write_inventory(child_inv)
1001
def _serialize(self, inventory, out_file):
1002
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1004
def _deserialize(selt, in_file):
1005
return xml5.serializer_v5.read_inventory(in_file)
1008
"""Write the in memory inventory to disk."""
1009
# TODO: Maybe this should only write on dirty ?
1010
if self._control_files._lock_mode != 'w':
1011
raise errors.NotWriteLocked(self)
1013
self._serialize(self._inventory, sio)
1015
self._control_files.put('inventory', sio)
1016
self._inventory_is_modified = False
1018
def _kind(self, relpath):
1019
return osutils.file_kind(self.abspath(relpath))
1021
def list_files(self, include_root=False):
1022
"""Recursively list all files as (path, class, kind, id, entry).
1024
Lists, but does not descend into unversioned directories.
1026
This does not include files that have been deleted in this
1029
Skips the control directory.
1031
# list_files is an iterator, so @needs_read_lock doesn't work properly
1032
# with it. So callers should be careful to always read_lock the tree.
1033
if not self.is_locked():
1034
raise errors.ObjectNotLocked(self)
1036
inv = self.inventory
1037
if include_root is True:
1038
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1039
# Convert these into local objects to save lookup times
1040
pathjoin = osutils.pathjoin
1041
file_kind = self._kind
1043
# transport.base ends in a slash, we want the piece
1044
# between the last two slashes
1045
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1047
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1049
# directory file_id, relative path, absolute path, reverse sorted children
1050
children = os.listdir(self.basedir)
1052
# jam 20060527 The kernel sized tree seems equivalent whether we
1053
# use a deque and popleft to keep them sorted, or if we use a plain
1054
# list and just reverse() them.
1055
children = collections.deque(children)
1056
stack = [(inv.root.file_id, u'', self.basedir, children)]
1058
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1061
f = children.popleft()
1062
## TODO: If we find a subdirectory with its own .bzr
1063
## directory, then that is a separate tree and we
1064
## should exclude it.
1066
# the bzrdir for this tree
1067
if transport_base_dir == f:
1070
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1071
# and 'f' doesn't begin with one, we can do a string op, rather
1072
# than the checks of pathjoin(), all relative paths will have an extra slash
1074
fp = from_dir_relpath + '/' + f
1077
fap = from_dir_abspath + '/' + f
1079
f_ie = inv.get_child(from_dir_id, f)
1082
elif self.is_ignored(fp[1:]):
1085
# we may not have found this file, because of a unicode issue
1086
f_norm, can_access = osutils.normalized_filename(f)
1087
if f == f_norm or not can_access:
1088
# No change, so treat this file normally
1091
# this file can be accessed by a normalized path
1092
# check again if it is versioned
1093
# these lines are repeated here for performance
1095
fp = from_dir_relpath + '/' + f
1096
fap = from_dir_abspath + '/' + f
1097
f_ie = inv.get_child(from_dir_id, f)
1100
elif self.is_ignored(fp[1:]):
1107
# make a last minute entry
1109
yield fp[1:], c, fk, f_ie.file_id, f_ie
1112
yield fp[1:], c, fk, None, fk_entries[fk]()
1114
yield fp[1:], c, fk, None, TreeEntry()
1117
if fk != 'directory':
1120
# But do this child first
1121
new_children = os.listdir(fap)
1123
new_children = collections.deque(new_children)
1124
stack.append((f_ie.file_id, fp, fap, new_children))
1125
# Break out of inner loop,
1126
# so that we start outer loop with child
1129
# if we finished all children, pop it off the stack
1132
@needs_tree_write_lock
1133
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1136
to_dir must exist in the inventory.
1138
If to_dir exists and is a directory, the files are moved into
1139
it, keeping their old names.
1141
Note that to_dir is only the last component of the new name;
1142
this doesn't change the directory.
1144
For each entry in from_paths the move mode will be determined
1147
The first mode moves the file in the filesystem and updates the
1148
inventory. The second mode only updates the inventory without
1149
touching the file on the filesystem. This is the new mode introduced
1152
move uses the second mode if 'after == True' and the target is not
1153
versioned but present in the working tree.
1155
move uses the second mode if 'after == False' and the source is
1156
versioned but no longer in the working tree, and the target is not
1157
versioned but present in the working tree.
1159
move uses the first mode if 'after == False' and the source is
1160
versioned and present in the working tree, and the target is not
1161
versioned and not present in the working tree.
1163
Everything else results in an error.
1165
This returns a list of (from_path, to_path) pairs for each
1166
entry that is moved.
1171
# check for deprecated use of signature
1173
to_dir = kwargs.get('to_name', None)
1175
raise TypeError('You must supply a target directory')
1177
symbol_versioning.warn('The parameter to_name was deprecated'
1178
' in version 0.13. Use to_dir instead',
1181
# check destination directory
1182
assert not isinstance(from_paths, basestring)
1183
inv = self.inventory
1184
to_abs = self.abspath(to_dir)
1185
if not isdir(to_abs):
1186
raise errors.BzrMoveFailedError('',to_dir,
1187
errors.NotADirectory(to_abs))
1188
if not self.has_filename(to_dir):
1189
raise errors.BzrMoveFailedError('',to_dir,
1190
errors.NotInWorkingDirectory(to_dir))
1191
to_dir_id = inv.path2id(to_dir)
1192
if to_dir_id is None:
1193
raise errors.BzrMoveFailedError('',to_dir,
1194
errors.NotVersionedError(path=str(to_dir)))
1196
to_dir_ie = inv[to_dir_id]
1197
if to_dir_ie.kind != 'directory':
1198
raise errors.BzrMoveFailedError('',to_dir,
1199
errors.NotADirectory(to_abs))
1201
# create rename entries and tuples
1202
for from_rel in from_paths:
1203
from_tail = splitpath(from_rel)[-1]
1204
from_id = inv.path2id(from_rel)
1206
raise errors.BzrMoveFailedError(from_rel,to_dir,
1207
errors.NotVersionedError(path=str(from_rel)))
1209
from_entry = inv[from_id]
1210
from_parent_id = from_entry.parent_id
1211
to_rel = pathjoin(to_dir, from_tail)
1212
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1214
from_tail=from_tail,
1215
from_parent_id=from_parent_id,
1216
to_rel=to_rel, to_tail=from_tail,
1217
to_parent_id=to_dir_id)
1218
rename_entries.append(rename_entry)
1219
rename_tuples.append((from_rel, to_rel))
1221
# determine which move mode to use. checks also for movability
1222
rename_entries = self._determine_mv_mode(rename_entries, after)
1224
original_modified = self._inventory_is_modified
1227
self._inventory_is_modified = True
1228
self._move(rename_entries)
1230
# restore the inventory on error
1231
self._inventory_is_modified = original_modified
1233
self._write_inventory(inv)
1234
return rename_tuples
1236
def _determine_mv_mode(self, rename_entries, after=False):
1237
"""Determines for each from-to pair if both inventory and working tree
1238
or only the inventory has to be changed.
1240
Also does basic plausability tests.
1242
inv = self.inventory
1244
for rename_entry in rename_entries:
1245
# store to local variables for easier reference
1246
from_rel = rename_entry.from_rel
1247
from_id = rename_entry.from_id
1248
to_rel = rename_entry.to_rel
1249
to_id = inv.path2id(to_rel)
1250
only_change_inv = False
1252
# check the inventory for source and destination
1254
raise errors.BzrMoveFailedError(from_rel,to_rel,
1255
errors.NotVersionedError(path=str(from_rel)))
1256
if to_id is not None:
1257
raise errors.BzrMoveFailedError(from_rel,to_rel,
1258
errors.AlreadyVersionedError(path=str(to_rel)))
1260
# try to determine the mode for rename (only change inv or change
1261
# inv and file system)
1263
if not self.has_filename(to_rel):
1264
raise errors.BzrMoveFailedError(from_id,to_rel,
1265
errors.NoSuchFile(path=str(to_rel),
1266
extra="New file has not been created yet"))
1267
only_change_inv = True
1268
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1269
only_change_inv = True
1270
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1271
only_change_inv = False
1273
# something is wrong, so lets determine what exactly
1274
if not self.has_filename(from_rel) and \
1275
not self.has_filename(to_rel):
1276
raise errors.BzrRenameFailedError(from_rel,to_rel,
1277
errors.PathsDoNotExist(paths=(str(from_rel),
1280
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1281
extra="(Use --after to update the Bazaar id)")
1282
rename_entry.only_change_inv = only_change_inv
1283
return rename_entries
1285
def _move(self, rename_entries):
1286
"""Moves a list of files.
1288
Depending on the value of the flag 'only_change_inv', the
1289
file will be moved on the file system or not.
1291
inv = self.inventory
1294
for entry in rename_entries:
1296
self._move_entry(entry)
1298
self._rollback_move(moved)
1302
def _rollback_move(self, moved):
1303
"""Try to rollback a previous move in case of an filesystem error."""
1304
inv = self.inventory
1307
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1308
entry.to_tail, entry.to_parent_id, entry.from_rel,
1309
entry.from_tail, entry.from_parent_id,
1310
entry.only_change_inv))
1311
except errors.BzrMoveFailedError, e:
1312
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1313
" The working tree is in an inconsistent state."
1314
" Please consider doing a 'bzr revert'."
1315
" Error message is: %s" % e)
1317
def _move_entry(self, entry):
1318
inv = self.inventory
1319
from_rel_abs = self.abspath(entry.from_rel)
1320
to_rel_abs = self.abspath(entry.to_rel)
1321
if from_rel_abs == to_rel_abs:
1322
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1323
"Source and target are identical.")
1325
if not entry.only_change_inv:
1327
osutils.rename(from_rel_abs, to_rel_abs)
1329
raise errors.BzrMoveFailedError(entry.from_rel,
1331
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1333
@needs_tree_write_lock
1334
def rename_one(self, from_rel, to_rel, after=False):
1337
This can change the directory or the filename or both.
1339
rename_one has several 'modes' to work. First, it can rename a physical
1340
file and change the file_id. That is the normal mode. Second, it can
1341
only change the file_id without touching any physical file. This is
1342
the new mode introduced in version 0.15.
1344
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1345
versioned but present in the working tree.
1347
rename_one uses the second mode if 'after == False' and 'from_rel' is
1348
versioned but no longer in the working tree, and 'to_rel' is not
1349
versioned but present in the working tree.
1351
rename_one uses the first mode if 'after == False' and 'from_rel' is
1352
versioned and present in the working tree, and 'to_rel' is not
1353
versioned and not present in the working tree.
1355
Everything else results in an error.
1357
inv = self.inventory
1360
# create rename entries and tuples
1361
from_tail = splitpath(from_rel)[-1]
1362
from_id = inv.path2id(from_rel)
1364
raise errors.BzrRenameFailedError(from_rel,to_rel,
1365
errors.NotVersionedError(path=str(from_rel)))
1366
from_entry = inv[from_id]
1367
from_parent_id = from_entry.parent_id
1368
to_dir, to_tail = os.path.split(to_rel)
1369
to_dir_id = inv.path2id(to_dir)
1370
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1372
from_tail=from_tail,
1373
from_parent_id=from_parent_id,
1374
to_rel=to_rel, to_tail=to_tail,
1375
to_parent_id=to_dir_id)
1376
rename_entries.append(rename_entry)
1378
# determine which move mode to use. checks also for movability
1379
rename_entries = self._determine_mv_mode(rename_entries, after)
1381
# check if the target changed directory and if the target directory is
1383
if to_dir_id is None:
1384
raise errors.BzrMoveFailedError(from_rel,to_rel,
1385
errors.NotVersionedError(path=str(to_dir)))
1387
# all checks done. now we can continue with our actual work
1388
mutter('rename_one:\n'
1393
' to_dir_id {%s}\n',
1394
from_id, from_rel, to_rel, to_dir, to_dir_id)
1396
self._move(rename_entries)
1397
self._write_inventory(inv)
1399
class _RenameEntry(object):
1400
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1401
to_rel, to_tail, to_parent_id, only_change_inv=False):
1402
self.from_rel = from_rel
1403
self.from_id = from_id
1404
self.from_tail = from_tail
1405
self.from_parent_id = from_parent_id
1406
self.to_rel = to_rel
1407
self.to_tail = to_tail
1408
self.to_parent_id = to_parent_id
1409
self.only_change_inv = only_change_inv
1413
"""Return all unknown files.
1415
These are files in the working directory that are not versioned or
1416
control files or ignored.
1418
# force the extras method to be fully executed before returning, to
1419
# prevent race conditions with the lock
1421
[subp for subp in self.extras() if not self.is_ignored(subp)])
1423
@needs_tree_write_lock
1424
def unversion(self, file_ids):
1425
"""Remove the file ids in file_ids from the current versioned set.
1427
When a file_id is unversioned, all of its children are automatically
1430
:param file_ids: The file ids to stop versioning.
1431
:raises: NoSuchId if any fileid is not currently versioned.
1433
for file_id in file_ids:
1434
file_id = osutils.safe_file_id(file_id)
1435
if self._inventory.has_id(file_id):
1436
self._inventory.remove_recursive_id(file_id)
1438
raise errors.NoSuchId(self, file_id)
1440
# in the future this should just set a dirty bit to wait for the
1441
# final unlock. However, until all methods of workingtree start
1442
# with the current in -memory inventory rather than triggering
1443
# a read, it is more complex - we need to teach read_inventory
1444
# to know when to read, and when to not read first... and possibly
1445
# to save first when the in memory one may be corrupted.
1446
# so for now, we just only write it if it is indeed dirty.
1448
self._write_inventory(self._inventory)
1450
@deprecated_method(zero_eight)
1451
def iter_conflicts(self):
1452
"""List all files in the tree that have text or content conflicts.
1453
DEPRECATED. Use conflicts instead."""
1454
return self._iter_conflicts()
1456
def _iter_conflicts(self):
1458
for info in self.list_files():
1460
stem = get_conflicted_stem(path)
1463
if stem not in conflicted:
1464
conflicted.add(stem)
1468
def pull(self, source, overwrite=False, stop_revision=None,
1469
change_reporter=None):
1470
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1473
pp = ProgressPhase("Pull phase", 2, top_pb)
1475
old_revision_info = self.branch.last_revision_info()
1476
basis_tree = self.basis_tree()
1477
count = self.branch.pull(source, overwrite, stop_revision)
1478
new_revision_info = self.branch.last_revision_info()
1479
if new_revision_info != old_revision_info:
1481
repository = self.branch.repository
1482
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1483
basis_tree.lock_read()
1485
new_basis_tree = self.branch.basis_tree()
1492
change_reporter=change_reporter)
1493
if (basis_tree.inventory.root is None and
1494
new_basis_tree.inventory.root is not None):
1495
self.set_root_id(new_basis_tree.inventory.root.file_id)
1499
# TODO - dedup parents list with things merged by pull ?
1500
# reuse the revisiontree we merged against to set the new
1502
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1503
# we have to pull the merge trees out again, because
1504
# merge_inner has set the ids. - this corner is not yet
1505
# layered well enough to prevent double handling.
1506
# XXX TODO: Fix the double handling: telling the tree about
1507
# the already known parent data is wasteful.
1508
merges = self.get_parent_ids()[1:]
1509
parent_trees.extend([
1510
(parent, repository.revision_tree(parent)) for
1512
self.set_parent_trees(parent_trees)
1519
def put_file_bytes_non_atomic(self, file_id, bytes):
1520
"""See MutableTree.put_file_bytes_non_atomic."""
1521
file_id = osutils.safe_file_id(file_id)
1522
stream = file(self.id2abspath(file_id), 'wb')
1527
# TODO: update the hashcache here ?
1530
"""Yield all unversioned files in this WorkingTree.
1532
If there are any unversioned directories then only the directory is
1533
returned, not all its children. But if there are unversioned files
1534
under a versioned subdirectory, they are returned.
1536
Currently returned depth-first, sorted by name within directories.
1537
This is the same order used by 'osutils.walkdirs'.
1539
## TODO: Work from given directory downwards
1540
for path, dir_entry in self.inventory.directories():
1541
# mutter("search for unknowns in %r", path)
1542
dirabs = self.abspath(path)
1543
if not isdir(dirabs):
1544
# e.g. directory deleted
1548
for subf in os.listdir(dirabs):
1551
if subf not in dir_entry.children:
1552
subf_norm, can_access = osutils.normalized_filename(subf)
1553
if subf_norm != subf and can_access:
1554
if subf_norm not in dir_entry.children:
1555
fl.append(subf_norm)
1561
subp = pathjoin(path, subf)
1564
def ignored_files(self):
1565
"""Yield list of PATH, IGNORE_PATTERN"""
1566
for subp in self.extras():
1567
pat = self.is_ignored(subp)
1571
def get_ignore_list(self):
1572
"""Return list of ignore patterns.
1574
Cached in the Tree object after the first call.
1576
ignoreset = getattr(self, '_ignoreset', None)
1577
if ignoreset is not None:
1580
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1581
ignore_globs.update(ignores.get_runtime_ignores())
1582
ignore_globs.update(ignores.get_user_ignores())
1583
if self.has_filename(bzrlib.IGNORE_FILENAME):
1584
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1586
ignore_globs.update(ignores.parse_ignore_file(f))
1589
self._ignoreset = ignore_globs
1592
def _flush_ignore_list_cache(self):
1593
"""Resets the cached ignore list to force a cache rebuild."""
1594
self._ignoreset = None
1595
self._ignoreglobster = None
1597
def is_ignored(self, filename):
1598
r"""Check whether the filename matches an ignore pattern.
1600
Patterns containing '/' or '\' need to match the whole path;
1601
others match against only the last component.
1603
If the file is ignored, returns the pattern which caused it to
1604
be ignored, otherwise None. So this can simply be used as a
1605
boolean if desired."""
1606
if getattr(self, '_ignoreglobster', None) is None:
1607
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1608
return self._ignoreglobster.match(filename)
1610
def kind(self, file_id):
1611
return file_kind(self.id2abspath(file_id))
1613
def _comparison_data(self, entry, path):
1614
abspath = self.abspath(path)
1616
stat_value = os.lstat(abspath)
1618
if getattr(e, 'errno', None) == errno.ENOENT:
1625
mode = stat_value.st_mode
1626
kind = osutils.file_kind_from_stat_mode(mode)
1627
if not supports_executable():
1628
executable = entry.executable
1630
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1631
return kind, executable, stat_value
1633
def _file_size(self, entry, stat_value):
1634
return stat_value.st_size
1636
def last_revision(self):
1637
"""Return the last revision of the branch for this tree.
1639
This format tree does not support a separate marker for last-revision
1640
compared to the branch.
1642
See MutableTree.last_revision
1644
return self._last_revision()
1647
def _last_revision(self):
1648
"""helper for get_parent_ids."""
1649
return self.branch.last_revision()
1651
def is_locked(self):
1652
return self._control_files.is_locked()
1654
def _must_be_locked(self):
1655
if not self.is_locked():
1656
raise errors.ObjectNotLocked(self)
1658
def lock_read(self):
1659
"""See Branch.lock_read, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_read()
1664
return self._control_files.lock_read()
1666
self.branch.unlock()
1669
def lock_tree_write(self):
1670
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1671
if not self.is_locked():
1673
self.branch.lock_read()
1675
return self._control_files.lock_write()
1677
self.branch.unlock()
1680
def lock_write(self):
1681
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1682
if not self.is_locked():
1684
self.branch.lock_write()
1686
return self._control_files.lock_write()
1688
self.branch.unlock()
1691
def get_physical_lock_status(self):
1692
return self._control_files.get_physical_lock_status()
1694
def _basis_inventory_name(self):
1695
return 'basis-inventory-cache'
1697
def _reset_data(self):
1698
"""Reset transient data that cannot be revalidated."""
1699
self._inventory_is_modified = False
1700
result = self._deserialize(self._control_files.get('inventory'))
1701
self._set_inventory(result, dirty=False)
1703
@needs_tree_write_lock
1704
def set_last_revision(self, new_revision):
1705
"""Change the last revision in the working tree."""
1706
new_revision = osutils.safe_revision_id(new_revision)
1707
if self._change_last_revision(new_revision):
1708
self._cache_basis_inventory(new_revision)
1710
def _change_last_revision(self, new_revision):
1711
"""Template method part of set_last_revision to perform the change.
1713
This is used to allow WorkingTree3 instances to not affect branch
1714
when their last revision is set.
1716
if new_revision is None:
1717
self.branch.set_revision_history([])
1720
self.branch.generate_revision_history(new_revision)
1721
except errors.NoSuchRevision:
1722
# not present in the repo - dont try to set it deeper than the tip
1723
self.branch.set_revision_history([new_revision])
1726
def _write_basis_inventory(self, xml):
1727
"""Write the basis inventory XML to the basis-inventory file"""
1728
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1729
path = self._basis_inventory_name()
1731
self._control_files.put(path, sio)
1733
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1734
"""Create the text that will be saved in basis-inventory"""
1735
# TODO: jam 20070209 This should be redundant, as the revision_id
1736
# as all callers should have already converted the revision_id to
1738
inventory.revision_id = osutils.safe_revision_id(revision_id)
1739
return xml7.serializer_v7.write_inventory_to_string(inventory)
1741
def _cache_basis_inventory(self, new_revision):
1742
"""Cache new_revision as the basis inventory."""
1743
# TODO: this should allow the ready-to-use inventory to be passed in,
1744
# as commit already has that ready-to-use [while the format is the
1747
# this double handles the inventory - unpack and repack -
1748
# but is easier to understand. We can/should put a conditional
1749
# in here based on whether the inventory is in the latest format
1750
# - perhaps we should repack all inventories on a repository
1752
# the fast path is to copy the raw xml from the repository. If the
1753
# xml contains 'revision_id="', then we assume the right
1754
# revision_id is set. We must check for this full string, because a
1755
# root node id can legitimately look like 'revision_id' but cannot
1757
xml = self.branch.repository.get_inventory_xml(new_revision)
1758
firstline = xml.split('\n', 1)[0]
1759
if (not 'revision_id="' in firstline or
1760
'format="7"' not in firstline):
1761
inv = self.branch.repository.deserialise_inventory(
1763
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1764
self._write_basis_inventory(xml)
1765
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1768
def read_basis_inventory(self):
1769
"""Read the cached basis inventory."""
1770
path = self._basis_inventory_name()
1771
return self._control_files.get(path).read()
1774
def read_working_inventory(self):
1775
"""Read the working inventory.
1777
:raises errors.InventoryModified: read_working_inventory will fail
1778
when the current in memory inventory has been modified.
1780
# conceptually this should be an implementation detail of the tree.
1781
# XXX: Deprecate this.
1782
# ElementTree does its own conversion from UTF-8, so open in
1784
if self._inventory_is_modified:
1785
raise errors.InventoryModified(self)
1786
result = self._deserialize(self._control_files.get('inventory'))
1787
self._set_inventory(result, dirty=False)
1790
@needs_tree_write_lock
1791
def remove(self, files, verbose=False, to_file=None):
1792
"""Remove nominated files from the working inventory..
1794
This does not remove their text. This does not run on XXX on what? RBC
1796
TODO: Refuse to remove modified files unless --force is given?
1798
TODO: Do something useful with directories.
1800
TODO: Should this remove the text or not? Tough call; not
1801
removing may be useful and the user can just use use rm, and
1802
is the opposite of add. Removing it is consistent with most
1803
other tools. Maybe an option.
1805
## TODO: Normalize names
1806
## TODO: Remove nested loops; better scalability
1807
if isinstance(files, basestring):
1810
inv = self.inventory
1812
# do this before any modifications
1814
fid = inv.path2id(f)
1816
note("%s is not versioned."%f)
1819
# having remove it, it must be either ignored or unknown
1820
if self.is_ignored(f):
1824
textui.show_status(new_status, inv[fid].kind, f,
1828
self._write_inventory(inv)
1830
@needs_tree_write_lock
1831
def revert(self, filenames, old_tree=None, backups=True,
1832
pb=DummyProgress(), report_changes=False):
1833
from bzrlib.conflicts import resolve
1834
if old_tree is None:
1835
old_tree = self.basis_tree()
1836
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1838
if not len(filenames):
1839
self.set_parent_ids(self.get_parent_ids()[:1])
1842
resolve(self, filenames, ignore_misses=True)
1845
def revision_tree(self, revision_id):
1846
"""See Tree.revision_tree.
1848
WorkingTree can supply revision_trees for the basis revision only
1849
because there is only one cached inventory in the bzr directory.
1851
if revision_id == self.last_revision():
1853
xml = self.read_basis_inventory()
1854
except errors.NoSuchFile:
1858
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1859
# dont use the repository revision_tree api because we want
1860
# to supply the inventory.
1861
if inv.revision_id == revision_id:
1862
return revisiontree.RevisionTree(self.branch.repository,
1864
except errors.BadInventoryFormat:
1866
# raise if there was no inventory, or if we read the wrong inventory.
1867
raise errors.NoSuchRevisionInTree(self, revision_id)
1869
# XXX: This method should be deprecated in favour of taking in a proper
1870
# new Inventory object.
1871
@needs_tree_write_lock
1872
def set_inventory(self, new_inventory_list):
1873
from bzrlib.inventory import (Inventory,
1878
inv = Inventory(self.get_root_id())
1879
for path, file_id, parent, kind in new_inventory_list:
1880
name = os.path.basename(path)
1883
# fixme, there should be a factory function inv,add_??
1884
if kind == 'directory':
1885
inv.add(InventoryDirectory(file_id, name, parent))
1886
elif kind == 'file':
1887
inv.add(InventoryFile(file_id, name, parent))
1888
elif kind == 'symlink':
1889
inv.add(InventoryLink(file_id, name, parent))
1891
raise errors.BzrError("unknown kind %r" % kind)
1892
self._write_inventory(inv)
1894
@needs_tree_write_lock
1895
def set_root_id(self, file_id):
1896
"""Set the root id for this tree."""
1899
symbol_versioning.warn(symbol_versioning.zero_twelve
1900
% 'WorkingTree.set_root_id with fileid=None',
1905
file_id = osutils.safe_file_id(file_id)
1906
self._set_root_id(file_id)
1908
def _set_root_id(self, file_id):
1909
"""Set the root id for this tree, in a format specific manner.
1911
:param file_id: The file id to assign to the root. It must not be
1912
present in the current inventory or an error will occur. It must
1913
not be None, but rather a valid file id.
1915
inv = self._inventory
1916
orig_root_id = inv.root.file_id
1917
# TODO: it might be nice to exit early if there was nothing
1918
# to do, saving us from trigger a sync on unlock.
1919
self._inventory_is_modified = True
1920
# we preserve the root inventory entry object, but
1921
# unlinkit from the byid index
1922
del inv._byid[inv.root.file_id]
1923
inv.root.file_id = file_id
1924
# and link it into the index with the new changed id.
1925
inv._byid[inv.root.file_id] = inv.root
1926
# and finally update all children to reference the new id.
1927
# XXX: this should be safe to just look at the root.children
1928
# list, not the WHOLE INVENTORY.
1931
if entry.parent_id == orig_root_id:
1932
entry.parent_id = inv.root.file_id
1935
"""See Branch.unlock.
1937
WorkingTree locking just uses the Branch locking facilities.
1938
This is current because all working trees have an embedded branch
1939
within them. IF in the future, we were to make branch data shareable
1940
between multiple working trees, i.e. via shared storage, then we
1941
would probably want to lock both the local tree, and the branch.
1943
raise NotImplementedError(self.unlock)
1946
"""Update a working tree along its branch.
1948
This will update the branch if its bound too, which means we have
1949
multiple trees involved:
1951
- The new basis tree of the master.
1952
- The old basis tree of the branch.
1953
- The old basis tree of the working tree.
1954
- The current working tree state.
1956
Pathologically, all three may be different, and non-ancestors of each
1957
other. Conceptually we want to:
1959
- Preserve the wt.basis->wt.state changes
1960
- Transform the wt.basis to the new master basis.
1961
- Apply a merge of the old branch basis to get any 'local' changes from
1963
- Restore the wt.basis->wt.state changes.
1965
There isn't a single operation at the moment to do that, so we:
1966
- Merge current state -> basis tree of the master w.r.t. the old tree
1968
- Do a 'normal' merge of the old branch basis if it is relevant.
1970
if self.branch.get_master_branch() is not None:
1972
update_branch = True
1974
self.lock_tree_write()
1975
update_branch = False
1978
old_tip = self.branch.update()
1981
return self._update_tree(old_tip)
1985
@needs_tree_write_lock
1986
def _update_tree(self, old_tip=None):
1987
"""Update a tree to the master branch.
1989
:param old_tip: if supplied, the previous tip revision the branch,
1990
before it was changed to the master branch's tip.
1992
# here if old_tip is not None, it is the old tip of the branch before
1993
# it was updated from the master branch. This should become a pending
1994
# merge in the working tree to preserve the user existing work. we
1995
# cant set that until we update the working trees last revision to be
1996
# one from the new branch, because it will just get absorbed by the
1997
# parent de-duplication logic.
1999
# We MUST save it even if an error occurs, because otherwise the users
2000
# local work is unreferenced and will appear to have been lost.
2004
last_rev = self.get_parent_ids()[0]
2007
if last_rev != self.branch.last_revision():
2008
# merge tree state up to new branch tip.
2009
basis = self.basis_tree()
2012
to_tree = self.branch.basis_tree()
2013
if basis.inventory.root is None:
2014
self.set_root_id(to_tree.inventory.root.file_id)
2016
result += merge.merge_inner(
2023
# TODO - dedup parents list with things merged by pull ?
2024
# reuse the tree we've updated to to set the basis:
2025
parent_trees = [(self.branch.last_revision(), to_tree)]
2026
merges = self.get_parent_ids()[1:]
2027
# Ideally we ask the tree for the trees here, that way the working
2028
# tree can decide whether to give us teh entire tree or give us a
2029
# lazy initialised tree. dirstate for instance will have the trees
2030
# in ram already, whereas a last-revision + basis-inventory tree
2031
# will not, but also does not need them when setting parents.
2032
for parent in merges:
2033
parent_trees.append(
2034
(parent, self.branch.repository.revision_tree(parent)))
2035
if old_tip is not None:
2036
parent_trees.append(
2037
(old_tip, self.branch.repository.revision_tree(old_tip)))
2038
self.set_parent_trees(parent_trees)
2039
last_rev = parent_trees[0][0]
2041
# the working tree had the same last-revision as the master
2042
# branch did. We may still have pivot local work from the local
2043
# branch into old_tip:
2044
if old_tip is not None:
2045
self.add_parent_tree_id(old_tip)
2046
if old_tip and old_tip != last_rev:
2047
# our last revision was not the prior branch last revision
2048
# and we have converted that last revision to a pending merge.
2049
# base is somewhere between the branch tip now
2050
# and the now pending merge
2052
# Since we just modified the working tree and inventory, flush out
2053
# the current state, before we modify it again.
2054
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2055
# requires it only because TreeTransform directly munges the
2056
# inventory and calls tree._write_inventory(). Ultimately we
2057
# should be able to remove this extra flush.
2059
from bzrlib.revision import common_ancestor
2061
base_rev_id = common_ancestor(self.branch.last_revision(),
2063
self.branch.repository)
2064
except errors.NoCommonAncestor:
2066
base_tree = self.branch.repository.revision_tree(base_rev_id)
2067
other_tree = self.branch.repository.revision_tree(old_tip)
2068
result += merge.merge_inner(
2075
def _write_hashcache_if_dirty(self):
2076
"""Write out the hashcache if it is dirty."""
2077
if self._hashcache.needs_write:
2079
self._hashcache.write()
2081
if e.errno not in (errno.EPERM, errno.EACCES):
2083
# TODO: jam 20061219 Should this be a warning? A single line
2084
# warning might be sufficient to let the user know what
2086
mutter('Could not write hashcache for %s\nError: %s',
2087
self._hashcache.cache_file_name(), e)
2089
@needs_tree_write_lock
2090
def _write_inventory(self, inv):
2091
"""Write inventory as the current inventory."""
2092
self._set_inventory(inv, dirty=True)
2095
def set_conflicts(self, arg):
2096
raise errors.UnsupportedOperation(self.set_conflicts, self)
2098
def add_conflicts(self, arg):
2099
raise errors.UnsupportedOperation(self.add_conflicts, self)
2102
def conflicts(self):
2103
conflicts = _mod_conflicts.ConflictList()
2104
for conflicted in self._iter_conflicts():
2107
if file_kind(self.abspath(conflicted)) != "file":
2109
except errors.NoSuchFile:
2112
for suffix in ('.THIS', '.OTHER'):
2114
kind = file_kind(self.abspath(conflicted+suffix))
2117
except errors.NoSuchFile:
2121
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2122
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2124
file_id=self.path2id(conflicted)))
2127
def walkdirs(self, prefix=""):
2128
"""Walk the directories of this tree.
2130
This API returns a generator, which is only valid during the current
2131
tree transaction - within a single lock_read or lock_write duration.
2133
If the tree is not locked, it may cause an error to be raised, depending
2134
on the tree implementation.
2136
disk_top = self.abspath(prefix)
2137
if disk_top.endswith('/'):
2138
disk_top = disk_top[:-1]
2139
top_strip_len = len(disk_top) + 1
2140
inventory_iterator = self._walkdirs(prefix)
2141
disk_iterator = osutils.walkdirs(disk_top, prefix)
2143
current_disk = disk_iterator.next()
2144
disk_finished = False
2146
if e.errno != errno.ENOENT:
2149
disk_finished = True
2151
current_inv = inventory_iterator.next()
2152
inv_finished = False
2153
except StopIteration:
2156
while not inv_finished or not disk_finished:
2157
if not disk_finished:
2158
# strip out .bzr dirs
2159
if current_disk[0][1][top_strip_len:] == '':
2160
# osutils.walkdirs can be made nicer -
2161
# yield the path-from-prefix rather than the pathjoined
2163
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2164
if current_disk[1][bzrdir_loc][0] == '.bzr':
2165
# we dont yield the contents of, or, .bzr itself.
2166
del current_disk[1][bzrdir_loc]
2168
# everything is unknown
2171
# everything is missing
2174
direction = cmp(current_inv[0][0], current_disk[0][0])
2176
# disk is before inventory - unknown
2177
dirblock = [(relpath, basename, kind, stat, None, None) for
2178
relpath, basename, kind, stat, top_path in current_disk[1]]
2179
yield (current_disk[0][0], None), dirblock
2181
current_disk = disk_iterator.next()
2182
except StopIteration:
2183
disk_finished = True
2185
# inventory is before disk - missing.
2186
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2187
for relpath, basename, dkind, stat, fileid, kind in
2189
yield (current_inv[0][0], current_inv[0][1]), dirblock
2191
current_inv = inventory_iterator.next()
2192
except StopIteration:
2195
# versioned present directory
2196
# merge the inventory and disk data together
2198
for relpath, subiterator in itertools.groupby(sorted(
2199
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2200
path_elements = list(subiterator)
2201
if len(path_elements) == 2:
2202
inv_row, disk_row = path_elements
2203
# versioned, present file
2204
dirblock.append((inv_row[0],
2205
inv_row[1], disk_row[2],
2206
disk_row[3], inv_row[4],
2208
elif len(path_elements[0]) == 5:
2210
dirblock.append((path_elements[0][0],
2211
path_elements[0][1], path_elements[0][2],
2212
path_elements[0][3], None, None))
2213
elif len(path_elements[0]) == 6:
2214
# versioned, absent file.
2215
dirblock.append((path_elements[0][0],
2216
path_elements[0][1], 'unknown', None,
2217
path_elements[0][4], path_elements[0][5]))
2219
raise NotImplementedError('unreachable code')
2220
yield current_inv[0], dirblock
2222
current_inv = inventory_iterator.next()
2223
except StopIteration:
2226
current_disk = disk_iterator.next()
2227
except StopIteration:
2228
disk_finished = True
2230
def _walkdirs(self, prefix=""):
2231
_directory = 'directory'
2232
# get the root in the inventory
2233
inv = self.inventory
2234
top_id = inv.path2id(prefix)
2238
pending = [(prefix, '', _directory, None, top_id, None)]
2241
currentdir = pending.pop()
2242
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2243
top_id = currentdir[4]
2245
relroot = currentdir[0] + '/'
2248
# FIXME: stash the node in pending
2250
for name, child in entry.sorted_children():
2251
dirblock.append((relroot + name, name, child.kind, None,
2252
child.file_id, child.kind
2254
yield (currentdir[0], entry.file_id), dirblock
2255
# push the user specified dirs from dirblock
2256
for dir in reversed(dirblock):
2257
if dir[2] == _directory:
2260
@needs_tree_write_lock
2261
def auto_resolve(self):
2262
"""Automatically resolve text conflicts according to contents.
2264
Only text conflicts are auto_resolvable. Files with no conflict markers
2265
are considered 'resolved', because bzr always puts conflict markers
2266
into files that have text conflicts. The corresponding .THIS .BASE and
2267
.OTHER files are deleted, as per 'resolve'.
2268
:return: a tuple of ConflictLists: (un_resolved, resolved).
2270
un_resolved = _mod_conflicts.ConflictList()
2271
resolved = _mod_conflicts.ConflictList()
2272
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2273
for conflict in self.conflicts():
2274
if (conflict.typestring != 'text conflict' or
2275
self.kind(conflict.file_id) != 'file'):
2276
un_resolved.append(conflict)
2278
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2280
for line in my_file:
2281
if conflict_re.search(line):
2282
un_resolved.append(conflict)
2285
resolved.append(conflict)
2288
resolved.remove_files(self)
2289
self.set_conflicts(un_resolved)
2290
return un_resolved, resolved
2293
class WorkingTree2(WorkingTree):
2294
"""This is the Format 2 working tree.
2296
This was the first weave based working tree.
2297
- uses os locks for locking.
2298
- uses the branch last-revision.
2301
def lock_tree_write(self):
2302
"""See WorkingTree.lock_tree_write().
2304
In Format2 WorkingTrees we have a single lock for the branch and tree
2305
so lock_tree_write() degrades to lock_write().
2307
self.branch.lock_write()
2309
return self._control_files.lock_write()
2311
self.branch.unlock()
2315
# we share control files:
2316
if self._control_files._lock_count == 3:
2317
# _inventory_is_modified is always False during a read lock.
2318
if self._inventory_is_modified:
2320
self._write_hashcache_if_dirty()
2322
# reverse order of locking.
2324
return self._control_files.unlock()
2326
self.branch.unlock()
2329
class WorkingTree3(WorkingTree):
2330
"""This is the Format 3 working tree.
2332
This differs from the base WorkingTree by:
2333
- having its own file lock
2334
- having its own last-revision property.
2336
This is new in bzr 0.8
2340
def _last_revision(self):
2341
"""See Mutable.last_revision."""
2343
return osutils.safe_revision_id(
2344
self._control_files.get('last-revision').read())
2345
except errors.NoSuchFile:
2348
def _change_last_revision(self, revision_id):
2349
"""See WorkingTree._change_last_revision."""
2350
if revision_id is None or revision_id == NULL_REVISION:
2352
self._control_files._transport.delete('last-revision')
2353
except errors.NoSuchFile:
2357
self._control_files.put_bytes('last-revision', revision_id)
2360
@needs_tree_write_lock
2361
def set_conflicts(self, conflicts):
2362
self._put_rio('conflicts', conflicts.to_stanzas(),
2365
@needs_tree_write_lock
2366
def add_conflicts(self, new_conflicts):
2367
conflict_set = set(self.conflicts())
2368
conflict_set.update(set(list(new_conflicts)))
2369
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2370
key=_mod_conflicts.Conflict.sort_key)))
2373
def conflicts(self):
2375
confile = self._control_files.get('conflicts')
2376
except errors.NoSuchFile:
2377
return _mod_conflicts.ConflictList()
2379
if confile.next() != CONFLICT_HEADER_1 + '\n':
2380
raise errors.ConflictFormatError()
2381
except StopIteration:
2382
raise errors.ConflictFormatError()
2383
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2386
if self._control_files._lock_count == 1:
2387
# _inventory_is_modified is always False during a read lock.
2388
if self._inventory_is_modified:
2390
self._write_hashcache_if_dirty()
2391
# reverse order of locking.
2393
return self._control_files.unlock()
2395
self.branch.unlock()
2398
def get_conflicted_stem(path):
2399
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2400
if path.endswith(suffix):
2401
return path[:-len(suffix)]
2404
@deprecated_function(zero_eight)
2405
def is_control_file(filename):
2406
"""See WorkingTree.is_control_filename(filename)."""
2407
## FIXME: better check
2408
filename = normpath(filename)
2409
while filename != '':
2410
head, tail = os.path.split(filename)
2411
## mutter('check %r for control file' % ((head, tail),))
2414
if filename == head:
2420
class WorkingTreeFormat(object):
2421
"""An encapsulation of the initialization and open routines for a format.
2423
Formats provide three things:
2424
* An initialization routine,
2428
Formats are placed in an dict by their format string for reference
2429
during workingtree opening. Its not required that these be instances, they
2430
can be classes themselves with class methods - it simply depends on
2431
whether state is needed for a given format or not.
2433
Once a format is deprecated, just deprecate the initialize and open
2434
methods on the format class. Do not deprecate the object, as the
2435
object will be created every time regardless.
2438
_default_format = None
2439
"""The default format used for new trees."""
2442
"""The known formats."""
2444
requires_rich_root = False
2447
def find_format(klass, a_bzrdir):
2448
"""Return the format for the working tree object in a_bzrdir."""
2450
transport = a_bzrdir.get_workingtree_transport(None)
2451
format_string = transport.get("format").read()
2452
return klass._formats[format_string]
2453
except errors.NoSuchFile:
2454
raise errors.NoWorkingTree(base=transport.base)
2456
raise errors.UnknownFormatError(format=format_string)
2458
def __eq__(self, other):
2459
return self.__class__ is other.__class__
2461
def __ne__(self, other):
2462
return not (self == other)
2465
def get_default_format(klass):
2466
"""Return the current default format."""
2467
return klass._default_format
2469
def get_format_string(self):
2470
"""Return the ASCII format string that identifies this format."""
2471
raise NotImplementedError(self.get_format_string)
2473
def get_format_description(self):
2474
"""Return the short description for this format."""
2475
raise NotImplementedError(self.get_format_description)
2477
def is_supported(self):
2478
"""Is this format supported?
2480
Supported formats can be initialized and opened.
2481
Unsupported formats may not support initialization or committing or
2482
some other features depending on the reason for not being supported.
2487
def register_format(klass, format):
2488
klass._formats[format.get_format_string()] = format
2491
def set_default_format(klass, format):
2492
klass._default_format = format
2495
def unregister_format(klass, format):
2496
assert klass._formats[format.get_format_string()] is format
2497
del klass._formats[format.get_format_string()]
2501
class WorkingTreeFormat2(WorkingTreeFormat):
2502
"""The second working tree format.
2504
This format modified the hash cache from the format 1 hash cache.
2507
def get_format_description(self):
2508
"""See WorkingTreeFormat.get_format_description()."""
2509
return "Working tree format 2"
2511
def stub_initialize_remote(self, control_files):
2512
"""As a special workaround create critical control files for a remote working tree
2514
This ensures that it can later be updated and dealt with locally,
2515
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2516
no working tree. (See bug #43064).
2520
xml5.serializer_v5.write_inventory(inv, sio)
2522
control_files.put('inventory', sio)
2524
control_files.put_bytes('pending-merges', '')
2527
def initialize(self, a_bzrdir, revision_id=None):
2528
"""See WorkingTreeFormat.initialize()."""
2529
if not isinstance(a_bzrdir.transport, LocalTransport):
2530
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2531
branch = a_bzrdir.open_branch()
2532
if revision_id is not None:
2533
revision_id = osutils.safe_revision_id(revision_id)
2536
revision_history = branch.revision_history()
2538
position = revision_history.index(revision_id)
2540
raise errors.NoSuchRevision(branch, revision_id)
2541
branch.set_revision_history(revision_history[:position + 1])
2544
revision = branch.last_revision()
2546
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2552
basis_tree = branch.repository.revision_tree(revision)
2553
if basis_tree.inventory.root is not None:
2554
wt.set_root_id(basis_tree.inventory.root.file_id)
2555
# set the parent list and cache the basis tree.
2556
wt.set_parent_trees([(revision, basis_tree)])
2557
transform.build_tree(basis_tree, wt)
2561
super(WorkingTreeFormat2, self).__init__()
2562
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2564
def open(self, a_bzrdir, _found=False):
2565
"""Return the WorkingTree object for a_bzrdir
2567
_found is a private parameter, do not use it. It is used to indicate
2568
if format probing has already been done.
2571
# we are being called directly and must probe.
2572
raise NotImplementedError
2573
if not isinstance(a_bzrdir.transport, LocalTransport):
2574
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2575
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2581
class WorkingTreeFormat3(WorkingTreeFormat):
2582
"""The second working tree format updated to record a format marker.
2585
- exists within a metadir controlling .bzr
2586
- includes an explicit version marker for the workingtree control
2587
files, separate from the BzrDir format
2588
- modifies the hash cache format
2590
- uses a LockDir to guard access for writes.
2593
def get_format_string(self):
2594
"""See WorkingTreeFormat.get_format_string()."""
2595
return "Bazaar-NG Working Tree format 3"
2597
def get_format_description(self):
2598
"""See WorkingTreeFormat.get_format_description()."""
2599
return "Working tree format 3"
2601
_lock_file_name = 'lock'
2602
_lock_class = LockDir
2604
_tree_class = WorkingTree3
2606
def __get_matchingbzrdir(self):
2607
return bzrdir.BzrDirMetaFormat1()
2609
_matchingbzrdir = property(__get_matchingbzrdir)
2611
def _open_control_files(self, a_bzrdir):
2612
transport = a_bzrdir.get_workingtree_transport(None)
2613
return LockableFiles(transport, self._lock_file_name,
2616
def initialize(self, a_bzrdir, revision_id=None):
2617
"""See WorkingTreeFormat.initialize().
2619
revision_id allows creating a working tree at a different
2620
revision than the branch is at.
2622
if not isinstance(a_bzrdir.transport, LocalTransport):
2623
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2624
transport = a_bzrdir.get_workingtree_transport(self)
2625
control_files = self._open_control_files(a_bzrdir)
2626
control_files.create_lock()
2627
control_files.lock_write()
2628
control_files.put_utf8('format', self.get_format_string())
2629
branch = a_bzrdir.open_branch()
2630
if revision_id is None:
2631
revision_id = branch.last_revision()
2633
revision_id = osutils.safe_revision_id(revision_id)
2634
# WorkingTree3 can handle an inventory which has a unique root id.
2635
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2636
# those trees. And because there isn't a format bump inbetween, we
2637
# are maintaining compatibility with older clients.
2638
# inv = Inventory(root_id=gen_root_id())
2639
inv = self._initial_inventory()
2640
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2646
_control_files=control_files)
2647
wt.lock_tree_write()
2649
basis_tree = branch.repository.revision_tree(revision_id)
2650
# only set an explicit root id if there is one to set.
2651
if basis_tree.inventory.root is not None:
2652
wt.set_root_id(basis_tree.inventory.root.file_id)
2653
if revision_id == NULL_REVISION:
2654
wt.set_parent_trees([])
2656
wt.set_parent_trees([(revision_id, basis_tree)])
2657
transform.build_tree(basis_tree, wt)
2659
# Unlock in this order so that the unlock-triggers-flush in
2660
# WorkingTree is given a chance to fire.
2661
control_files.unlock()
2665
def _initial_inventory(self):
2669
super(WorkingTreeFormat3, self).__init__()
2671
def open(self, a_bzrdir, _found=False):
2672
"""Return the WorkingTree object for a_bzrdir
2674
_found is a private parameter, do not use it. It is used to indicate
2675
if format probing has already been done.
2678
# we are being called directly and must probe.
2679
raise NotImplementedError
2680
if not isinstance(a_bzrdir.transport, LocalTransport):
2681
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2682
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2684
def _open(self, a_bzrdir, control_files):
2685
"""Open the tree itself.
2687
:param a_bzrdir: the dir for the tree.
2688
:param control_files: the control files for the tree.
2690
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2694
_control_files=control_files)
2697
return self.get_format_string()
2700
__default_format = WorkingTreeFormat4()
2701
WorkingTreeFormat.register_format(__default_format)
2702
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2703
WorkingTreeFormat.set_default_format(__default_format)
2704
# formats which have no format string are not discoverable
2705
# and not independently creatable, so are not registered.
2706
_legacy_formats = [WorkingTreeFormat2(),
2710
class WorkingTreeTestProviderAdapter(object):
2711
"""A tool to generate a suite testing multiple workingtree formats at once.
2713
This is done by copying the test once for each transport and injecting
2714
the transport_server, transport_readonly_server, and workingtree_format
2715
classes into each copy. Each copy is also given a new id() to make it
2719
def __init__(self, transport_server, transport_readonly_server, formats):
2720
self._transport_server = transport_server
2721
self._transport_readonly_server = transport_readonly_server
2722
self._formats = formats
2724
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2725
"""Clone test for adaption."""
2726
new_test = deepcopy(test)
2727
new_test.transport_server = self._transport_server
2728
new_test.transport_readonly_server = self._transport_readonly_server
2729
new_test.bzrdir_format = bzrdir_format
2730
new_test.workingtree_format = workingtree_format
2731
def make_new_test_id():
2732
new_id = "%s(%s)" % (test.id(), variation)
2733
return lambda: new_id
2734
new_test.id = make_new_test_id()
2737
def adapt(self, test):
2738
from bzrlib.tests import TestSuite
2739
result = TestSuite()
2740
for workingtree_format, bzrdir_format in self._formats:
2741
new_test = self._clone_test(
2744
workingtree_format, workingtree_format.__class__.__name__)
2745
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
