1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
45
from copy import deepcopy
54
conflicts as _mod_conflicts,
70
from bzrlib.transport import get_transport
74
from bzrlib import symbol_versioning
75
from bzrlib.decorators import needs_read_lock, needs_write_lock
76
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
77
from bzrlib.lockable_files import LockableFiles, TransportLock
78
from bzrlib.lockdir import LockDir
79
import bzrlib.mutabletree
80
from bzrlib.mutabletree import needs_tree_write_lock
81
from bzrlib.osutils import (
93
from bzrlib.trace import mutter, note
94
from bzrlib.transport.local import LocalTransport
95
from bzrlib.progress import DummyProgress, ProgressPhase
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
97
from bzrlib.rio import RioReader, rio_file, Stanza
98
from bzrlib.symbol_versioning import (deprecated_passed,
101
DEPRECATED_PARAMETER,
108
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
109
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
@deprecated_function(zero_thirteen)
113
def gen_file_id(name):
114
"""Return new file id for the basename 'name'.
116
Use bzrlib.generate_ids.gen_file_id() instead
118
return generate_ids.gen_file_id(name)
121
@deprecated_function(zero_thirteen)
123
"""Return a new tree-root file id.
125
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
127
return generate_ids.gen_root_id()
130
class TreeEntry(object):
131
"""An entry that implements the minimum interface used by commands.
133
This needs further inspection, it may be better to have
134
InventoryEntries without ids - though that seems wrong. For now,
135
this is a parallel hierarchy to InventoryEntry, and needs to become
136
one of several things: decorates to that hierarchy, children of, or
138
Another note is that these objects are currently only used when there is
139
no InventoryEntry available - i.e. for unversioned objects.
140
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
143
def __eq__(self, other):
144
# yes, this us ugly, TODO: best practice __eq__ style.
145
return (isinstance(other, TreeEntry)
146
and other.__class__ == self.__class__)
148
def kind_character(self):
152
class TreeDirectory(TreeEntry):
153
"""See TreeEntry. This is a directory in a working tree."""
155
def __eq__(self, other):
156
return (isinstance(other, TreeDirectory)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeFile(TreeEntry):
164
"""See TreeEntry. This is a regular file in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeFile)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class TreeLink(TreeEntry):
175
"""See TreeEntry. This is a symlink in a working tree."""
177
def __eq__(self, other):
178
return (isinstance(other, TreeLink)
179
and other.__class__ == self.__class__)
181
def kind_character(self):
185
class WorkingTree(bzrlib.mutabletree.MutableTree):
186
"""Working copy tree.
188
The inventory is held in the `Branch` working-inventory, and the
189
files are in a directory on disk.
191
It is possible for a `WorkingTree` to have a filename which is
192
not listed in the Inventory and vice versa.
195
def __init__(self, basedir='.',
196
branch=DEPRECATED_PARAMETER,
202
"""Construct a WorkingTree for basedir.
204
If the branch is not supplied, it is opened automatically.
205
If the branch is supplied, it must be the branch for this basedir.
206
(branch.base is not cross checked, because for remote branches that
207
would be meaningless).
209
self._format = _format
210
self.bzrdir = _bzrdir
212
# not created via open etc.
213
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
214
"Please use bzrdir.open_workingtree or WorkingTree.open().",
217
wt = WorkingTree.open(basedir)
218
self._branch = wt.branch
219
self.basedir = wt.basedir
220
self._control_files = wt._control_files
221
self._hashcache = wt._hashcache
222
self._set_inventory(wt._inventory, dirty=False)
223
self._format = wt._format
224
self.bzrdir = wt.bzrdir
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):
231
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
232
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
233
" WorkingTree.open().",
237
self._branch = branch
239
self._branch = self.bzrdir.open_branch()
240
self.basedir = realpath(basedir)
241
# if branch is at our basedir and is a format 6 or less
242
if isinstance(self._format, WorkingTreeFormat2):
243
# share control object
244
self._control_files = self.branch.control_files
246
# assume all other formats have their own control files.
247
assert isinstance(_control_files, LockableFiles), \
248
"_control_files must be a LockableFiles, not %r" \
250
self._control_files = _control_files
251
# update the whole cache up front and write to disk if anything changed;
252
# in the future we might want to do this more selectively
253
# two possible ways offer themselves : in self._unlock, write the cache
254
# if needed, or, when the cache sees a change, append it to the hash
255
# cache file, and have the parser take the most recent entry for a
257
wt_trans = self.bzrdir.get_workingtree_transport(None)
258
cache_filename = wt_trans.local_abspath('stat-cache')
259
self._hashcache = hashcache.HashCache(basedir, cache_filename,
260
self._control_files._file_mode)
263
# is this scan needed ? it makes things kinda slow.
270
if _inventory is None:
271
self._inventory_is_modified = False
272
self.read_working_inventory()
274
# the caller of __init__ has provided an inventory,
275
# we assume they know what they are doing - as its only
276
# the Format factory and creation methods that are
277
# permitted to do this.
278
self._set_inventory(_inventory, dirty=False)
281
fget=lambda self: self._branch,
282
doc="""The branch this WorkingTree is connected to.
284
This cannot be set - it is reflective of the actual disk structure
285
the working tree has been constructed from.
288
def break_lock(self):
289
"""Break a lock if one is present from another instance.
291
Uses the ui factory to ask for confirmation if the lock may be from
294
This will probe the repository for its lock as well.
296
self._control_files.break_lock()
297
self.branch.break_lock()
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)
351
"""Iterate through file_ids for this tree.
353
file_ids are in a WorkingTree if they are in the working inventory
354
and the working file exists.
356
inv = self._inventory
357
for path, ie in inv.iter_entries():
358
if osutils.lexists(self.abspath(path)):
362
return "<%s of %s>" % (self.__class__.__name__,
363
getattr(self, 'basedir', None))
365
def abspath(self, filename):
366
return pathjoin(self.basedir, filename)
368
def basis_tree(self):
369
"""Return RevisionTree for the current last revision.
371
If the left most parent is a ghost then the returned tree will be an
372
empty tree - one obtained by calling repository.revision_tree(None).
375
revision_id = self.get_parent_ids()[0]
377
# no parents, return an empty revision tree.
378
# in the future this should return the tree for
379
# 'empty:' - the implicit root empty tree.
380
return self.branch.repository.revision_tree(None)
382
return self.revision_tree(revision_id)
383
except errors.NoSuchRevision:
385
# No cached copy available, retrieve from the repository.
386
# FIXME? RBC 20060403 should we cache the inventory locally
389
return self.branch.repository.revision_tree(revision_id)
390
except errors.RevisionNotPresent:
391
# the basis tree *may* be a ghost or a low level error may have
392
# occured. If the revision is present, its a problem, if its not
394
if self.branch.repository.has_revision(revision_id):
396
# the basis tree is a ghost so return an empty tree.
397
return self.branch.repository.revision_tree(None)
400
@deprecated_method(zero_eight)
401
def create(branch, directory):
402
"""Create a workingtree for branch at directory.
404
If existing_directory already exists it must have a .bzr directory.
405
If it does not exist, it will be created.
407
This returns a new WorkingTree object for the new checkout.
409
TODO FIXME RBC 20060124 when we have checkout formats in place this
410
should accept an optional revisionid to checkout [and reject this if
411
checking out into the same dir as a pre-checkout-aware branch format.]
413
XXX: When BzrDir is present, these should be created through that
416
warnings.warn('delete WorkingTree.create', stacklevel=3)
417
transport = get_transport(directory)
418
if branch.bzrdir.root_transport.base == transport.base:
420
return branch.bzrdir.create_workingtree()
421
# different directory,
422
# create a branch reference
423
# and now a working tree.
424
raise NotImplementedError
427
@deprecated_method(zero_eight)
428
def create_standalone(directory):
429
"""Create a checkout and a branch and a repo at directory.
431
Directory must exist and be empty.
433
please use BzrDir.create_standalone_workingtree
435
return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
def relpath(self, path):
438
"""Return the local path portion from a given path.
440
The path may be absolute or relative. If its a relative path it is
441
interpreted relative to the python current working directory.
443
return osutils.relpath(self.basedir, path)
445
def has_filename(self, filename):
446
return osutils.lexists(self.abspath(filename))
448
def get_file(self, file_id):
449
return self.get_file_byname(self.id2path(file_id))
451
def get_file_text(self, file_id):
452
return self.get_file(file_id).read()
454
def get_file_byname(self, filename):
455
return file(self.abspath(filename), 'rb')
457
def annotate_iter(self, file_id):
458
"""See Tree.annotate_iter
460
This implementation will use the basis tree implementation if possible.
461
Lines not in the basis are attributed to CURRENT_REVISION
463
If there are pending merges, lines added by those merges will be
464
incorrectly attributed to CURRENT_REVISION (but after committing, the
465
attribution will be correct).
467
basis = self.basis_tree()
468
changes = self._iter_changes(basis, True, [file_id]).next()
469
changed_content, kind = changes[2], changes[6]
470
if not changed_content:
471
return basis.annotate_iter(file_id)
475
if kind[0] != 'file':
478
old_lines = list(basis.annotate_iter(file_id))
480
for tree in self.branch.repository.revision_trees(
481
self.get_parent_ids()[1:]):
482
if file_id not in tree:
484
old.append(list(tree.annotate_iter(file_id)))
485
return annotate.reannotate(old, self.get_file(file_id).readlines(),
488
def get_parent_ids(self):
489
"""See Tree.get_parent_ids.
491
This implementation reads the pending merges list and last_revision
492
value and uses that to decide what the parents list should be.
494
last_rev = self._last_revision()
500
merges_file = self._control_files.get_utf8('pending-merges')
501
except errors.NoSuchFile:
504
for l in merges_file.readlines():
505
parents.append(l.rstrip('\n'))
509
def get_root_id(self):
510
"""Return the id of this trees root"""
511
return self._inventory.root.file_id
513
def _get_store_filename(self, file_id):
514
## XXX: badly named; this is not in the store at all
515
return self.abspath(self.id2path(file_id))
518
def clone(self, to_bzrdir, revision_id=None, basis=None):
519
"""Duplicate this working tree into to_bzr, including all state.
521
Specifically modified files are kept as modified, but
522
ignored and unknown files are discarded.
524
If you want to make a new line of development, see bzrdir.sprout()
527
If not None, the cloned tree will have its last revision set to
528
revision, and and difference between the source trees last revision
529
and this one merged in.
532
If not None, a closer copy of a tree which may have some files in
533
common, and which file content should be preferentially copied from.
535
# assumes the target bzr dir format is compatible.
536
result = self._format.initialize(to_bzrdir)
537
self.copy_content_into(result, revision_id)
541
def copy_content_into(self, tree, revision_id=None):
542
"""Copy the current content and user files of this tree into tree."""
543
tree.set_root_id(self.get_root_id())
544
if revision_id is None:
545
merge.transform_tree(tree, self)
547
# TODO now merge from tree.last_revision to revision (to preserve
548
# user local changes)
549
merge.transform_tree(tree, self)
550
tree.set_parent_ids([revision_id])
552
def id2abspath(self, file_id):
553
return self.abspath(self.id2path(file_id))
555
def has_id(self, file_id):
556
# files that have been deleted are excluded
557
inv = self._inventory
558
if not inv.has_id(file_id):
560
path = inv.id2path(file_id)
561
return osutils.lexists(self.abspath(path))
563
def has_or_had_id(self, file_id):
564
if file_id == self.inventory.root.file_id:
566
return self.inventory.has_id(file_id)
568
__contains__ = has_id
570
def get_file_size(self, file_id):
571
return os.path.getsize(self.id2abspath(file_id))
574
def get_file_sha1(self, file_id, path=None, stat_value=None):
576
path = self._inventory.id2path(file_id)
577
return self._hashcache.get_sha1(path, stat_value)
579
def get_file_mtime(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
return os.lstat(self.abspath(path)).st_mtime
584
if not supports_executable():
585
def is_executable(self, file_id, path=None):
586
return self._inventory[file_id].executable
588
def is_executable(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
mode = os.lstat(self.abspath(path)).st_mode
592
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
595
def _add(self, files, ids, kinds):
596
"""See MutableTree._add."""
597
# TODO: Re-adding a file that is removed in the working copy
598
# should probably put it back with the previous ID.
599
# the read and write working inventory should not occur in this
600
# function - they should be part of lock_write and unlock.
601
inv = self.read_working_inventory()
602
for f, file_id, kind in zip(files, ids, kinds):
603
assert kind is not None
605
inv.add_path(f, kind=kind)
607
inv.add_path(f, kind=kind, file_id=file_id)
608
self._write_inventory(inv)
610
@needs_tree_write_lock
611
def _gather_kinds(self, files, kinds):
612
"""See MutableTree._gather_kinds."""
613
for pos, f in enumerate(files):
614
if kinds[pos] is None:
615
fullpath = normpath(self.abspath(f))
617
kinds[pos] = file_kind(fullpath)
619
if e.errno == errno.ENOENT:
620
raise errors.NoSuchFile(fullpath)
623
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
624
"""Add revision_id as a parent.
626
This is equivalent to retrieving the current list of parent ids
627
and setting the list to its value plus revision_id.
629
:param revision_id: The revision id to add to the parent list. It may
630
be a ghost revision as long as its not the first parent to be added,
631
or the allow_leftmost_as_ghost parameter is set True.
632
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
634
parents = self.get_parent_ids() + [revision_id]
635
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
636
or allow_leftmost_as_ghost)
638
@needs_tree_write_lock
639
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
640
"""Add revision_id, tree tuple as a parent.
642
This is equivalent to retrieving the current list of parent trees
643
and setting the list to its value plus parent_tuple. See also
644
add_parent_tree_id - if you only have a parent id available it will be
645
simpler to use that api. If you have the parent already available, using
646
this api is preferred.
648
:param parent_tuple: The (revision id, tree) to add to the parent list.
649
If the revision_id is a ghost, pass None for the tree.
650
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
653
if len(parent_ids) > 1:
654
# the leftmost may have already been a ghost, preserve that if it
656
allow_leftmost_as_ghost = True
657
self.set_parent_ids(parent_ids,
658
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
660
@needs_tree_write_lock
661
def add_pending_merge(self, *revision_ids):
662
# TODO: Perhaps should check at this point that the
663
# history of the revision is actually present?
664
parents = self.get_parent_ids()
666
for rev_id in revision_ids:
667
if rev_id in parents:
669
parents.append(rev_id)
672
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
674
@deprecated_method(zero_eleven)
676
def pending_merges(self):
677
"""Return a list of pending merges.
679
These are revisions that have been merged into the working
680
directory but not yet committed.
682
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
683
instead - which is available on all tree objects.
685
return self.get_parent_ids()[1:]
687
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
688
"""Common ghost checking functionality from set_parent_*.
690
This checks that the left hand-parent exists if there are any
693
if len(revision_ids) > 0:
694
leftmost_id = revision_ids[0]
695
if (not allow_leftmost_as_ghost and not
696
self.branch.repository.has_revision(leftmost_id)):
697
raise errors.GhostRevisionUnusableHere(leftmost_id)
699
def _set_merges_from_parent_ids(self, parent_ids):
700
merges = parent_ids[1:]
701
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
703
@needs_tree_write_lock
704
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
705
"""Set the parent ids to revision_ids.
707
See also set_parent_trees. This api will try to retrieve the tree data
708
for each element of revision_ids from the trees repository. If you have
709
tree data already available, it is more efficient to use
710
set_parent_trees rather than set_parent_ids. set_parent_ids is however
711
an easier API to use.
713
:param revision_ids: The revision_ids to set as the parent ids of this
714
working tree. Any of these may be ghosts.
716
self._check_parents_for_ghosts(revision_ids,
717
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
719
if len(revision_ids) > 0:
720
self.set_last_revision(revision_ids[0])
722
self.set_last_revision(None)
724
self._set_merges_from_parent_ids(revision_ids)
726
@needs_tree_write_lock
727
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
728
"""See MutableTree.set_parent_trees."""
729
parent_ids = [rev for (rev, tree) in parents_list]
731
self._check_parents_for_ghosts(parent_ids,
732
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
734
if len(parent_ids) == 0:
735
leftmost_parent_id = None
736
leftmost_parent_tree = None
738
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
740
if self._change_last_revision(leftmost_parent_id):
741
if leftmost_parent_tree is None:
742
# If we don't have a tree, fall back to reading the
743
# parent tree from the repository.
744
self._cache_basis_inventory(leftmost_parent_id)
746
inv = leftmost_parent_tree.inventory
747
xml = self._create_basis_xml_from_inventory(
748
leftmost_parent_id, inv)
749
self._write_basis_inventory(xml)
750
self._set_merges_from_parent_ids(parent_ids)
752
@needs_tree_write_lock
753
def set_pending_merges(self, rev_list):
754
parents = self.get_parent_ids()
755
leftmost = parents[:1]
756
new_parents = leftmost + rev_list
757
self.set_parent_ids(new_parents)
759
@needs_tree_write_lock
760
def set_merge_modified(self, modified_hashes):
762
for file_id, hash in modified_hashes.iteritems():
763
yield Stanza(file_id=file_id, hash=hash)
764
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
766
@needs_tree_write_lock
767
def _put_rio(self, filename, stanzas, header):
768
my_file = rio_file(stanzas, header)
769
self._control_files.put(filename, my_file)
771
@needs_write_lock # because merge pulls data into the branch.
772
def merge_from_branch(self, branch, to_revision=None):
773
"""Merge from a branch into this working tree.
775
:param branch: The branch to merge from.
776
:param to_revision: If non-None, the merge will merge to to_revision,
777
but not beyond it. to_revision does not need to be in the history
778
of the branch when it is supplied. If None, to_revision defaults to
779
branch.last_revision().
781
from bzrlib.merge import Merger, Merge3Merger
782
pb = bzrlib.ui.ui_factory.nested_progress_bar()
784
merger = Merger(self.branch, this_tree=self, pb=pb)
785
merger.pp = ProgressPhase("Merge phase", 5, pb)
786
merger.pp.next_phase()
787
# check that there are no
789
merger.check_basis(check_clean=True, require_commits=False)
790
if to_revision is None:
791
to_revision = branch.last_revision()
792
merger.other_rev_id = to_revision
793
if merger.other_rev_id is None:
794
raise error.NoCommits(branch)
795
self.branch.fetch(branch, last_revision=merger.other_rev_id)
796
merger.other_basis = merger.other_rev_id
797
merger.other_tree = self.branch.repository.revision_tree(
799
merger.pp.next_phase()
801
if merger.base_rev_id == merger.other_rev_id:
802
raise errors.PointlessMerge
803
merger.backup_files = False
804
merger.merge_type = Merge3Merger
805
merger.set_interesting_files(None)
806
merger.show_base = False
807
merger.reprocess = False
808
conflicts = merger.do_merge()
815
def merge_modified(self):
817
hashfile = self._control_files.get('merge-hashes')
818
except errors.NoSuchFile:
822
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
823
raise errors.MergeModifiedFormatError()
824
except StopIteration:
825
raise errors.MergeModifiedFormatError()
826
for s in RioReader(hashfile):
827
file_id = s.get("file_id")
828
if file_id not in self.inventory:
831
if hash == self.get_file_sha1(file_id):
832
merge_hashes[file_id] = hash
836
def mkdir(self, path, file_id=None):
837
"""See MutableTree.mkdir()."""
839
file_id = generate_ids.gen_file_id(os.path.basename(path))
840
os.mkdir(self.abspath(path))
841
self.add(path, file_id, 'directory')
844
def get_symlink_target(self, file_id):
845
return os.readlink(self.id2abspath(file_id))
847
def file_class(self, filename):
848
if self.path2id(filename):
850
elif self.is_ignored(filename):
856
"""Write the in memory inventory to disk."""
857
# TODO: Maybe this should only write on dirty ?
858
if self._control_files._lock_mode != 'w':
859
raise errors.NotWriteLocked(self)
861
xml5.serializer_v5.write_inventory(self._inventory, sio)
863
self._control_files.put('inventory', sio)
864
self._inventory_is_modified = False
866
def list_files(self, include_root=False):
867
"""Recursively list all files as (path, class, kind, id, entry).
869
Lists, but does not descend into unversioned directories.
871
This does not include files that have been deleted in this
874
Skips the control directory.
876
inv = self._inventory
877
if include_root is True:
878
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
879
# Convert these into local objects to save lookup times
880
pathjoin = osutils.pathjoin
881
file_kind = osutils.file_kind
883
# transport.base ends in a slash, we want the piece
884
# between the last two slashes
885
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
887
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
889
# directory file_id, relative path, absolute path, reverse sorted children
890
children = os.listdir(self.basedir)
892
# jam 20060527 The kernel sized tree seems equivalent whether we
893
# use a deque and popleft to keep them sorted, or if we use a plain
894
# list and just reverse() them.
895
children = collections.deque(children)
896
stack = [(inv.root.file_id, u'', self.basedir, children)]
898
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
901
f = children.popleft()
902
## TODO: If we find a subdirectory with its own .bzr
903
## directory, then that is a separate tree and we
904
## should exclude it.
906
# the bzrdir for this tree
907
if transport_base_dir == f:
910
# we know that from_dir_relpath and from_dir_abspath never end in a slash
911
# and 'f' doesn't begin with one, we can do a string op, rather
912
# than the checks of pathjoin(), all relative paths will have an extra slash
914
fp = from_dir_relpath + '/' + f
917
fap = from_dir_abspath + '/' + f
919
f_ie = inv.get_child(from_dir_id, f)
922
elif self.is_ignored(fp[1:]):
925
# we may not have found this file, because of a unicode issue
926
f_norm, can_access = osutils.normalized_filename(f)
927
if f == f_norm or not can_access:
928
# No change, so treat this file normally
931
# this file can be accessed by a normalized path
932
# check again if it is versioned
933
# these lines are repeated here for performance
935
fp = from_dir_relpath + '/' + f
936
fap = from_dir_abspath + '/' + f
937
f_ie = inv.get_child(from_dir_id, f)
940
elif self.is_ignored(fp[1:]):
949
raise errors.BzrCheckError(
950
"file %r entered as kind %r id %r, now of kind %r"
951
% (fap, f_ie.kind, f_ie.file_id, fk))
953
# make a last minute entry
955
yield fp[1:], c, fk, f_ie.file_id, f_ie
958
yield fp[1:], c, fk, None, fk_entries[fk]()
960
yield fp[1:], c, fk, None, TreeEntry()
963
if fk != 'directory':
966
# But do this child first
967
new_children = os.listdir(fap)
969
new_children = collections.deque(new_children)
970
stack.append((f_ie.file_id, fp, fap, new_children))
971
# Break out of inner loop,
972
# so that we start outer loop with child
975
# if we finished all children, pop it off the stack
978
@needs_tree_write_lock
979
def move(self, from_paths, to_dir=None, after=False, **kwargs):
982
to_dir must exist in the inventory.
984
If to_dir exists and is a directory, the files are moved into
985
it, keeping their old names.
987
Note that to_dir is only the last component of the new name;
988
this doesn't change the directory.
990
For each entry in from_paths the move mode will be determined
993
The first mode moves the file in the filesystem and updates the
994
inventory. The second mode only updates the inventory without
995
touching the file on the filesystem. This is the new mode introduced
998
move uses the second mode if 'after == True' and the target is not
999
versioned but present in the working tree.
1001
move uses the second mode if 'after == False' and the source is
1002
versioned but no longer in the working tree, and the target is not
1003
versioned but present in the working tree.
1005
move uses the first mode if 'after == False' and the source is
1006
versioned and present in the working tree, and the target is not
1007
versioned and not present in the working tree.
1009
Everything else results in an error.
1011
This returns a list of (from_path, to_path) pairs for each
1012
entry that is moved.
1017
# check for deprecated use of signature
1019
to_dir = kwargs.get('to_name', None)
1021
raise TypeError('You must supply a target directory')
1023
symbol_versioning.warn('The parameter to_name was deprecated'
1024
' in version 0.13. Use to_dir instead',
1027
# check destination directory
1028
assert not isinstance(from_paths, basestring)
1029
inv = self.inventory
1030
to_abs = self.abspath(to_dir)
1031
if not isdir(to_abs):
1032
raise errors.BzrMoveFailedError('',to_dir,
1033
errors.NotADirectory(to_abs))
1034
if not self.has_filename(to_dir):
1035
raise errors.BzrMoveFailedError('',to_dir,
1036
errors.NotInWorkingDirectory(to_dir))
1037
to_dir_id = inv.path2id(to_dir)
1038
if to_dir_id is None:
1039
raise errors.BzrMoveFailedError('',to_dir,
1040
errors.NotVersionedError(path=str(to_dir)))
1042
to_dir_ie = inv[to_dir_id]
1043
if to_dir_ie.kind != 'directory':
1044
raise errors.BzrMoveFailedError('',to_dir,
1045
errors.NotADirectory(to_abs))
1047
# create rename entries and tuples
1048
for from_rel in from_paths:
1049
from_tail = splitpath(from_rel)[-1]
1050
from_id = inv.path2id(from_rel)
1052
raise errors.BzrMoveFailedError(from_rel,to_dir,
1053
errors.NotVersionedError(path=str(from_rel)))
1055
from_entry = inv[from_id]
1056
from_parent_id = from_entry.parent_id
1057
to_rel = pathjoin(to_dir, from_tail)
1058
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1060
from_tail=from_tail,
1061
from_parent_id=from_parent_id,
1062
to_rel=to_rel, to_tail=from_tail,
1063
to_parent_id=to_dir_id)
1064
rename_entries.append(rename_entry)
1065
rename_tuples.append((from_rel, to_rel))
1067
# determine which move mode to use. checks also for movability
1068
rename_entries = self._determine_mv_mode(rename_entries, after)
1070
original_modified = self._inventory_is_modified
1073
self._inventory_is_modified = True
1074
self._move(rename_entries)
1076
# restore the inventory on error
1077
self._inventory_is_modified = original_modified
1079
self._write_inventory(inv)
1080
return rename_tuples
1082
def _determine_mv_mode(self, rename_entries, after=False):
1083
"""Determines for each from-to pair if both inventory and working tree
1084
or only the inventory has to be changed.
1086
Also does basic plausability tests.
1088
inv = self.inventory
1090
for rename_entry in rename_entries:
1091
# store to local variables for easier reference
1092
from_rel = rename_entry.from_rel
1093
from_id = rename_entry.from_id
1094
to_rel = rename_entry.to_rel
1095
to_id = inv.path2id(to_rel)
1096
only_change_inv = False
1098
# check the inventory for source and destination
1100
raise errors.BzrMoveFailedError(from_rel,to_rel,
1101
errors.NotVersionedError(path=str(from_rel)))
1102
if to_id is not None:
1103
raise errors.BzrMoveFailedError(from_rel,to_rel,
1104
errors.AlreadyVersionedError(path=str(to_rel)))
1106
# try to determine the mode for rename (only change inv or change
1107
# inv and file system)
1109
if not self.has_filename(to_rel):
1110
raise errors.BzrMoveFailedError(from_id,to_rel,
1111
errors.NoSuchFile(path=str(to_rel),
1112
extra="New file has not been created yet"))
1113
only_change_inv = True
1114
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1115
only_change_inv = True
1116
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1117
only_change_inv = False
1119
# something is wrong, so lets determine what exactly
1120
if not self.has_filename(from_rel) and \
1121
not self.has_filename(to_rel):
1122
raise errors.BzrRenameFailedError(from_rel,to_rel,
1123
errors.PathsDoNotExist(paths=(str(from_rel),
1126
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1127
extra="(Use --after to update the Bazaar id)")
1128
rename_entry.only_change_inv = only_change_inv
1129
return rename_entries
1131
def _move(self, rename_entries):
1132
"""Moves a list of files.
1134
Depending on the value of the flag 'only_change_inv', the
1135
file will be moved on the file system or not.
1137
inv = self.inventory
1140
for entry in rename_entries:
1142
self._move_entry(entry)
1144
self._rollback_move(moved)
1148
def _rollback_move(self, moved):
1149
"""Try to rollback a previous move in case of an filesystem error."""
1150
inv = self.inventory
1153
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1154
entry.to_tail, entry.to_parent_id, entry.from_rel,
1155
entry.from_tail, entry.from_parent_id,
1156
entry.only_change_inv))
1157
except errors.BzrMoveFailedError, e:
1158
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1159
" The working tree is in an inconsistent state."
1160
" Please consider doing a 'bzr revert'."
1161
" Error message is: %s" % e)
1163
def _move_entry(self, entry):
1164
inv = self.inventory
1165
from_rel_abs = self.abspath(entry.from_rel)
1166
to_rel_abs = self.abspath(entry.to_rel)
1167
if from_rel_abs == to_rel_abs:
1168
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1169
"Source and target are identical.")
1171
if not entry.only_change_inv:
1173
osutils.rename(from_rel_abs, to_rel_abs)
1175
raise errors.BzrMoveFailedError(entry.from_rel,
1177
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1179
@needs_tree_write_lock
1180
def rename_one(self, from_rel, to_rel, after=False):
1183
This can change the directory or the filename or both.
1185
rename_one has several 'modes' to work. First, it can rename a physical
1186
file and change the file_id. That is the normal mode. Second, it can
1187
only change the file_id without touching any physical file. This is
1188
the new mode introduced in version 0.15.
1190
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1191
versioned but present in the working tree.
1193
rename_one uses the second mode if 'after == False' and 'from_rel' is
1194
versioned but no longer in the working tree, and 'to_rel' is not
1195
versioned but present in the working tree.
1197
rename_one uses the first mode if 'after == False' and 'from_rel' is
1198
versioned and present in the working tree, and 'to_rel' is not
1199
versioned and not present in the working tree.
1201
Everything else results in an error.
1203
inv = self.inventory
1206
# create rename entries and tuples
1207
from_tail = splitpath(from_rel)[-1]
1208
from_id = inv.path2id(from_rel)
1210
raise errors.BzrRenameFailedError(from_rel,to_rel,
1211
errors.NotVersionedError(path=str(from_rel)))
1212
from_entry = inv[from_id]
1213
from_parent_id = from_entry.parent_id
1214
to_dir, to_tail = os.path.split(to_rel)
1215
to_dir_id = inv.path2id(to_dir)
1216
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1218
from_tail=from_tail,
1219
from_parent_id=from_parent_id,
1220
to_rel=to_rel, to_tail=to_tail,
1221
to_parent_id=to_dir_id)
1222
rename_entries.append(rename_entry)
1224
# determine which move mode to use. checks also for movability
1225
rename_entries = self._determine_mv_mode(rename_entries, after)
1227
# check if the target changed directory and if the target directory is
1229
if to_dir_id is None:
1230
raise errors.BzrMoveFailedError(from_rel,to_rel,
1231
errors.NotVersionedError(path=str(to_dir)))
1233
# all checks done. now we can continue with our actual work
1234
mutter('rename_one:\n'
1239
' to_dir_id {%s}\n',
1240
from_id, from_rel, to_rel, to_dir, to_dir_id)
1242
self._move(rename_entries)
1243
self._write_inventory(inv)
1245
class _RenameEntry(object):
1246
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1247
to_rel, to_tail, to_parent_id, only_change_inv=False):
1248
self.from_rel = from_rel
1249
self.from_id = from_id
1250
self.from_tail = from_tail
1251
self.from_parent_id = from_parent_id
1252
self.to_rel = to_rel
1253
self.to_tail = to_tail
1254
self.to_parent_id = to_parent_id
1255
self.only_change_inv = only_change_inv
1259
"""Return all unknown files.
1261
These are files in the working directory that are not versioned or
1262
control files or ignored.
1264
for subp in self.extras():
1265
if not self.is_ignored(subp):
1268
@needs_tree_write_lock
1269
def unversion(self, file_ids):
1270
"""Remove the file ids in file_ids from the current versioned set.
1272
When a file_id is unversioned, all of its children are automatically
1275
:param file_ids: The file ids to stop versioning.
1276
:raises: NoSuchId if any fileid is not currently versioned.
1278
for file_id in file_ids:
1279
if self._inventory.has_id(file_id):
1280
self._inventory.remove_recursive_id(file_id)
1282
raise errors.NoSuchId(self, file_id)
1284
# in the future this should just set a dirty bit to wait for the
1285
# final unlock. However, until all methods of workingtree start
1286
# with the current in -memory inventory rather than triggering
1287
# a read, it is more complex - we need to teach read_inventory
1288
# to know when to read, and when to not read first... and possibly
1289
# to save first when the in memory one may be corrupted.
1290
# so for now, we just only write it if it is indeed dirty.
1292
self._write_inventory(self._inventory)
1294
@deprecated_method(zero_eight)
1295
def iter_conflicts(self):
1296
"""List all files in the tree that have text or content conflicts.
1297
DEPRECATED. Use conflicts instead."""
1298
return self._iter_conflicts()
1300
def _iter_conflicts(self):
1302
for info in self.list_files():
1304
stem = get_conflicted_stem(path)
1307
if stem not in conflicted:
1308
conflicted.add(stem)
1312
def pull(self, source, overwrite=False, stop_revision=None):
1313
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1316
pp = ProgressPhase("Pull phase", 2, top_pb)
1318
old_revision_history = self.branch.revision_history()
1319
basis_tree = self.basis_tree()
1320
count = self.branch.pull(source, overwrite, stop_revision)
1321
new_revision_history = self.branch.revision_history()
1322
if new_revision_history != old_revision_history:
1324
if len(old_revision_history):
1325
other_revision = old_revision_history[-1]
1327
other_revision = None
1328
repository = self.branch.repository
1329
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1331
new_basis_tree = self.branch.basis_tree()
1338
if (basis_tree.inventory.root is None and
1339
new_basis_tree.inventory.root is not None):
1340
self.set_root_id(new_basis_tree.inventory.root.file_id)
1343
# TODO - dedup parents list with things merged by pull ?
1344
# reuse the revisiontree we merged against to set the new
1346
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1347
# we have to pull the merge trees out again, because
1348
# merge_inner has set the ids. - this corner is not yet
1349
# layered well enough to prevent double handling.
1350
merges = self.get_parent_ids()[1:]
1351
parent_trees.extend([
1352
(parent, repository.revision_tree(parent)) for
1354
self.set_parent_trees(parent_trees)
1361
def put_file_bytes_non_atomic(self, file_id, bytes):
1362
"""See MutableTree.put_file_bytes_non_atomic."""
1363
stream = file(self.id2abspath(file_id), 'wb')
1368
# TODO: update the hashcache here ?
1371
"""Yield all unknown files in this WorkingTree.
1373
If there are any unknown directories then only the directory is
1374
returned, not all its children. But if there are unknown files
1375
under a versioned subdirectory, they are returned.
1377
Currently returned depth-first, sorted by name within directories.
1379
## TODO: Work from given directory downwards
1380
for path, dir_entry in self.inventory.directories():
1381
# mutter("search for unknowns in %r", path)
1382
dirabs = self.abspath(path)
1383
if not isdir(dirabs):
1384
# e.g. directory deleted
1388
for subf in os.listdir(dirabs):
1391
if subf not in dir_entry.children:
1392
subf_norm, can_access = osutils.normalized_filename(subf)
1393
if subf_norm != subf and can_access:
1394
if subf_norm not in dir_entry.children:
1395
fl.append(subf_norm)
1401
subp = pathjoin(path, subf)
1405
def ignored_files(self):
1406
"""Yield list of PATH, IGNORE_PATTERN"""
1407
for subp in self.extras():
1408
pat = self.is_ignored(subp)
1412
def get_ignore_list(self):
1413
"""Return list of ignore patterns.
1415
Cached in the Tree object after the first call.
1417
ignoreset = getattr(self, '_ignoreset', None)
1418
if ignoreset is not None:
1421
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1422
ignore_globs.update(ignores.get_runtime_ignores())
1423
ignore_globs.update(ignores.get_user_ignores())
1424
if self.has_filename(bzrlib.IGNORE_FILENAME):
1425
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1427
ignore_globs.update(ignores.parse_ignore_file(f))
1430
self._ignoreset = ignore_globs
1433
def _flush_ignore_list_cache(self):
1434
"""Resets the cached ignore list to force a cache rebuild."""
1435
self._ignoreset = None
1436
self._ignoreglobster = None
1438
def is_ignored(self, filename):
1439
r"""Check whether the filename matches an ignore pattern.
1441
Patterns containing '/' or '\' need to match the whole path;
1442
others match against only the last component.
1444
If the file is ignored, returns the pattern which caused it to
1445
be ignored, otherwise None. So this can simply be used as a
1446
boolean if desired."""
1447
if getattr(self, '_ignoreglobster', None) is None:
1448
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1449
return self._ignoreglobster.match(filename)
1451
def kind(self, file_id):
1452
return file_kind(self.id2abspath(file_id))
1454
def _comparison_data(self, entry, path):
1455
abspath = self.abspath(path)
1457
stat_value = os.lstat(abspath)
1459
if getattr(e, 'errno', None) == errno.ENOENT:
1466
mode = stat_value.st_mode
1467
kind = osutils.file_kind_from_stat_mode(mode)
1468
if not supports_executable():
1469
executable = entry.executable
1471
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1472
return kind, executable, stat_value
1474
def _file_size(self, entry, stat_value):
1475
return stat_value.st_size
1477
def last_revision(self):
1478
"""Return the last revision of the branch for this tree.
1480
This format tree does not support a separate marker for last-revision
1481
compared to the branch.
1483
See MutableTree.last_revision
1485
return self._last_revision()
1488
def _last_revision(self):
1489
"""helper for get_parent_ids."""
1490
return self.branch.last_revision()
1492
def is_locked(self):
1493
return self._control_files.is_locked()
1495
def lock_read(self):
1496
"""See Branch.lock_read, and WorkingTree.unlock."""
1497
self.branch.lock_read()
1499
return self._control_files.lock_read()
1501
self.branch.unlock()
1504
def lock_tree_write(self):
1505
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1506
self.branch.lock_read()
1508
return self._control_files.lock_write()
1510
self.branch.unlock()
1513
def lock_write(self):
1514
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1515
self.branch.lock_write()
1517
return self._control_files.lock_write()
1519
self.branch.unlock()
1522
def get_physical_lock_status(self):
1523
return self._control_files.get_physical_lock_status()
1525
def _basis_inventory_name(self):
1526
return 'basis-inventory-cache'
1528
@needs_tree_write_lock
1529
def set_last_revision(self, new_revision):
1530
"""Change the last revision in the working tree."""
1531
if self._change_last_revision(new_revision):
1532
self._cache_basis_inventory(new_revision)
1534
def _change_last_revision(self, new_revision):
1535
"""Template method part of set_last_revision to perform the change.
1537
This is used to allow WorkingTree3 instances to not affect branch
1538
when their last revision is set.
1540
if new_revision is None:
1541
self.branch.set_revision_history([])
1544
self.branch.generate_revision_history(new_revision)
1545
except errors.NoSuchRevision:
1546
# not present in the repo - dont try to set it deeper than the tip
1547
self.branch.set_revision_history([new_revision])
1550
def _write_basis_inventory(self, xml):
1551
"""Write the basis inventory XML to the basis-inventory file"""
1552
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1553
path = self._basis_inventory_name()
1555
self._control_files.put(path, sio)
1557
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1558
"""Create the text that will be saved in basis-inventory"""
1559
inventory.revision_id = revision_id
1560
return xml6.serializer_v6.write_inventory_to_string(inventory)
1562
def _cache_basis_inventory(self, new_revision):
1563
"""Cache new_revision as the basis inventory."""
1564
# TODO: this should allow the ready-to-use inventory to be passed in,
1565
# as commit already has that ready-to-use [while the format is the
1568
# this double handles the inventory - unpack and repack -
1569
# but is easier to understand. We can/should put a conditional
1570
# in here based on whether the inventory is in the latest format
1571
# - perhaps we should repack all inventories on a repository
1573
# the fast path is to copy the raw xml from the repository. If the
1574
# xml contains 'revision_id="', then we assume the right
1575
# revision_id is set. We must check for this full string, because a
1576
# root node id can legitimately look like 'revision_id' but cannot
1578
xml = self.branch.repository.get_inventory_xml(new_revision)
1579
firstline = xml.split('\n', 1)[0]
1580
if (not 'revision_id="' in firstline or
1581
'format="6"' not in firstline):
1582
inv = self.branch.repository.deserialise_inventory(
1584
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1585
self._write_basis_inventory(xml)
1586
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1589
def read_basis_inventory(self):
1590
"""Read the cached basis inventory."""
1591
path = self._basis_inventory_name()
1592
return self._control_files.get(path).read()
1595
def read_working_inventory(self):
1596
"""Read the working inventory.
1598
:raises errors.InventoryModified: read_working_inventory will fail
1599
when the current in memory inventory has been modified.
1601
# conceptually this should be an implementation detail of the tree.
1602
# XXX: Deprecate this.
1603
# ElementTree does its own conversion from UTF-8, so open in
1605
if self._inventory_is_modified:
1606
raise errors.InventoryModified(self)
1607
result = xml5.serializer_v5.read_inventory(
1608
self._control_files.get('inventory'))
1609
self._set_inventory(result, dirty=False)
1612
@needs_tree_write_lock
1613
def remove(self, files, verbose=False, to_file=None):
1614
"""Remove nominated files from the working inventory..
1616
This does not remove their text. This does not run on XXX on what? RBC
1618
TODO: Refuse to remove modified files unless --force is given?
1620
TODO: Do something useful with directories.
1622
TODO: Should this remove the text or not? Tough call; not
1623
removing may be useful and the user can just use use rm, and
1624
is the opposite of add. Removing it is consistent with most
1625
other tools. Maybe an option.
1627
## TODO: Normalize names
1628
## TODO: Remove nested loops; better scalability
1629
if isinstance(files, basestring):
1632
inv = self.inventory
1634
# do this before any modifications
1636
fid = inv.path2id(f)
1638
# TODO: Perhaps make this just a warning, and continue?
1639
# This tends to happen when
1640
raise errors.NotVersionedError(path=f)
1642
# having remove it, it must be either ignored or unknown
1643
if self.is_ignored(f):
1647
textui.show_status(new_status, inv[fid].kind, f,
1651
self._write_inventory(inv)
1653
@needs_tree_write_lock
1654
def revert(self, filenames, old_tree=None, backups=True,
1655
pb=DummyProgress(), report_changes=False):
1656
from bzrlib.conflicts import resolve
1657
if old_tree is None:
1658
old_tree = self.basis_tree()
1659
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1661
if not len(filenames):
1662
self.set_parent_ids(self.get_parent_ids()[:1])
1665
resolve(self, filenames, ignore_misses=True)
1668
def revision_tree(self, revision_id):
1669
"""See Tree.revision_tree.
1671
WorkingTree can supply revision_trees for the basis revision only
1672
because there is only one cached inventory in the bzr directory.
1674
if revision_id == self.last_revision():
1676
xml = self.read_basis_inventory()
1681
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1682
# dont use the repository revision_tree api because we want
1683
# to supply the inventory.
1684
if inv.revision_id == revision_id:
1685
return revisiontree.RevisionTree(self.branch.repository,
1687
except errors.BadInventoryFormat:
1689
# raise if there was no inventory, or if we read the wrong inventory.
1690
raise errors.NoSuchRevisionInTree(self, revision_id)
1692
# XXX: This method should be deprecated in favour of taking in a proper
1693
# new Inventory object.
1694
@needs_tree_write_lock
1695
def set_inventory(self, new_inventory_list):
1696
from bzrlib.inventory import (Inventory,
1701
inv = Inventory(self.get_root_id())
1702
for path, file_id, parent, kind in new_inventory_list:
1703
name = os.path.basename(path)
1706
# fixme, there should be a factory function inv,add_??
1707
if kind == 'directory':
1708
inv.add(InventoryDirectory(file_id, name, parent))
1709
elif kind == 'file':
1710
inv.add(InventoryFile(file_id, name, parent))
1711
elif kind == 'symlink':
1712
inv.add(InventoryLink(file_id, name, parent))
1714
raise errors.BzrError("unknown kind %r" % kind)
1715
self._write_inventory(inv)
1717
@needs_tree_write_lock
1718
def set_root_id(self, file_id):
1719
"""Set the root id for this tree."""
1722
symbol_versioning.warn(symbol_versioning.zero_twelve
1723
% 'WorkingTree.set_root_id with fileid=None',
1727
inv = self._inventory
1728
orig_root_id = inv.root.file_id
1729
# TODO: it might be nice to exit early if there was nothing
1730
# to do, saving us from trigger a sync on unlock.
1731
self._inventory_is_modified = True
1732
# we preserve the root inventory entry object, but
1733
# unlinkit from the byid index
1734
del inv._byid[inv.root.file_id]
1735
inv.root.file_id = file_id
1736
# and link it into the index with the new changed id.
1737
inv._byid[inv.root.file_id] = inv.root
1738
# and finally update all children to reference the new id.
1739
# XXX: this should be safe to just look at the root.children
1740
# list, not the WHOLE INVENTORY.
1743
if entry.parent_id == orig_root_id:
1744
entry.parent_id = inv.root.file_id
1747
"""See Branch.unlock.
1749
WorkingTree locking just uses the Branch locking facilities.
1750
This is current because all working trees have an embedded branch
1751
within them. IF in the future, we were to make branch data shareable
1752
between multiple working trees, i.e. via shared storage, then we
1753
would probably want to lock both the local tree, and the branch.
1755
raise NotImplementedError(self.unlock)
1758
"""Update a working tree along its branch.
1760
This will update the branch if its bound too, which means we have
1761
multiple trees involved:
1763
- The new basis tree of the master.
1764
- The old basis tree of the branch.
1765
- The old basis tree of the working tree.
1766
- The current working tree state.
1768
Pathologically, all three may be different, and non-ancestors of each
1769
other. Conceptually we want to:
1771
- Preserve the wt.basis->wt.state changes
1772
- Transform the wt.basis to the new master basis.
1773
- Apply a merge of the old branch basis to get any 'local' changes from
1775
- Restore the wt.basis->wt.state changes.
1777
There isn't a single operation at the moment to do that, so we:
1778
- Merge current state -> basis tree of the master w.r.t. the old tree
1780
- Do a 'normal' merge of the old branch basis if it is relevant.
1782
if self.branch.get_master_branch() is not None:
1784
update_branch = True
1786
self.lock_tree_write()
1787
update_branch = False
1790
old_tip = self.branch.update()
1793
return self._update_tree(old_tip)
1797
@needs_tree_write_lock
1798
def _update_tree(self, old_tip=None):
1799
"""Update a tree to the master branch.
1801
:param old_tip: if supplied, the previous tip revision the branch,
1802
before it was changed to the master branch's tip.
1804
# here if old_tip is not None, it is the old tip of the branch before
1805
# it was updated from the master branch. This should become a pending
1806
# merge in the working tree to preserve the user existing work. we
1807
# cant set that until we update the working trees last revision to be
1808
# one from the new branch, because it will just get absorbed by the
1809
# parent de-duplication logic.
1811
# We MUST save it even if an error occurs, because otherwise the users
1812
# local work is unreferenced and will appear to have been lost.
1816
last_rev = self.get_parent_ids()[0]
1819
if last_rev != self.branch.last_revision():
1820
# merge tree state up to new branch tip.
1821
basis = self.basis_tree()
1822
to_tree = self.branch.basis_tree()
1823
if basis.inventory.root is None:
1824
self.set_root_id(to_tree.inventory.root.file_id)
1825
result += merge.merge_inner(
1830
# TODO - dedup parents list with things merged by pull ?
1831
# reuse the tree we've updated to to set the basis:
1832
parent_trees = [(self.branch.last_revision(), to_tree)]
1833
merges = self.get_parent_ids()[1:]
1834
# Ideally we ask the tree for the trees here, that way the working
1835
# tree can decide whether to give us teh entire tree or give us a
1836
# lazy initialised tree. dirstate for instance will have the trees
1837
# in ram already, whereas a last-revision + basis-inventory tree
1838
# will not, but also does not need them when setting parents.
1839
for parent in merges:
1840
parent_trees.append(
1841
(parent, self.branch.repository.revision_tree(parent)))
1842
if old_tip is not None:
1843
parent_trees.append(
1844
(old_tip, self.branch.repository.revision_tree(old_tip)))
1845
self.set_parent_trees(parent_trees)
1846
last_rev = parent_trees[0][0]
1848
# the working tree had the same last-revision as the master
1849
# branch did. We may still have pivot local work from the local
1850
# branch into old_tip:
1851
if old_tip is not None:
1852
self.add_parent_tree_id(old_tip)
1853
if old_tip and old_tip != last_rev:
1854
# our last revision was not the prior branch last revision
1855
# and we have converted that last revision to a pending merge.
1856
# base is somewhere between the branch tip now
1857
# and the now pending merge
1858
from bzrlib.revision import common_ancestor
1860
base_rev_id = common_ancestor(self.branch.last_revision(),
1862
self.branch.repository)
1863
except errors.NoCommonAncestor:
1865
base_tree = self.branch.repository.revision_tree(base_rev_id)
1866
other_tree = self.branch.repository.revision_tree(old_tip)
1867
result += merge.merge_inner(
1874
def _write_hashcache_if_dirty(self):
1875
"""Write out the hashcache if it is dirty."""
1876
if self._hashcache.needs_write:
1878
self._hashcache.write()
1880
if e.errno not in (errno.EPERM, errno.EACCES):
1882
# TODO: jam 20061219 Should this be a warning? A single line
1883
# warning might be sufficient to let the user know what
1885
mutter('Could not write hashcache for %s\nError: %s',
1886
self._hashcache.cache_file_name(), e)
1888
@needs_tree_write_lock
1889
def _write_inventory(self, inv):
1890
"""Write inventory as the current inventory."""
1891
self._set_inventory(inv, dirty=True)
1894
def set_conflicts(self, arg):
1895
raise errors.UnsupportedOperation(self.set_conflicts, self)
1897
def add_conflicts(self, arg):
1898
raise errors.UnsupportedOperation(self.add_conflicts, self)
1901
def conflicts(self):
1902
conflicts = _mod_conflicts.ConflictList()
1903
for conflicted in self._iter_conflicts():
1906
if file_kind(self.abspath(conflicted)) != "file":
1908
except errors.NoSuchFile:
1911
for suffix in ('.THIS', '.OTHER'):
1913
kind = file_kind(self.abspath(conflicted+suffix))
1916
except errors.NoSuchFile:
1920
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1921
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1923
file_id=self.path2id(conflicted)))
1927
class WorkingTree2(WorkingTree):
1928
"""This is the Format 2 working tree.
1930
This was the first weave based working tree.
1931
- uses os locks for locking.
1932
- uses the branch last-revision.
1935
def lock_tree_write(self):
1936
"""See WorkingTree.lock_tree_write().
1938
In Format2 WorkingTrees we have a single lock for the branch and tree
1939
so lock_tree_write() degrades to lock_write().
1941
self.branch.lock_write()
1943
return self._control_files.lock_write()
1945
self.branch.unlock()
1949
# we share control files:
1950
if self._control_files._lock_count == 3:
1951
# _inventory_is_modified is always False during a read lock.
1952
if self._inventory_is_modified:
1954
self._write_hashcache_if_dirty()
1956
# reverse order of locking.
1958
return self._control_files.unlock()
1960
self.branch.unlock()
1963
class WorkingTree3(WorkingTree):
1964
"""This is the Format 3 working tree.
1966
This differs from the base WorkingTree by:
1967
- having its own file lock
1968
- having its own last-revision property.
1970
This is new in bzr 0.8
1974
def _last_revision(self):
1975
"""See Mutable.last_revision."""
1977
return self._control_files.get_utf8('last-revision').read()
1978
except errors.NoSuchFile:
1981
def _change_last_revision(self, revision_id):
1982
"""See WorkingTree._change_last_revision."""
1983
if revision_id is None or revision_id == NULL_REVISION:
1985
self._control_files._transport.delete('last-revision')
1986
except errors.NoSuchFile:
1990
self._control_files.put_utf8('last-revision', revision_id)
1993
@needs_tree_write_lock
1994
def set_conflicts(self, conflicts):
1995
self._put_rio('conflicts', conflicts.to_stanzas(),
1998
@needs_tree_write_lock
1999
def add_conflicts(self, new_conflicts):
2000
conflict_set = set(self.conflicts())
2001
conflict_set.update(set(list(new_conflicts)))
2002
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2003
key=_mod_conflicts.Conflict.sort_key)))
2006
def conflicts(self):
2008
confile = self._control_files.get('conflicts')
2009
except errors.NoSuchFile:
2010
return _mod_conflicts.ConflictList()
2012
if confile.next() != CONFLICT_HEADER_1 + '\n':
2013
raise errors.ConflictFormatError()
2014
except StopIteration:
2015
raise errors.ConflictFormatError()
2016
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2019
if self._control_files._lock_count == 1:
2020
# _inventory_is_modified is always False during a read lock.
2021
if self._inventory_is_modified:
2023
self._write_hashcache_if_dirty()
2024
# reverse order of locking.
2026
return self._control_files.unlock()
2028
self.branch.unlock()
2031
def get_conflicted_stem(path):
2032
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2033
if path.endswith(suffix):
2034
return path[:-len(suffix)]
2036
@deprecated_function(zero_eight)
2037
def is_control_file(filename):
2038
"""See WorkingTree.is_control_filename(filename)."""
2039
## FIXME: better check
2040
filename = normpath(filename)
2041
while filename != '':
2042
head, tail = os.path.split(filename)
2043
## mutter('check %r for control file' % ((head, tail),))
2046
if filename == head:
2052
class WorkingTreeFormat(object):
2053
"""An encapsulation of the initialization and open routines for a format.
2055
Formats provide three things:
2056
* An initialization routine,
2060
Formats are placed in an dict by their format string for reference
2061
during workingtree opening. Its not required that these be instances, they
2062
can be classes themselves with class methods - it simply depends on
2063
whether state is needed for a given format or not.
2065
Once a format is deprecated, just deprecate the initialize and open
2066
methods on the format class. Do not deprecate the object, as the
2067
object will be created every time regardless.
2070
_default_format = None
2071
"""The default format used for new trees."""
2074
"""The known formats."""
2077
def find_format(klass, a_bzrdir):
2078
"""Return the format for the working tree object in a_bzrdir."""
2080
transport = a_bzrdir.get_workingtree_transport(None)
2081
format_string = transport.get("format").read()
2082
return klass._formats[format_string]
2083
except errors.NoSuchFile:
2084
raise errors.NoWorkingTree(base=transport.base)
2086
raise errors.UnknownFormatError(format=format_string)
2089
def get_default_format(klass):
2090
"""Return the current default format."""
2091
return klass._default_format
2093
def get_format_string(self):
2094
"""Return the ASCII format string that identifies this format."""
2095
raise NotImplementedError(self.get_format_string)
2097
def get_format_description(self):
2098
"""Return the short description for this format."""
2099
raise NotImplementedError(self.get_format_description)
2101
def is_supported(self):
2102
"""Is this format supported?
2104
Supported formats can be initialized and opened.
2105
Unsupported formats may not support initialization or committing or
2106
some other features depending on the reason for not being supported.
2111
def register_format(klass, format):
2112
klass._formats[format.get_format_string()] = format
2115
def set_default_format(klass, format):
2116
klass._default_format = format
2119
def unregister_format(klass, format):
2120
assert klass._formats[format.get_format_string()] is format
2121
del klass._formats[format.get_format_string()]
2125
class WorkingTreeFormat2(WorkingTreeFormat):
2126
"""The second working tree format.
2128
This format modified the hash cache from the format 1 hash cache.
2131
def get_format_description(self):
2132
"""See WorkingTreeFormat.get_format_description()."""
2133
return "Working tree format 2"
2135
def stub_initialize_remote(self, control_files):
2136
"""As a special workaround create critical control files for a remote working tree
2138
This ensures that it can later be updated and dealt with locally,
2139
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2140
no working tree. (See bug #43064).
2144
xml5.serializer_v5.write_inventory(inv, sio)
2146
control_files.put('inventory', sio)
2148
control_files.put_utf8('pending-merges', '')
2151
def initialize(self, a_bzrdir, revision_id=None):
2152
"""See WorkingTreeFormat.initialize()."""
2153
if not isinstance(a_bzrdir.transport, LocalTransport):
2154
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2155
branch = a_bzrdir.open_branch()
2156
if revision_id is not None:
2159
revision_history = branch.revision_history()
2161
position = revision_history.index(revision_id)
2163
raise errors.NoSuchRevision(branch, revision_id)
2164
branch.set_revision_history(revision_history[:position + 1])
2167
revision = branch.last_revision()
2169
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2175
basis_tree = branch.repository.revision_tree(revision)
2176
if basis_tree.inventory.root is not None:
2177
wt.set_root_id(basis_tree.inventory.root.file_id)
2178
# set the parent list and cache the basis tree.
2179
wt.set_parent_trees([(revision, basis_tree)])
2180
transform.build_tree(basis_tree, wt)
2184
super(WorkingTreeFormat2, self).__init__()
2185
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2187
def open(self, a_bzrdir, _found=False):
2188
"""Return the WorkingTree object for a_bzrdir
2190
_found is a private parameter, do not use it. It is used to indicate
2191
if format probing has already been done.
2194
# we are being called directly and must probe.
2195
raise NotImplementedError
2196
if not isinstance(a_bzrdir.transport, LocalTransport):
2197
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2198
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2204
class WorkingTreeFormat3(WorkingTreeFormat):
2205
"""The second working tree format updated to record a format marker.
2208
- exists within a metadir controlling .bzr
2209
- includes an explicit version marker for the workingtree control
2210
files, separate from the BzrDir format
2211
- modifies the hash cache format
2213
- uses a LockDir to guard access for writes.
2216
def get_format_string(self):
2217
"""See WorkingTreeFormat.get_format_string()."""
2218
return "Bazaar-NG Working Tree format 3"
2220
def get_format_description(self):
2221
"""See WorkingTreeFormat.get_format_description()."""
2222
return "Working tree format 3"
2224
_lock_file_name = 'lock'
2225
_lock_class = LockDir
2227
def _open_control_files(self, a_bzrdir):
2228
transport = a_bzrdir.get_workingtree_transport(None)
2229
return LockableFiles(transport, self._lock_file_name,
2232
def initialize(self, a_bzrdir, revision_id=None):
2233
"""See WorkingTreeFormat.initialize().
2235
revision_id allows creating a working tree at a different
2236
revision than the branch is at.
2238
if not isinstance(a_bzrdir.transport, LocalTransport):
2239
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2240
transport = a_bzrdir.get_workingtree_transport(self)
2241
control_files = self._open_control_files(a_bzrdir)
2242
control_files.create_lock()
2243
control_files.lock_write()
2244
control_files.put_utf8('format', self.get_format_string())
2245
branch = a_bzrdir.open_branch()
2246
if revision_id is None:
2247
revision_id = branch.last_revision()
2248
# WorkingTree3 can handle an inventory which has a unique root id.
2249
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2250
# those trees. And because there isn't a format bump inbetween, we
2251
# are maintaining compatibility with older clients.
2252
# inv = Inventory(root_id=gen_root_id())
2254
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2260
_control_files=control_files)
2261
wt.lock_tree_write()
2263
basis_tree = branch.repository.revision_tree(revision_id)
2264
# only set an explicit root id if there is one to set.
2265
if basis_tree.inventory.root is not None:
2266
wt.set_root_id(basis_tree.inventory.root.file_id)
2267
if revision_id == NULL_REVISION:
2268
wt.set_parent_trees([])
2270
wt.set_parent_trees([(revision_id, basis_tree)])
2271
transform.build_tree(basis_tree, wt)
2273
# Unlock in this order so that the unlock-triggers-flush in
2274
# WorkingTree is given a chance to fire.
2275
control_files.unlock()
2280
super(WorkingTreeFormat3, self).__init__()
2281
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2283
def open(self, a_bzrdir, _found=False):
2284
"""Return the WorkingTree object for a_bzrdir
2286
_found is a private parameter, do not use it. It is used to indicate
2287
if format probing has already been done.
2290
# we are being called directly and must probe.
2291
raise NotImplementedError
2292
if not isinstance(a_bzrdir.transport, LocalTransport):
2293
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2294
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2296
def _open(self, a_bzrdir, control_files):
2297
"""Open the tree itself.
2299
:param a_bzrdir: the dir for the tree.
2300
:param control_files: the control files for the tree.
2302
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2306
_control_files=control_files)
2309
return self.get_format_string()
2312
# formats which have no format string are not discoverable
2313
# and not independently creatable, so are not registered.
2314
__default_format = WorkingTreeFormat3()
2315
WorkingTreeFormat.register_format(__default_format)
2316
WorkingTreeFormat.set_default_format(__default_format)
2317
_legacy_formats = [WorkingTreeFormat2(),
2321
class WorkingTreeTestProviderAdapter(object):
2322
"""A tool to generate a suite testing multiple workingtree formats at once.
2324
This is done by copying the test once for each transport and injecting
2325
the transport_server, transport_readonly_server, and workingtree_format
2326
classes into each copy. Each copy is also given a new id() to make it
2330
def __init__(self, transport_server, transport_readonly_server, formats):
2331
self._transport_server = transport_server
2332
self._transport_readonly_server = transport_readonly_server
2333
self._formats = formats
2335
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2336
"""Clone test for adaption."""
2337
new_test = deepcopy(test)
2338
new_test.transport_server = self._transport_server
2339
new_test.transport_readonly_server = self._transport_readonly_server
2340
new_test.bzrdir_format = bzrdir_format
2341
new_test.workingtree_format = workingtree_format
2342
def make_new_test_id():
2343
new_id = "%s(%s)" % (test.id(), variation)
2344
return lambda: new_id
2345
new_test.id = make_new_test_id()
2348
def adapt(self, test):
2349
from bzrlib.tests import TestSuite
2350
result = TestSuite()
2351
for workingtree_format, bzrdir_format in self._formats:
2352
new_test = self._clone_test(
2355
workingtree_format, workingtree_format.__class__.__name__)
2356
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
