1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
68
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
self._flush_ignore_list_cache()
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
456
file_id = osutils.safe_file_id(file_id)
457
path = self.id2path(file_id)
458
return self.get_file_byname(path)
460
def get_file_text(self, file_id):
461
file_id = osutils.safe_file_id(file_id)
462
return self.get_file(file_id).read()
464
def get_file_byname(self, filename):
465
return file(self.abspath(filename), 'rb')
468
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
469
"""See Tree.annotate_iter
471
This implementation will use the basis tree implementation if possible.
472
Lines not in the basis are attributed to CURRENT_REVISION
474
If there are pending merges, lines added by those merges will be
475
incorrectly attributed to CURRENT_REVISION (but after committing, the
476
attribution will be correct).
478
file_id = osutils.safe_file_id(file_id)
479
basis = self.basis_tree()
482
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
483
require_versioned=True).next()
484
changed_content, kind = changes[2], changes[6]
485
if not changed_content:
486
return basis.annotate_iter(file_id)
490
if kind[0] != 'file':
493
old_lines = list(basis.annotate_iter(file_id))
495
for tree in self.branch.repository.revision_trees(
496
self.get_parent_ids()[1:]):
497
if file_id not in tree:
499
old.append(list(tree.annotate_iter(file_id)))
500
return annotate.reannotate(old, self.get_file(file_id).readlines(),
505
def _get_ancestors(self, default_revision):
506
ancestors = set([default_revision])
507
for parent_id in self.get_parent_ids():
508
ancestors.update(self.branch.repository.get_ancestry(
509
parent_id, topo_sorted=False))
512
def get_parent_ids(self):
513
"""See Tree.get_parent_ids.
515
This implementation reads the pending merges list and last_revision
516
value and uses that to decide what the parents list should be.
518
last_rev = _mod_revision.ensure_null(self._last_revision())
519
if _mod_revision.NULL_REVISION == last_rev:
524
merges_file = self._control_files.get('pending-merges')
525
except errors.NoSuchFile:
528
for l in merges_file.readlines():
529
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
530
parents.append(revision_id)
534
def get_root_id(self):
535
"""Return the id of this trees root"""
536
return self._inventory.root.file_id
538
def _get_store_filename(self, file_id):
539
## XXX: badly named; this is not in the store at all
540
file_id = osutils.safe_file_id(file_id)
541
return self.abspath(self.id2path(file_id))
544
def clone(self, to_bzrdir, revision_id=None):
545
"""Duplicate this working tree into to_bzr, including all state.
547
Specifically modified files are kept as modified, but
548
ignored and unknown files are discarded.
550
If you want to make a new line of development, see bzrdir.sprout()
553
If not None, the cloned tree will have its last revision set to
554
revision, and and difference between the source trees last revision
555
and this one merged in.
557
# assumes the target bzr dir format is compatible.
558
result = self._format.initialize(to_bzrdir)
559
self.copy_content_into(result, revision_id)
563
def copy_content_into(self, tree, revision_id=None):
564
"""Copy the current content and user files of this tree into tree."""
565
tree.set_root_id(self.get_root_id())
566
if revision_id is None:
567
merge.transform_tree(tree, self)
569
# TODO now merge from tree.last_revision to revision (to preserve
570
# user local changes)
571
merge.transform_tree(tree, self)
572
tree.set_parent_ids([revision_id])
574
def id2abspath(self, file_id):
575
file_id = osutils.safe_file_id(file_id)
576
return self.abspath(self.id2path(file_id))
578
def has_id(self, file_id):
579
# files that have been deleted are excluded
580
file_id = osutils.safe_file_id(file_id)
582
if not inv.has_id(file_id):
584
path = inv.id2path(file_id)
585
return osutils.lexists(self.abspath(path))
587
def has_or_had_id(self, file_id):
588
file_id = osutils.safe_file_id(file_id)
589
if file_id == self.inventory.root.file_id:
591
return self.inventory.has_id(file_id)
593
__contains__ = has_id
595
def get_file_size(self, file_id):
596
file_id = osutils.safe_file_id(file_id)
597
return os.path.getsize(self.id2abspath(file_id))
600
def get_file_sha1(self, file_id, path=None, stat_value=None):
601
file_id = osutils.safe_file_id(file_id)
603
path = self._inventory.id2path(file_id)
604
return self._hashcache.get_sha1(path, stat_value)
606
def get_file_mtime(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
609
path = self.inventory.id2path(file_id)
610
return os.lstat(self.abspath(path)).st_mtime
612
if not supports_executable():
613
def is_executable(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
615
return self._inventory[file_id].executable
617
def is_executable(self, file_id, path=None):
619
file_id = osutils.safe_file_id(file_id)
620
path = self.id2path(file_id)
621
mode = os.lstat(self.abspath(path)).st_mode
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
@needs_tree_write_lock
625
def _add(self, files, ids, kinds):
626
"""See MutableTree._add."""
627
# TODO: Re-adding a file that is removed in the working copy
628
# should probably put it back with the previous ID.
629
# the read and write working inventory should not occur in this
630
# function - they should be part of lock_write and unlock.
632
for f, file_id, kind in zip(files, ids, kinds):
633
assert kind is not None
635
inv.add_path(f, kind=kind)
637
file_id = osutils.safe_file_id(file_id)
638
inv.add_path(f, kind=kind, file_id=file_id)
639
self._inventory_is_modified = True
641
@needs_tree_write_lock
642
def _gather_kinds(self, files, kinds):
643
"""See MutableTree._gather_kinds."""
644
for pos, f in enumerate(files):
645
if kinds[pos] is None:
646
fullpath = normpath(self.abspath(f))
648
kinds[pos] = file_kind(fullpath)
650
if e.errno == errno.ENOENT:
651
raise errors.NoSuchFile(fullpath)
654
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
655
"""Add revision_id as a parent.
657
This is equivalent to retrieving the current list of parent ids
658
and setting the list to its value plus revision_id.
660
:param revision_id: The revision id to add to the parent list. It may
661
be a ghost revision as long as its not the first parent to be added,
662
or the allow_leftmost_as_ghost parameter is set True.
663
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
parents = self.get_parent_ids() + [revision_id]
666
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
667
or allow_leftmost_as_ghost)
669
@needs_tree_write_lock
670
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
671
"""Add revision_id, tree tuple as a parent.
673
This is equivalent to retrieving the current list of parent trees
674
and setting the list to its value plus parent_tuple. See also
675
add_parent_tree_id - if you only have a parent id available it will be
676
simpler to use that api. If you have the parent already available, using
677
this api is preferred.
679
:param parent_tuple: The (revision id, tree) to add to the parent list.
680
If the revision_id is a ghost, pass None for the tree.
681
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
683
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
684
if len(parent_ids) > 1:
685
# the leftmost may have already been a ghost, preserve that if it
687
allow_leftmost_as_ghost = True
688
self.set_parent_ids(parent_ids,
689
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
691
@needs_tree_write_lock
692
def add_pending_merge(self, *revision_ids):
693
# TODO: Perhaps should check at this point that the
694
# history of the revision is actually present?
695
parents = self.get_parent_ids()
697
for rev_id in revision_ids:
698
if rev_id in parents:
700
parents.append(rev_id)
703
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
705
def path_content_summary(self, path, _lstat=osutils.lstat,
706
_mapper=osutils.file_kind_from_stat_mode):
707
"""See Tree.path_content_summary."""
708
abspath = self.abspath(path)
710
stat_result = _lstat(abspath)
712
if getattr(e, 'errno', None) == errno.ENOENT:
714
return ('missing', None, None, None)
715
# propagate other errors
717
kind = _mapper(stat_result.st_mode)
719
size = stat_result.st_size
720
# try for a stat cache lookup
721
if not supports_executable():
722
executable = None # caller can decide policy.
724
mode = stat_result.st_mode
725
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
726
return (kind, size, executable, self._sha_from_stat(
728
elif kind == 'directory':
729
# perhaps it looks like a plain directory, but it's really a
731
if self._directory_is_tree_reference(path):
732
kind = 'tree-reference'
733
return kind, None, None, None
734
elif kind == 'symlink':
735
return ('symlink', None, None, os.readlink(abspath))
737
return (kind, None, None, None)
739
@deprecated_method(zero_eleven)
741
def pending_merges(self):
742
"""Return a list of pending merges.
744
These are revisions that have been merged into the working
745
directory but not yet committed.
747
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
748
instead - which is available on all tree objects.
750
return self.get_parent_ids()[1:]
752
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
753
"""Common ghost checking functionality from set_parent_*.
755
This checks that the left hand-parent exists if there are any
758
if len(revision_ids) > 0:
759
leftmost_id = revision_ids[0]
760
if (not allow_leftmost_as_ghost and not
761
self.branch.repository.has_revision(leftmost_id)):
762
raise errors.GhostRevisionUnusableHere(leftmost_id)
764
def _set_merges_from_parent_ids(self, parent_ids):
765
merges = parent_ids[1:]
766
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
768
@needs_tree_write_lock
769
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
770
"""Set the parent ids to revision_ids.
772
See also set_parent_trees. This api will try to retrieve the tree data
773
for each element of revision_ids from the trees repository. If you have
774
tree data already available, it is more efficient to use
775
set_parent_trees rather than set_parent_ids. set_parent_ids is however
776
an easier API to use.
778
:param revision_ids: The revision_ids to set as the parent ids of this
779
working tree. Any of these may be ghosts.
781
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
782
self._check_parents_for_ghosts(revision_ids,
783
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
784
for revision_id in revision_ids:
785
_mod_revision.check_not_reserved_id(revision_id)
787
if len(revision_ids) > 0:
788
self.set_last_revision(revision_ids[0])
790
self.set_last_revision(_mod_revision.NULL_REVISION)
792
self._set_merges_from_parent_ids(revision_ids)
794
@needs_tree_write_lock
795
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
796
"""See MutableTree.set_parent_trees."""
797
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
798
for revision_id in parent_ids:
799
_mod_revision.check_not_reserved_id(revision_id)
801
self._check_parents_for_ghosts(parent_ids,
802
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
804
if len(parent_ids) == 0:
805
leftmost_parent_id = _mod_revision.NULL_REVISION
806
leftmost_parent_tree = None
808
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
810
if self._change_last_revision(leftmost_parent_id):
811
if leftmost_parent_tree is None:
812
# If we don't have a tree, fall back to reading the
813
# parent tree from the repository.
814
self._cache_basis_inventory(leftmost_parent_id)
816
inv = leftmost_parent_tree.inventory
817
xml = self._create_basis_xml_from_inventory(
818
leftmost_parent_id, inv)
819
self._write_basis_inventory(xml)
820
self._set_merges_from_parent_ids(parent_ids)
822
@needs_tree_write_lock
823
def set_pending_merges(self, rev_list):
824
parents = self.get_parent_ids()
825
leftmost = parents[:1]
826
new_parents = leftmost + rev_list
827
self.set_parent_ids(new_parents)
829
@needs_tree_write_lock
830
def set_merge_modified(self, modified_hashes):
832
for file_id, hash in modified_hashes.iteritems():
833
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
834
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
836
def _sha_from_stat(self, path, stat_result):
837
"""Get a sha digest from the tree's stat cache.
839
The default implementation assumes no stat cache is present.
841
:param path: The path.
842
:param stat_result: The stat result being looked up.
846
def _put_rio(self, filename, stanzas, header):
847
self._must_be_locked()
848
my_file = rio_file(stanzas, header)
849
self._control_files.put(filename, my_file)
851
@needs_write_lock # because merge pulls data into the branch.
852
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
854
"""Merge from a branch into this working tree.
856
:param branch: The branch to merge from.
857
:param to_revision: If non-None, the merge will merge to to_revision,
858
but not beyond it. to_revision does not need to be in the history
859
of the branch when it is supplied. If None, to_revision defaults to
860
branch.last_revision().
862
from bzrlib.merge import Merger, Merge3Merger
863
pb = bzrlib.ui.ui_factory.nested_progress_bar()
865
merger = Merger(self.branch, this_tree=self, pb=pb)
866
merger.pp = ProgressPhase("Merge phase", 5, pb)
867
merger.pp.next_phase()
868
# check that there are no
870
merger.check_basis(check_clean=True, require_commits=False)
871
if to_revision is None:
872
to_revision = _mod_revision.ensure_null(branch.last_revision())
874
to_revision = osutils.safe_revision_id(to_revision)
875
merger.other_rev_id = to_revision
876
if _mod_revision.is_null(merger.other_rev_id):
877
raise errors.NoCommits(branch)
878
self.branch.fetch(branch, last_revision=merger.other_rev_id)
879
merger.other_basis = merger.other_rev_id
880
merger.other_tree = self.branch.repository.revision_tree(
882
merger.other_branch = branch
883
merger.pp.next_phase()
884
if from_revision is None:
887
merger.set_base_revision(from_revision, branch)
888
if merger.base_rev_id == merger.other_rev_id:
889
raise errors.PointlessMerge
890
merger.backup_files = False
891
if merge_type is None:
892
merger.merge_type = Merge3Merger
894
merger.merge_type = merge_type
895
merger.set_interesting_files(None)
896
merger.show_base = False
897
merger.reprocess = False
898
conflicts = merger.do_merge()
905
def merge_modified(self):
906
"""Return a dictionary of files modified by a merge.
908
The list is initialized by WorkingTree.set_merge_modified, which is
909
typically called after we make some automatic updates to the tree
912
This returns a map of file_id->sha1, containing only files which are
913
still in the working inventory and have that text hash.
916
hashfile = self._control_files.get('merge-hashes')
917
except errors.NoSuchFile:
921
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
922
raise errors.MergeModifiedFormatError()
923
except StopIteration:
924
raise errors.MergeModifiedFormatError()
925
for s in RioReader(hashfile):
926
# RioReader reads in Unicode, so convert file_ids back to utf8
927
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
928
if file_id not in self.inventory:
930
text_hash = s.get("hash")
931
if text_hash == self.get_file_sha1(file_id):
932
merge_hashes[file_id] = text_hash
936
def mkdir(self, path, file_id=None):
937
"""See MutableTree.mkdir()."""
939
file_id = generate_ids.gen_file_id(os.path.basename(path))
940
os.mkdir(self.abspath(path))
941
self.add(path, file_id, 'directory')
944
def get_symlink_target(self, file_id):
945
file_id = osutils.safe_file_id(file_id)
946
return os.readlink(self.id2abspath(file_id))
949
def subsume(self, other_tree):
950
def add_children(inventory, entry):
951
for child_entry in entry.children.values():
952
inventory._byid[child_entry.file_id] = child_entry
953
if child_entry.kind == 'directory':
954
add_children(inventory, child_entry)
955
if other_tree.get_root_id() == self.get_root_id():
956
raise errors.BadSubsumeSource(self, other_tree,
957
'Trees have the same root')
959
other_tree_path = self.relpath(other_tree.basedir)
960
except errors.PathNotChild:
961
raise errors.BadSubsumeSource(self, other_tree,
962
'Tree is not contained by the other')
963
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
964
if new_root_parent is None:
965
raise errors.BadSubsumeSource(self, other_tree,
966
'Parent directory is not versioned.')
967
# We need to ensure that the result of a fetch will have a
968
# versionedfile for the other_tree root, and only fetching into
969
# RepositoryKnit2 guarantees that.
970
if not self.branch.repository.supports_rich_root():
971
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
972
other_tree.lock_tree_write()
974
new_parents = other_tree.get_parent_ids()
975
other_root = other_tree.inventory.root
976
other_root.parent_id = new_root_parent
977
other_root.name = osutils.basename(other_tree_path)
978
self.inventory.add(other_root)
979
add_children(self.inventory, other_root)
980
self._write_inventory(self.inventory)
981
# normally we don't want to fetch whole repositories, but i think
982
# here we really do want to consolidate the whole thing.
983
for parent_id in other_tree.get_parent_ids():
984
self.branch.fetch(other_tree.branch, parent_id)
985
self.add_parent_tree_id(parent_id)
988
other_tree.bzrdir.retire_bzrdir()
990
def _directory_is_tree_reference(self, relpath):
991
# as a special case, if a directory contains control files then
992
# it's a tree reference, except that the root of the tree is not
993
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
994
# TODO: We could ask all the control formats whether they
995
# recognize this directory, but at the moment there's no cheap api
996
# to do that. Since we probably can only nest bzr checkouts and
997
# they always use this name it's ok for now. -- mbp 20060306
999
# FIXME: There is an unhandled case here of a subdirectory
1000
# containing .bzr but not a branch; that will probably blow up
1001
# when you try to commit it. It might happen if there is a
1002
# checkout in a subdirectory. This can be avoided by not adding
1005
@needs_tree_write_lock
1006
def extract(self, file_id, format=None):
1007
"""Extract a subtree from this tree.
1009
A new branch will be created, relative to the path for this tree.
1013
segments = osutils.splitpath(path)
1014
transport = self.branch.bzrdir.root_transport
1015
for name in segments:
1016
transport = transport.clone(name)
1017
transport.ensure_base()
1020
sub_path = self.id2path(file_id)
1021
branch_transport = mkdirs(sub_path)
1023
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1024
branch_transport.ensure_base()
1025
branch_bzrdir = format.initialize_on_transport(branch_transport)
1027
repo = branch_bzrdir.find_repository()
1028
except errors.NoRepositoryPresent:
1029
repo = branch_bzrdir.create_repository()
1030
assert repo.supports_rich_root()
1032
if not repo.supports_rich_root():
1033
raise errors.RootNotRich()
1034
new_branch = branch_bzrdir.create_branch()
1035
new_branch.pull(self.branch)
1036
for parent_id in self.get_parent_ids():
1037
new_branch.fetch(self.branch, parent_id)
1038
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1039
if tree_transport.base != branch_transport.base:
1040
tree_bzrdir = format.initialize_on_transport(tree_transport)
1041
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1043
tree_bzrdir = branch_bzrdir
1044
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1045
wt.set_parent_ids(self.get_parent_ids())
1046
my_inv = self.inventory
1047
child_inv = Inventory(root_id=None)
1048
new_root = my_inv[file_id]
1049
my_inv.remove_recursive_id(file_id)
1050
new_root.parent_id = None
1051
child_inv.add(new_root)
1052
self._write_inventory(my_inv)
1053
wt._write_inventory(child_inv)
1056
def _serialize(self, inventory, out_file):
1057
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1060
def _deserialize(selt, in_file):
1061
return xml5.serializer_v5.read_inventory(in_file)
1064
"""Write the in memory inventory to disk."""
1065
# TODO: Maybe this should only write on dirty ?
1066
if self._control_files._lock_mode != 'w':
1067
raise errors.NotWriteLocked(self)
1069
self._serialize(self._inventory, sio)
1071
self._control_files.put('inventory', sio)
1072
self._inventory_is_modified = False
1074
def _kind(self, relpath):
1075
return osutils.file_kind(self.abspath(relpath))
1077
def list_files(self, include_root=False):
1078
"""Recursively list all files as (path, class, kind, id, entry).
1080
Lists, but does not descend into unversioned directories.
1082
This does not include files that have been deleted in this
1085
Skips the control directory.
1087
# list_files is an iterator, so @needs_read_lock doesn't work properly
1088
# with it. So callers should be careful to always read_lock the tree.
1089
if not self.is_locked():
1090
raise errors.ObjectNotLocked(self)
1092
inv = self.inventory
1093
if include_root is True:
1094
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1095
# Convert these into local objects to save lookup times
1096
pathjoin = osutils.pathjoin
1097
file_kind = self._kind
1099
# transport.base ends in a slash, we want the piece
1100
# between the last two slashes
1101
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1103
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1105
# directory file_id, relative path, absolute path, reverse sorted children
1106
children = os.listdir(self.basedir)
1108
# jam 20060527 The kernel sized tree seems equivalent whether we
1109
# use a deque and popleft to keep them sorted, or if we use a plain
1110
# list and just reverse() them.
1111
children = collections.deque(children)
1112
stack = [(inv.root.file_id, u'', self.basedir, children)]
1114
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1117
f = children.popleft()
1118
## TODO: If we find a subdirectory with its own .bzr
1119
## directory, then that is a separate tree and we
1120
## should exclude it.
1122
# the bzrdir for this tree
1123
if transport_base_dir == f:
1126
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1127
# and 'f' doesn't begin with one, we can do a string op, rather
1128
# than the checks of pathjoin(), all relative paths will have an extra slash
1130
fp = from_dir_relpath + '/' + f
1133
fap = from_dir_abspath + '/' + f
1135
f_ie = inv.get_child(from_dir_id, f)
1138
elif self.is_ignored(fp[1:]):
1141
# we may not have found this file, because of a unicode issue
1142
f_norm, can_access = osutils.normalized_filename(f)
1143
if f == f_norm or not can_access:
1144
# No change, so treat this file normally
1147
# this file can be accessed by a normalized path
1148
# check again if it is versioned
1149
# these lines are repeated here for performance
1151
fp = from_dir_relpath + '/' + f
1152
fap = from_dir_abspath + '/' + f
1153
f_ie = inv.get_child(from_dir_id, f)
1156
elif self.is_ignored(fp[1:]):
1163
# make a last minute entry
1165
yield fp[1:], c, fk, f_ie.file_id, f_ie
1168
yield fp[1:], c, fk, None, fk_entries[fk]()
1170
yield fp[1:], c, fk, None, TreeEntry()
1173
if fk != 'directory':
1176
# But do this child first
1177
new_children = os.listdir(fap)
1179
new_children = collections.deque(new_children)
1180
stack.append((f_ie.file_id, fp, fap, new_children))
1181
# Break out of inner loop,
1182
# so that we start outer loop with child
1185
# if we finished all children, pop it off the stack
1188
@needs_tree_write_lock
1189
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1192
to_dir must exist in the inventory.
1194
If to_dir exists and is a directory, the files are moved into
1195
it, keeping their old names.
1197
Note that to_dir is only the last component of the new name;
1198
this doesn't change the directory.
1200
For each entry in from_paths the move mode will be determined
1203
The first mode moves the file in the filesystem and updates the
1204
inventory. The second mode only updates the inventory without
1205
touching the file on the filesystem. This is the new mode introduced
1208
move uses the second mode if 'after == True' and the target is not
1209
versioned but present in the working tree.
1211
move uses the second mode if 'after == False' and the source is
1212
versioned but no longer in the working tree, and the target is not
1213
versioned but present in the working tree.
1215
move uses the first mode if 'after == False' and the source is
1216
versioned and present in the working tree, and the target is not
1217
versioned and not present in the working tree.
1219
Everything else results in an error.
1221
This returns a list of (from_path, to_path) pairs for each
1222
entry that is moved.
1227
# check for deprecated use of signature
1229
to_dir = kwargs.get('to_name', None)
1231
raise TypeError('You must supply a target directory')
1233
symbol_versioning.warn('The parameter to_name was deprecated'
1234
' in version 0.13. Use to_dir instead',
1237
# check destination directory
1238
assert not isinstance(from_paths, basestring)
1239
inv = self.inventory
1240
to_abs = self.abspath(to_dir)
1241
if not isdir(to_abs):
1242
raise errors.BzrMoveFailedError('',to_dir,
1243
errors.NotADirectory(to_abs))
1244
if not self.has_filename(to_dir):
1245
raise errors.BzrMoveFailedError('',to_dir,
1246
errors.NotInWorkingDirectory(to_dir))
1247
to_dir_id = inv.path2id(to_dir)
1248
if to_dir_id is None:
1249
raise errors.BzrMoveFailedError('',to_dir,
1250
errors.NotVersionedError(path=str(to_dir)))
1252
to_dir_ie = inv[to_dir_id]
1253
if to_dir_ie.kind != 'directory':
1254
raise errors.BzrMoveFailedError('',to_dir,
1255
errors.NotADirectory(to_abs))
1257
# create rename entries and tuples
1258
for from_rel in from_paths:
1259
from_tail = splitpath(from_rel)[-1]
1260
from_id = inv.path2id(from_rel)
1262
raise errors.BzrMoveFailedError(from_rel,to_dir,
1263
errors.NotVersionedError(path=str(from_rel)))
1265
from_entry = inv[from_id]
1266
from_parent_id = from_entry.parent_id
1267
to_rel = pathjoin(to_dir, from_tail)
1268
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1270
from_tail=from_tail,
1271
from_parent_id=from_parent_id,
1272
to_rel=to_rel, to_tail=from_tail,
1273
to_parent_id=to_dir_id)
1274
rename_entries.append(rename_entry)
1275
rename_tuples.append((from_rel, to_rel))
1277
# determine which move mode to use. checks also for movability
1278
rename_entries = self._determine_mv_mode(rename_entries, after)
1280
original_modified = self._inventory_is_modified
1283
self._inventory_is_modified = True
1284
self._move(rename_entries)
1286
# restore the inventory on error
1287
self._inventory_is_modified = original_modified
1289
self._write_inventory(inv)
1290
return rename_tuples
1292
def _determine_mv_mode(self, rename_entries, after=False):
1293
"""Determines for each from-to pair if both inventory and working tree
1294
or only the inventory has to be changed.
1296
Also does basic plausability tests.
1298
inv = self.inventory
1300
for rename_entry in rename_entries:
1301
# store to local variables for easier reference
1302
from_rel = rename_entry.from_rel
1303
from_id = rename_entry.from_id
1304
to_rel = rename_entry.to_rel
1305
to_id = inv.path2id(to_rel)
1306
only_change_inv = False
1308
# check the inventory for source and destination
1310
raise errors.BzrMoveFailedError(from_rel,to_rel,
1311
errors.NotVersionedError(path=str(from_rel)))
1312
if to_id is not None:
1313
raise errors.BzrMoveFailedError(from_rel,to_rel,
1314
errors.AlreadyVersionedError(path=str(to_rel)))
1316
# try to determine the mode for rename (only change inv or change
1317
# inv and file system)
1319
if not self.has_filename(to_rel):
1320
raise errors.BzrMoveFailedError(from_id,to_rel,
1321
errors.NoSuchFile(path=str(to_rel),
1322
extra="New file has not been created yet"))
1323
only_change_inv = True
1324
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1325
only_change_inv = True
1326
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1327
only_change_inv = False
1329
# something is wrong, so lets determine what exactly
1330
if not self.has_filename(from_rel) and \
1331
not self.has_filename(to_rel):
1332
raise errors.BzrRenameFailedError(from_rel,to_rel,
1333
errors.PathsDoNotExist(paths=(str(from_rel),
1336
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1337
extra="(Use --after to update the Bazaar id)")
1338
rename_entry.only_change_inv = only_change_inv
1339
return rename_entries
1341
def _move(self, rename_entries):
1342
"""Moves a list of files.
1344
Depending on the value of the flag 'only_change_inv', the
1345
file will be moved on the file system or not.
1347
inv = self.inventory
1350
for entry in rename_entries:
1352
self._move_entry(entry)
1354
self._rollback_move(moved)
1358
def _rollback_move(self, moved):
1359
"""Try to rollback a previous move in case of an filesystem error."""
1360
inv = self.inventory
1363
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1364
entry.to_tail, entry.to_parent_id, entry.from_rel,
1365
entry.from_tail, entry.from_parent_id,
1366
entry.only_change_inv))
1367
except errors.BzrMoveFailedError, e:
1368
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1369
" The working tree is in an inconsistent state."
1370
" Please consider doing a 'bzr revert'."
1371
" Error message is: %s" % e)
1373
def _move_entry(self, entry):
1374
inv = self.inventory
1375
from_rel_abs = self.abspath(entry.from_rel)
1376
to_rel_abs = self.abspath(entry.to_rel)
1377
if from_rel_abs == to_rel_abs:
1378
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1379
"Source and target are identical.")
1381
if not entry.only_change_inv:
1383
osutils.rename(from_rel_abs, to_rel_abs)
1385
raise errors.BzrMoveFailedError(entry.from_rel,
1387
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1389
@needs_tree_write_lock
1390
def rename_one(self, from_rel, to_rel, after=False):
1393
This can change the directory or the filename or both.
1395
rename_one has several 'modes' to work. First, it can rename a physical
1396
file and change the file_id. That is the normal mode. Second, it can
1397
only change the file_id without touching any physical file. This is
1398
the new mode introduced in version 0.15.
1400
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1401
versioned but present in the working tree.
1403
rename_one uses the second mode if 'after == False' and 'from_rel' is
1404
versioned but no longer in the working tree, and 'to_rel' is not
1405
versioned but present in the working tree.
1407
rename_one uses the first mode if 'after == False' and 'from_rel' is
1408
versioned and present in the working tree, and 'to_rel' is not
1409
versioned and not present in the working tree.
1411
Everything else results in an error.
1413
inv = self.inventory
1416
# create rename entries and tuples
1417
from_tail = splitpath(from_rel)[-1]
1418
from_id = inv.path2id(from_rel)
1420
raise errors.BzrRenameFailedError(from_rel,to_rel,
1421
errors.NotVersionedError(path=str(from_rel)))
1422
from_entry = inv[from_id]
1423
from_parent_id = from_entry.parent_id
1424
to_dir, to_tail = os.path.split(to_rel)
1425
to_dir_id = inv.path2id(to_dir)
1426
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1428
from_tail=from_tail,
1429
from_parent_id=from_parent_id,
1430
to_rel=to_rel, to_tail=to_tail,
1431
to_parent_id=to_dir_id)
1432
rename_entries.append(rename_entry)
1434
# determine which move mode to use. checks also for movability
1435
rename_entries = self._determine_mv_mode(rename_entries, after)
1437
# check if the target changed directory and if the target directory is
1439
if to_dir_id is None:
1440
raise errors.BzrMoveFailedError(from_rel,to_rel,
1441
errors.NotVersionedError(path=str(to_dir)))
1443
# all checks done. now we can continue with our actual work
1444
mutter('rename_one:\n'
1449
' to_dir_id {%s}\n',
1450
from_id, from_rel, to_rel, to_dir, to_dir_id)
1452
self._move(rename_entries)
1453
self._write_inventory(inv)
1455
class _RenameEntry(object):
1456
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1457
to_rel, to_tail, to_parent_id, only_change_inv=False):
1458
self.from_rel = from_rel
1459
self.from_id = from_id
1460
self.from_tail = from_tail
1461
self.from_parent_id = from_parent_id
1462
self.to_rel = to_rel
1463
self.to_tail = to_tail
1464
self.to_parent_id = to_parent_id
1465
self.only_change_inv = only_change_inv
1469
"""Return all unknown files.
1471
These are files in the working directory that are not versioned or
1472
control files or ignored.
1474
# force the extras method to be fully executed before returning, to
1475
# prevent race conditions with the lock
1477
[subp for subp in self.extras() if not self.is_ignored(subp)])
1479
@needs_tree_write_lock
1480
def unversion(self, file_ids):
1481
"""Remove the file ids in file_ids from the current versioned set.
1483
When a file_id is unversioned, all of its children are automatically
1486
:param file_ids: The file ids to stop versioning.
1487
:raises: NoSuchId if any fileid is not currently versioned.
1489
for file_id in file_ids:
1490
file_id = osutils.safe_file_id(file_id)
1491
if self._inventory.has_id(file_id):
1492
self._inventory.remove_recursive_id(file_id)
1494
raise errors.NoSuchId(self, file_id)
1496
# in the future this should just set a dirty bit to wait for the
1497
# final unlock. However, until all methods of workingtree start
1498
# with the current in -memory inventory rather than triggering
1499
# a read, it is more complex - we need to teach read_inventory
1500
# to know when to read, and when to not read first... and possibly
1501
# to save first when the in memory one may be corrupted.
1502
# so for now, we just only write it if it is indeed dirty.
1504
self._write_inventory(self._inventory)
1506
@deprecated_method(zero_eight)
1507
def iter_conflicts(self):
1508
"""List all files in the tree that have text or content conflicts.
1509
DEPRECATED. Use conflicts instead."""
1510
return self._iter_conflicts()
1512
def _iter_conflicts(self):
1514
for info in self.list_files():
1516
stem = get_conflicted_stem(path)
1519
if stem not in conflicted:
1520
conflicted.add(stem)
1524
def pull(self, source, overwrite=False, stop_revision=None,
1525
change_reporter=None, possible_transports=None):
1526
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1529
pp = ProgressPhase("Pull phase", 2, top_pb)
1531
old_revision_info = self.branch.last_revision_info()
1532
basis_tree = self.basis_tree()
1533
count = self.branch.pull(source, overwrite, stop_revision,
1534
possible_transports=possible_transports)
1535
new_revision_info = self.branch.last_revision_info()
1536
if new_revision_info != old_revision_info:
1538
repository = self.branch.repository
1539
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1540
basis_tree.lock_read()
1542
new_basis_tree = self.branch.basis_tree()
1549
change_reporter=change_reporter)
1550
if (basis_tree.inventory.root is None and
1551
new_basis_tree.inventory.root is not None):
1552
self.set_root_id(new_basis_tree.inventory.root.file_id)
1556
# TODO - dedup parents list with things merged by pull ?
1557
# reuse the revisiontree we merged against to set the new
1559
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1560
# we have to pull the merge trees out again, because
1561
# merge_inner has set the ids. - this corner is not yet
1562
# layered well enough to prevent double handling.
1563
# XXX TODO: Fix the double handling: telling the tree about
1564
# the already known parent data is wasteful.
1565
merges = self.get_parent_ids()[1:]
1566
parent_trees.extend([
1567
(parent, repository.revision_tree(parent)) for
1569
self.set_parent_trees(parent_trees)
1576
def put_file_bytes_non_atomic(self, file_id, bytes):
1577
"""See MutableTree.put_file_bytes_non_atomic."""
1578
file_id = osutils.safe_file_id(file_id)
1579
stream = file(self.id2abspath(file_id), 'wb')
1584
# TODO: update the hashcache here ?
1587
"""Yield all unversioned files in this WorkingTree.
1589
If there are any unversioned directories then only the directory is
1590
returned, not all its children. But if there are unversioned files
1591
under a versioned subdirectory, they are returned.
1593
Currently returned depth-first, sorted by name within directories.
1594
This is the same order used by 'osutils.walkdirs'.
1596
## TODO: Work from given directory downwards
1597
for path, dir_entry in self.inventory.directories():
1598
# mutter("search for unknowns in %r", path)
1599
dirabs = self.abspath(path)
1600
if not isdir(dirabs):
1601
# e.g. directory deleted
1605
for subf in os.listdir(dirabs):
1608
if subf not in dir_entry.children:
1609
subf_norm, can_access = osutils.normalized_filename(subf)
1610
if subf_norm != subf and can_access:
1611
if subf_norm not in dir_entry.children:
1612
fl.append(subf_norm)
1618
subp = pathjoin(path, subf)
1621
def ignored_files(self):
1622
"""Yield list of PATH, IGNORE_PATTERN"""
1623
for subp in self.extras():
1624
pat = self.is_ignored(subp)
1628
def get_ignore_list(self):
1629
"""Return list of ignore patterns.
1631
Cached in the Tree object after the first call.
1633
ignoreset = getattr(self, '_ignoreset', None)
1634
if ignoreset is not None:
1637
ignore_globs = set()
1638
ignore_globs.update(ignores.get_runtime_ignores())
1639
ignore_globs.update(ignores.get_user_ignores())
1640
if self.has_filename(bzrlib.IGNORE_FILENAME):
1641
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1643
ignore_globs.update(ignores.parse_ignore_file(f))
1646
self._ignoreset = ignore_globs
1649
def _flush_ignore_list_cache(self):
1650
"""Resets the cached ignore list to force a cache rebuild."""
1651
self._ignoreset = None
1652
self._ignoreglobster = None
1654
def is_ignored(self, filename):
1655
r"""Check whether the filename matches an ignore pattern.
1657
Patterns containing '/' or '\' need to match the whole path;
1658
others match against only the last component.
1660
If the file is ignored, returns the pattern which caused it to
1661
be ignored, otherwise None. So this can simply be used as a
1662
boolean if desired."""
1663
if getattr(self, '_ignoreglobster', None) is None:
1664
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1665
return self._ignoreglobster.match(filename)
1667
def kind(self, file_id):
1668
return file_kind(self.id2abspath(file_id))
1670
def _comparison_data(self, entry, path):
1671
abspath = self.abspath(path)
1673
stat_value = os.lstat(abspath)
1675
if getattr(e, 'errno', None) == errno.ENOENT:
1682
mode = stat_value.st_mode
1683
kind = osutils.file_kind_from_stat_mode(mode)
1684
if not supports_executable():
1685
executable = entry is not None and entry.executable
1687
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1688
return kind, executable, stat_value
1690
def _file_size(self, entry, stat_value):
1691
return stat_value.st_size
1693
def last_revision(self):
1694
"""Return the last revision of the branch for this tree.
1696
This format tree does not support a separate marker for last-revision
1697
compared to the branch.
1699
See MutableTree.last_revision
1701
return self._last_revision()
1704
def _last_revision(self):
1705
"""helper for get_parent_ids."""
1706
return _mod_revision.ensure_null(self.branch.last_revision())
1708
def is_locked(self):
1709
return self._control_files.is_locked()
1711
def _must_be_locked(self):
1712
if not self.is_locked():
1713
raise errors.ObjectNotLocked(self)
1715
def lock_read(self):
1716
"""See Branch.lock_read, and WorkingTree.unlock."""
1717
if not self.is_locked():
1719
self.branch.lock_read()
1721
return self._control_files.lock_read()
1723
self.branch.unlock()
1726
def lock_tree_write(self):
1727
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1728
if not self.is_locked():
1730
self.branch.lock_read()
1732
return self._control_files.lock_write()
1734
self.branch.unlock()
1737
def lock_write(self):
1738
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1739
if not self.is_locked():
1741
self.branch.lock_write()
1743
return self._control_files.lock_write()
1745
self.branch.unlock()
1748
def get_physical_lock_status(self):
1749
return self._control_files.get_physical_lock_status()
1751
def _basis_inventory_name(self):
1752
return 'basis-inventory-cache'
1754
def _reset_data(self):
1755
"""Reset transient data that cannot be revalidated."""
1756
self._inventory_is_modified = False
1757
result = self._deserialize(self._control_files.get('inventory'))
1758
self._set_inventory(result, dirty=False)
1760
@needs_tree_write_lock
1761
def set_last_revision(self, new_revision):
1762
"""Change the last revision in the working tree."""
1763
new_revision = osutils.safe_revision_id(new_revision)
1764
if self._change_last_revision(new_revision):
1765
self._cache_basis_inventory(new_revision)
1767
def _change_last_revision(self, new_revision):
1768
"""Template method part of set_last_revision to perform the change.
1770
This is used to allow WorkingTree3 instances to not affect branch
1771
when their last revision is set.
1773
if _mod_revision.is_null(new_revision):
1774
self.branch.set_revision_history([])
1777
self.branch.generate_revision_history(new_revision)
1778
except errors.NoSuchRevision:
1779
# not present in the repo - dont try to set it deeper than the tip
1780
self.branch.set_revision_history([new_revision])
1783
def _write_basis_inventory(self, xml):
1784
"""Write the basis inventory XML to the basis-inventory file"""
1785
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1786
path = self._basis_inventory_name()
1788
self._control_files.put(path, sio)
1790
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1791
"""Create the text that will be saved in basis-inventory"""
1792
# TODO: jam 20070209 This should be redundant, as the revision_id
1793
# as all callers should have already converted the revision_id to
1795
inventory.revision_id = osutils.safe_revision_id(revision_id)
1796
return xml7.serializer_v7.write_inventory_to_string(inventory)
1798
def _cache_basis_inventory(self, new_revision):
1799
"""Cache new_revision as the basis inventory."""
1800
# TODO: this should allow the ready-to-use inventory to be passed in,
1801
# as commit already has that ready-to-use [while the format is the
1804
# this double handles the inventory - unpack and repack -
1805
# but is easier to understand. We can/should put a conditional
1806
# in here based on whether the inventory is in the latest format
1807
# - perhaps we should repack all inventories on a repository
1809
# the fast path is to copy the raw xml from the repository. If the
1810
# xml contains 'revision_id="', then we assume the right
1811
# revision_id is set. We must check for this full string, because a
1812
# root node id can legitimately look like 'revision_id' but cannot
1814
xml = self.branch.repository.get_inventory_xml(new_revision)
1815
firstline = xml.split('\n', 1)[0]
1816
if (not 'revision_id="' in firstline or
1817
'format="7"' not in firstline):
1818
inv = self.branch.repository.deserialise_inventory(
1820
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1821
self._write_basis_inventory(xml)
1822
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1825
def read_basis_inventory(self):
1826
"""Read the cached basis inventory."""
1827
path = self._basis_inventory_name()
1828
return self._control_files.get(path).read()
1831
def read_working_inventory(self):
1832
"""Read the working inventory.
1834
:raises errors.InventoryModified: read_working_inventory will fail
1835
when the current in memory inventory has been modified.
1837
# conceptually this should be an implementation detail of the tree.
1838
# XXX: Deprecate this.
1839
# ElementTree does its own conversion from UTF-8, so open in
1841
if self._inventory_is_modified:
1842
raise errors.InventoryModified(self)
1843
result = self._deserialize(self._control_files.get('inventory'))
1844
self._set_inventory(result, dirty=False)
1847
@needs_tree_write_lock
1848
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1850
"""Remove nominated files from the working inventory.
1852
:files: File paths relative to the basedir.
1853
:keep_files: If true, the files will also be kept.
1854
:force: Delete files and directories, even if they are changed and
1855
even if the directories are not empty.
1857
if isinstance(files, basestring):
1863
unknown_nested_files=set()
1865
def recurse_directory_to_add_files(directory):
1866
# Recurse directory and add all files
1867
# so we can check if they have changed.
1868
for parent_info, file_infos in\
1869
osutils.walkdirs(self.abspath(directory),
1871
for relpath, basename, kind, lstat, abspath in file_infos:
1872
# Is it versioned or ignored?
1873
if self.path2id(relpath) or self.is_ignored(relpath):
1874
# Add nested content for deletion.
1875
new_files.add(relpath)
1877
# Files which are not versioned and not ignored
1878
# should be treated as unknown.
1879
unknown_nested_files.add((relpath, None, kind))
1881
for filename in files:
1882
# Get file name into canonical form.
1883
abspath = self.abspath(filename)
1884
filename = self.relpath(abspath)
1885
if len(filename) > 0:
1886
new_files.add(filename)
1887
if osutils.isdir(abspath):
1888
recurse_directory_to_add_files(filename)
1890
files = list(new_files)
1893
return # nothing to do
1895
# Sort needed to first handle directory content before the directory
1896
files.sort(reverse=True)
1898
# Bail out if we are going to delete files we shouldn't
1899
if not keep_files and not force:
1900
has_changed_files = len(unknown_nested_files) > 0
1901
if not has_changed_files:
1902
for (file_id, path, content_change, versioned, parent_id, name,
1903
kind, executable) in self._iter_changes(self.basis_tree(),
1904
include_unchanged=True, require_versioned=False,
1905
want_unversioned=True, specific_files=files):
1906
# Check if it's an unknown (but not ignored) OR
1907
# changed (but not deleted) :
1908
if not self.is_ignored(path[1]) and (
1909
versioned == (False, False) or
1910
content_change and kind[1] != None):
1911
has_changed_files = True
1914
if has_changed_files:
1915
# Make delta show ALL applicable changes in error message.
1916
tree_delta = self.changes_from(self.basis_tree(),
1917
require_versioned=False, want_unversioned=True,
1918
specific_files=files)
1919
for unknown_file in unknown_nested_files:
1920
if unknown_file not in tree_delta.unversioned:
1921
tree_delta.unversioned.extend((unknown_file,))
1922
raise errors.BzrRemoveChangedFilesError(tree_delta)
1924
# Build inv_delta and delete files where applicaple,
1925
# do this before any modifications to inventory.
1927
fid = self.path2id(f)
1930
message = "%s is not versioned." % (f,)
1933
# having removed it, it must be either ignored or unknown
1934
if self.is_ignored(f):
1938
textui.show_status(new_status, self.kind(fid), f,
1941
inv_delta.append((f, None, fid, None))
1942
message = "removed %s" % (f,)
1945
abs_path = self.abspath(f)
1946
if osutils.lexists(abs_path):
1947
if (osutils.isdir(abs_path) and
1948
len(os.listdir(abs_path)) > 0):
1950
osutils.rmtree(abs_path)
1952
message = "%s is not an empty directory "\
1953
"and won't be deleted." % (f,)
1955
osutils.delete_any(abs_path)
1956
message = "deleted %s" % (f,)
1957
elif message is not None:
1958
# Only care if we haven't done anything yet.
1959
message = "%s does not exist." % (f,)
1961
# Print only one message (if any) per file.
1962
if message is not None:
1964
self.apply_inventory_delta(inv_delta)
1966
@needs_tree_write_lock
1967
def revert(self, filenames=None, old_tree=None, backups=True,
1968
pb=DummyProgress(), report_changes=False):
1969
from bzrlib.conflicts import resolve
1972
symbol_versioning.warn('Using [] to revert all files is deprecated'
1973
' as of bzr 0.91. Please use None (the default) instead.',
1974
DeprecationWarning, stacklevel=2)
1975
if old_tree is None:
1976
old_tree = self.basis_tree()
1977
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1979
if filenames is None:
1980
self.set_parent_ids(self.get_parent_ids()[:1])
1983
resolve(self, filenames, ignore_misses=True)
1986
def revision_tree(self, revision_id):
1987
"""See Tree.revision_tree.
1989
WorkingTree can supply revision_trees for the basis revision only
1990
because there is only one cached inventory in the bzr directory.
1992
if revision_id == self.last_revision():
1994
xml = self.read_basis_inventory()
1995
except errors.NoSuchFile:
1999
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2000
# dont use the repository revision_tree api because we want
2001
# to supply the inventory.
2002
if inv.revision_id == revision_id:
2003
return revisiontree.RevisionTree(self.branch.repository,
2005
except errors.BadInventoryFormat:
2007
# raise if there was no inventory, or if we read the wrong inventory.
2008
raise errors.NoSuchRevisionInTree(self, revision_id)
2010
# XXX: This method should be deprecated in favour of taking in a proper
2011
# new Inventory object.
2012
@needs_tree_write_lock
2013
def set_inventory(self, new_inventory_list):
2014
from bzrlib.inventory import (Inventory,
2019
inv = Inventory(self.get_root_id())
2020
for path, file_id, parent, kind in new_inventory_list:
2021
name = os.path.basename(path)
2024
# fixme, there should be a factory function inv,add_??
2025
if kind == 'directory':
2026
inv.add(InventoryDirectory(file_id, name, parent))
2027
elif kind == 'file':
2028
inv.add(InventoryFile(file_id, name, parent))
2029
elif kind == 'symlink':
2030
inv.add(InventoryLink(file_id, name, parent))
2032
raise errors.BzrError("unknown kind %r" % kind)
2033
self._write_inventory(inv)
2035
@needs_tree_write_lock
2036
def set_root_id(self, file_id):
2037
"""Set the root id for this tree."""
2040
symbol_versioning.warn(symbol_versioning.zero_twelve
2041
% 'WorkingTree.set_root_id with fileid=None',
2046
file_id = osutils.safe_file_id(file_id)
2047
self._set_root_id(file_id)
2049
def _set_root_id(self, file_id):
2050
"""Set the root id for this tree, in a format specific manner.
2052
:param file_id: The file id to assign to the root. It must not be
2053
present in the current inventory or an error will occur. It must
2054
not be None, but rather a valid file id.
2056
inv = self._inventory
2057
orig_root_id = inv.root.file_id
2058
# TODO: it might be nice to exit early if there was nothing
2059
# to do, saving us from trigger a sync on unlock.
2060
self._inventory_is_modified = True
2061
# we preserve the root inventory entry object, but
2062
# unlinkit from the byid index
2063
del inv._byid[inv.root.file_id]
2064
inv.root.file_id = file_id
2065
# and link it into the index with the new changed id.
2066
inv._byid[inv.root.file_id] = inv.root
2067
# and finally update all children to reference the new id.
2068
# XXX: this should be safe to just look at the root.children
2069
# list, not the WHOLE INVENTORY.
2072
if entry.parent_id == orig_root_id:
2073
entry.parent_id = inv.root.file_id
2076
"""See Branch.unlock.
2078
WorkingTree locking just uses the Branch locking facilities.
2079
This is current because all working trees have an embedded branch
2080
within them. IF in the future, we were to make branch data shareable
2081
between multiple working trees, i.e. via shared storage, then we
2082
would probably want to lock both the local tree, and the branch.
2084
raise NotImplementedError(self.unlock)
2086
def update(self, change_reporter=None, possible_transports=None):
2087
"""Update a working tree along its branch.
2089
This will update the branch if its bound too, which means we have
2090
multiple trees involved:
2092
- The new basis tree of the master.
2093
- The old basis tree of the branch.
2094
- The old basis tree of the working tree.
2095
- The current working tree state.
2097
Pathologically, all three may be different, and non-ancestors of each
2098
other. Conceptually we want to:
2100
- Preserve the wt.basis->wt.state changes
2101
- Transform the wt.basis to the new master basis.
2102
- Apply a merge of the old branch basis to get any 'local' changes from
2104
- Restore the wt.basis->wt.state changes.
2106
There isn't a single operation at the moment to do that, so we:
2107
- Merge current state -> basis tree of the master w.r.t. the old tree
2109
- Do a 'normal' merge of the old branch basis if it is relevant.
2111
if self.branch.get_master_branch(possible_transports) is not None:
2113
update_branch = True
2115
self.lock_tree_write()
2116
update_branch = False
2119
old_tip = self.branch.update(possible_transports)
2122
return self._update_tree(old_tip, change_reporter)
2126
@needs_tree_write_lock
2127
def _update_tree(self, old_tip=None, change_reporter=None):
2128
"""Update a tree to the master branch.
2130
:param old_tip: if supplied, the previous tip revision the branch,
2131
before it was changed to the master branch's tip.
2133
# here if old_tip is not None, it is the old tip of the branch before
2134
# it was updated from the master branch. This should become a pending
2135
# merge in the working tree to preserve the user existing work. we
2136
# cant set that until we update the working trees last revision to be
2137
# one from the new branch, because it will just get absorbed by the
2138
# parent de-duplication logic.
2140
# We MUST save it even if an error occurs, because otherwise the users
2141
# local work is unreferenced and will appear to have been lost.
2145
last_rev = self.get_parent_ids()[0]
2147
last_rev = _mod_revision.NULL_REVISION
2148
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2149
# merge tree state up to new branch tip.
2150
basis = self.basis_tree()
2153
to_tree = self.branch.basis_tree()
2154
if basis.inventory.root is None:
2155
self.set_root_id(to_tree.inventory.root.file_id)
2157
result += merge.merge_inner(
2162
change_reporter=change_reporter)
2165
# TODO - dedup parents list with things merged by pull ?
2166
# reuse the tree we've updated to to set the basis:
2167
parent_trees = [(self.branch.last_revision(), to_tree)]
2168
merges = self.get_parent_ids()[1:]
2169
# Ideally we ask the tree for the trees here, that way the working
2170
# tree can decide whether to give us teh entire tree or give us a
2171
# lazy initialised tree. dirstate for instance will have the trees
2172
# in ram already, whereas a last-revision + basis-inventory tree
2173
# will not, but also does not need them when setting parents.
2174
for parent in merges:
2175
parent_trees.append(
2176
(parent, self.branch.repository.revision_tree(parent)))
2177
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2178
parent_trees.append(
2179
(old_tip, self.branch.repository.revision_tree(old_tip)))
2180
self.set_parent_trees(parent_trees)
2181
last_rev = parent_trees[0][0]
2183
# the working tree had the same last-revision as the master
2184
# branch did. We may still have pivot local work from the local
2185
# branch into old_tip:
2186
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2187
self.add_parent_tree_id(old_tip)
2188
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2189
and old_tip != last_rev):
2190
# our last revision was not the prior branch last revision
2191
# and we have converted that last revision to a pending merge.
2192
# base is somewhere between the branch tip now
2193
# and the now pending merge
2195
# Since we just modified the working tree and inventory, flush out
2196
# the current state, before we modify it again.
2197
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2198
# requires it only because TreeTransform directly munges the
2199
# inventory and calls tree._write_inventory(). Ultimately we
2200
# should be able to remove this extra flush.
2202
graph = self.branch.repository.get_graph()
2203
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2205
base_tree = self.branch.repository.revision_tree(base_rev_id)
2206
other_tree = self.branch.repository.revision_tree(old_tip)
2207
result += merge.merge_inner(
2212
change_reporter=change_reporter)
2215
def _write_hashcache_if_dirty(self):
2216
"""Write out the hashcache if it is dirty."""
2217
if self._hashcache.needs_write:
2219
self._hashcache.write()
2221
if e.errno not in (errno.EPERM, errno.EACCES):
2223
# TODO: jam 20061219 Should this be a warning? A single line
2224
# warning might be sufficient to let the user know what
2226
mutter('Could not write hashcache for %s\nError: %s',
2227
self._hashcache.cache_file_name(), e)
2229
@needs_tree_write_lock
2230
def _write_inventory(self, inv):
2231
"""Write inventory as the current inventory."""
2232
self._set_inventory(inv, dirty=True)
2235
def set_conflicts(self, arg):
2236
raise errors.UnsupportedOperation(self.set_conflicts, self)
2238
def add_conflicts(self, arg):
2239
raise errors.UnsupportedOperation(self.add_conflicts, self)
2242
def conflicts(self):
2243
conflicts = _mod_conflicts.ConflictList()
2244
for conflicted in self._iter_conflicts():
2247
if file_kind(self.abspath(conflicted)) != "file":
2249
except errors.NoSuchFile:
2252
for suffix in ('.THIS', '.OTHER'):
2254
kind = file_kind(self.abspath(conflicted+suffix))
2257
except errors.NoSuchFile:
2261
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2262
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2264
file_id=self.path2id(conflicted)))
2267
def walkdirs(self, prefix=""):
2268
"""Walk the directories of this tree.
2270
returns a generator which yields items in the form:
2271
((curren_directory_path, fileid),
2272
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2275
This API returns a generator, which is only valid during the current
2276
tree transaction - within a single lock_read or lock_write duration.
2278
If the tree is not locked, it may cause an error to be raised,
2279
depending on the tree implementation.
2281
disk_top = self.abspath(prefix)
2282
if disk_top.endswith('/'):
2283
disk_top = disk_top[:-1]
2284
top_strip_len = len(disk_top) + 1
2285
inventory_iterator = self._walkdirs(prefix)
2286
disk_iterator = osutils.walkdirs(disk_top, prefix)
2288
current_disk = disk_iterator.next()
2289
disk_finished = False
2291
if not (e.errno == errno.ENOENT or
2292
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2295
disk_finished = True
2297
current_inv = inventory_iterator.next()
2298
inv_finished = False
2299
except StopIteration:
2302
while not inv_finished or not disk_finished:
2303
if not disk_finished:
2304
# strip out .bzr dirs
2305
if current_disk[0][1][top_strip_len:] == '':
2306
# osutils.walkdirs can be made nicer -
2307
# yield the path-from-prefix rather than the pathjoined
2309
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2310
if current_disk[1][bzrdir_loc][0] == '.bzr':
2311
# we dont yield the contents of, or, .bzr itself.
2312
del current_disk[1][bzrdir_loc]
2314
# everything is unknown
2317
# everything is missing
2320
direction = cmp(current_inv[0][0], current_disk[0][0])
2322
# disk is before inventory - unknown
2323
dirblock = [(relpath, basename, kind, stat, None, None) for
2324
relpath, basename, kind, stat, top_path in current_disk[1]]
2325
yield (current_disk[0][0], None), dirblock
2327
current_disk = disk_iterator.next()
2328
except StopIteration:
2329
disk_finished = True
2331
# inventory is before disk - missing.
2332
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2333
for relpath, basename, dkind, stat, fileid, kind in
2335
yield (current_inv[0][0], current_inv[0][1]), dirblock
2337
current_inv = inventory_iterator.next()
2338
except StopIteration:
2341
# versioned present directory
2342
# merge the inventory and disk data together
2344
for relpath, subiterator in itertools.groupby(sorted(
2345
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2346
path_elements = list(subiterator)
2347
if len(path_elements) == 2:
2348
inv_row, disk_row = path_elements
2349
# versioned, present file
2350
dirblock.append((inv_row[0],
2351
inv_row[1], disk_row[2],
2352
disk_row[3], inv_row[4],
2354
elif len(path_elements[0]) == 5:
2356
dirblock.append((path_elements[0][0],
2357
path_elements[0][1], path_elements[0][2],
2358
path_elements[0][3], None, None))
2359
elif len(path_elements[0]) == 6:
2360
# versioned, absent file.
2361
dirblock.append((path_elements[0][0],
2362
path_elements[0][1], 'unknown', None,
2363
path_elements[0][4], path_elements[0][5]))
2365
raise NotImplementedError('unreachable code')
2366
yield current_inv[0], dirblock
2368
current_inv = inventory_iterator.next()
2369
except StopIteration:
2372
current_disk = disk_iterator.next()
2373
except StopIteration:
2374
disk_finished = True
2376
def _walkdirs(self, prefix=""):
2377
"""Walk the directories of this tree.
2379
:prefix: is used as the directrory to start with.
2380
returns a generator which yields items in the form:
2381
((curren_directory_path, fileid),
2382
[(file1_path, file1_name, file1_kind, None, file1_id,
2385
_directory = 'directory'
2386
# get the root in the inventory
2387
inv = self.inventory
2388
top_id = inv.path2id(prefix)
2392
pending = [(prefix, '', _directory, None, top_id, None)]
2395
currentdir = pending.pop()
2396
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2397
top_id = currentdir[4]
2399
relroot = currentdir[0] + '/'
2402
# FIXME: stash the node in pending
2404
for name, child in entry.sorted_children():
2405
dirblock.append((relroot + name, name, child.kind, None,
2406
child.file_id, child.kind
2408
yield (currentdir[0], entry.file_id), dirblock
2409
# push the user specified dirs from dirblock
2410
for dir in reversed(dirblock):
2411
if dir[2] == _directory:
2414
@needs_tree_write_lock
2415
def auto_resolve(self):
2416
"""Automatically resolve text conflicts according to contents.
2418
Only text conflicts are auto_resolvable. Files with no conflict markers
2419
are considered 'resolved', because bzr always puts conflict markers
2420
into files that have text conflicts. The corresponding .THIS .BASE and
2421
.OTHER files are deleted, as per 'resolve'.
2422
:return: a tuple of ConflictLists: (un_resolved, resolved).
2424
un_resolved = _mod_conflicts.ConflictList()
2425
resolved = _mod_conflicts.ConflictList()
2426
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2427
for conflict in self.conflicts():
2428
if (conflict.typestring != 'text conflict' or
2429
self.kind(conflict.file_id) != 'file'):
2430
un_resolved.append(conflict)
2432
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2434
for line in my_file:
2435
if conflict_re.search(line):
2436
un_resolved.append(conflict)
2439
resolved.append(conflict)
2442
resolved.remove_files(self)
2443
self.set_conflicts(un_resolved)
2444
return un_resolved, resolved
2446
def _validate(self):
2447
"""Validate internal structures.
2449
This is meant mostly for the test suite. To give it a chance to detect
2450
corruption after actions have occurred. The default implementation is a
2453
:return: None. An exception should be raised if there is an error.
2458
class WorkingTree2(WorkingTree):
2459
"""This is the Format 2 working tree.
2461
This was the first weave based working tree.
2462
- uses os locks for locking.
2463
- uses the branch last-revision.
2466
def __init__(self, *args, **kwargs):
2467
super(WorkingTree2, self).__init__(*args, **kwargs)
2468
# WorkingTree2 has more of a constraint that self._inventory must
2469
# exist. Because this is an older format, we don't mind the overhead
2470
# caused by the extra computation here.
2472
# Newer WorkingTree's should only have self._inventory set when they
2474
if self._inventory is None:
2475
self.read_working_inventory()
2477
def lock_tree_write(self):
2478
"""See WorkingTree.lock_tree_write().
2480
In Format2 WorkingTrees we have a single lock for the branch and tree
2481
so lock_tree_write() degrades to lock_write().
2483
self.branch.lock_write()
2485
return self._control_files.lock_write()
2487
self.branch.unlock()
2491
# do non-implementation specific cleanup
2494
# we share control files:
2495
if self._control_files._lock_count == 3:
2496
# _inventory_is_modified is always False during a read lock.
2497
if self._inventory_is_modified:
2499
self._write_hashcache_if_dirty()
2501
# reverse order of locking.
2503
return self._control_files.unlock()
2505
self.branch.unlock()
2508
class WorkingTree3(WorkingTree):
2509
"""This is the Format 3 working tree.
2511
This differs from the base WorkingTree by:
2512
- having its own file lock
2513
- having its own last-revision property.
2515
This is new in bzr 0.8
2519
def _last_revision(self):
2520
"""See Mutable.last_revision."""
2522
return osutils.safe_revision_id(
2523
self._control_files.get('last-revision').read())
2524
except errors.NoSuchFile:
2525
return _mod_revision.NULL_REVISION
2527
def _change_last_revision(self, revision_id):
2528
"""See WorkingTree._change_last_revision."""
2529
if revision_id is None or revision_id == NULL_REVISION:
2531
self._control_files._transport.delete('last-revision')
2532
except errors.NoSuchFile:
2536
self._control_files.put_bytes('last-revision', revision_id)
2539
@needs_tree_write_lock
2540
def set_conflicts(self, conflicts):
2541
self._put_rio('conflicts', conflicts.to_stanzas(),
2544
@needs_tree_write_lock
2545
def add_conflicts(self, new_conflicts):
2546
conflict_set = set(self.conflicts())
2547
conflict_set.update(set(list(new_conflicts)))
2548
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2549
key=_mod_conflicts.Conflict.sort_key)))
2552
def conflicts(self):
2554
confile = self._control_files.get('conflicts')
2555
except errors.NoSuchFile:
2556
return _mod_conflicts.ConflictList()
2558
if confile.next() != CONFLICT_HEADER_1 + '\n':
2559
raise errors.ConflictFormatError()
2560
except StopIteration:
2561
raise errors.ConflictFormatError()
2562
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2565
# do non-implementation specific cleanup
2567
if self._control_files._lock_count == 1:
2568
# _inventory_is_modified is always False during a read lock.
2569
if self._inventory_is_modified:
2571
self._write_hashcache_if_dirty()
2572
# reverse order of locking.
2574
return self._control_files.unlock()
2576
self.branch.unlock()
2579
def get_conflicted_stem(path):
2580
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2581
if path.endswith(suffix):
2582
return path[:-len(suffix)]
2585
@deprecated_function(zero_eight)
2586
def is_control_file(filename):
2587
"""See WorkingTree.is_control_filename(filename)."""
2588
## FIXME: better check
2589
filename = normpath(filename)
2590
while filename != '':
2591
head, tail = os.path.split(filename)
2592
## mutter('check %r for control file' % ((head, tail),))
2595
if filename == head:
2601
class WorkingTreeFormat(object):
2602
"""An encapsulation of the initialization and open routines for a format.
2604
Formats provide three things:
2605
* An initialization routine,
2609
Formats are placed in an dict by their format string for reference
2610
during workingtree opening. Its not required that these be instances, they
2611
can be classes themselves with class methods - it simply depends on
2612
whether state is needed for a given format or not.
2614
Once a format is deprecated, just deprecate the initialize and open
2615
methods on the format class. Do not deprecate the object, as the
2616
object will be created every time regardless.
2619
_default_format = None
2620
"""The default format used for new trees."""
2623
"""The known formats."""
2625
requires_rich_root = False
2627
upgrade_recommended = False
2630
def find_format(klass, a_bzrdir):
2631
"""Return the format for the working tree object in a_bzrdir."""
2633
transport = a_bzrdir.get_workingtree_transport(None)
2634
format_string = transport.get("format").read()
2635
return klass._formats[format_string]
2636
except errors.NoSuchFile:
2637
raise errors.NoWorkingTree(base=transport.base)
2639
raise errors.UnknownFormatError(format=format_string)
2641
def __eq__(self, other):
2642
return self.__class__ is other.__class__
2644
def __ne__(self, other):
2645
return not (self == other)
2648
def get_default_format(klass):
2649
"""Return the current default format."""
2650
return klass._default_format
2652
def get_format_string(self):
2653
"""Return the ASCII format string that identifies this format."""
2654
raise NotImplementedError(self.get_format_string)
2656
def get_format_description(self):
2657
"""Return the short description for this format."""
2658
raise NotImplementedError(self.get_format_description)
2660
def is_supported(self):
2661
"""Is this format supported?
2663
Supported formats can be initialized and opened.
2664
Unsupported formats may not support initialization or committing or
2665
some other features depending on the reason for not being supported.
2670
def register_format(klass, format):
2671
klass._formats[format.get_format_string()] = format
2674
def set_default_format(klass, format):
2675
klass._default_format = format
2678
def unregister_format(klass, format):
2679
assert klass._formats[format.get_format_string()] is format
2680
del klass._formats[format.get_format_string()]
2683
class WorkingTreeFormat2(WorkingTreeFormat):
2684
"""The second working tree format.
2686
This format modified the hash cache from the format 1 hash cache.
2689
upgrade_recommended = True
2691
def get_format_description(self):
2692
"""See WorkingTreeFormat.get_format_description()."""
2693
return "Working tree format 2"
2695
def stub_initialize_remote(self, control_files):
2696
"""As a special workaround create critical control files for a remote working tree
2698
This ensures that it can later be updated and dealt with locally,
2699
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2700
no working tree. (See bug #43064).
2704
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2706
control_files.put('inventory', sio)
2708
control_files.put_bytes('pending-merges', '')
2711
def initialize(self, a_bzrdir, revision_id=None):
2712
"""See WorkingTreeFormat.initialize()."""
2713
if not isinstance(a_bzrdir.transport, LocalTransport):
2714
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2715
branch = a_bzrdir.open_branch()
2716
if revision_id is None:
2717
revision_id = _mod_revision.ensure_null(branch.last_revision())
2719
revision_id = osutils.safe_revision_id(revision_id)
2722
branch.generate_revision_history(revision_id)
2726
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2732
basis_tree = branch.repository.revision_tree(revision_id)
2733
if basis_tree.inventory.root is not None:
2734
wt.set_root_id(basis_tree.inventory.root.file_id)
2735
# set the parent list and cache the basis tree.
2736
if _mod_revision.is_null(revision_id):
2739
parent_trees = [(revision_id, basis_tree)]
2740
wt.set_parent_trees(parent_trees)
2741
transform.build_tree(basis_tree, wt)
2745
super(WorkingTreeFormat2, self).__init__()
2746
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2748
def open(self, a_bzrdir, _found=False):
2749
"""Return the WorkingTree object for a_bzrdir
2751
_found is a private parameter, do not use it. It is used to indicate
2752
if format probing has already been done.
2755
# we are being called directly and must probe.
2756
raise NotImplementedError
2757
if not isinstance(a_bzrdir.transport, LocalTransport):
2758
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2759
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2765
class WorkingTreeFormat3(WorkingTreeFormat):
2766
"""The second working tree format updated to record a format marker.
2769
- exists within a metadir controlling .bzr
2770
- includes an explicit version marker for the workingtree control
2771
files, separate from the BzrDir format
2772
- modifies the hash cache format
2774
- uses a LockDir to guard access for writes.
2777
upgrade_recommended = True
2779
def get_format_string(self):
2780
"""See WorkingTreeFormat.get_format_string()."""
2781
return "Bazaar-NG Working Tree format 3"
2783
def get_format_description(self):
2784
"""See WorkingTreeFormat.get_format_description()."""
2785
return "Working tree format 3"
2787
_lock_file_name = 'lock'
2788
_lock_class = LockDir
2790
_tree_class = WorkingTree3
2792
def __get_matchingbzrdir(self):
2793
return bzrdir.BzrDirMetaFormat1()
2795
_matchingbzrdir = property(__get_matchingbzrdir)
2797
def _open_control_files(self, a_bzrdir):
2798
transport = a_bzrdir.get_workingtree_transport(None)
2799
return LockableFiles(transport, self._lock_file_name,
2802
def initialize(self, a_bzrdir, revision_id=None):
2803
"""See WorkingTreeFormat.initialize().
2805
revision_id allows creating a working tree at a different
2806
revision than the branch is at.
2808
if not isinstance(a_bzrdir.transport, LocalTransport):
2809
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2810
transport = a_bzrdir.get_workingtree_transport(self)
2811
control_files = self._open_control_files(a_bzrdir)
2812
control_files.create_lock()
2813
control_files.lock_write()
2814
control_files.put_utf8('format', self.get_format_string())
2815
branch = a_bzrdir.open_branch()
2816
if revision_id is None:
2817
revision_id = _mod_revision.ensure_null(branch.last_revision())
2819
revision_id = osutils.safe_revision_id(revision_id)
2820
# WorkingTree3 can handle an inventory which has a unique root id.
2821
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2822
# those trees. And because there isn't a format bump inbetween, we
2823
# are maintaining compatibility with older clients.
2824
# inv = Inventory(root_id=gen_root_id())
2825
inv = self._initial_inventory()
2826
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2832
_control_files=control_files)
2833
wt.lock_tree_write()
2835
basis_tree = branch.repository.revision_tree(revision_id)
2836
# only set an explicit root id if there is one to set.
2837
if basis_tree.inventory.root is not None:
2838
wt.set_root_id(basis_tree.inventory.root.file_id)
2839
if revision_id == NULL_REVISION:
2840
wt.set_parent_trees([])
2842
wt.set_parent_trees([(revision_id, basis_tree)])
2843
transform.build_tree(basis_tree, wt)
2845
# Unlock in this order so that the unlock-triggers-flush in
2846
# WorkingTree is given a chance to fire.
2847
control_files.unlock()
2851
def _initial_inventory(self):
2855
super(WorkingTreeFormat3, self).__init__()
2857
def open(self, a_bzrdir, _found=False):
2858
"""Return the WorkingTree object for a_bzrdir
2860
_found is a private parameter, do not use it. It is used to indicate
2861
if format probing has already been done.
2864
# we are being called directly and must probe.
2865
raise NotImplementedError
2866
if not isinstance(a_bzrdir.transport, LocalTransport):
2867
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2868
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2871
def _open(self, a_bzrdir, control_files):
2872
"""Open the tree itself.
2874
:param a_bzrdir: the dir for the tree.
2875
:param control_files: the control files for the tree.
2877
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2881
_control_files=control_files)
2884
return self.get_format_string()
2887
__default_format = WorkingTreeFormat4()
2888
WorkingTreeFormat.register_format(__default_format)
2889
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2890
WorkingTreeFormat.set_default_format(__default_format)
2891
# formats which have no format string are not discoverable
2892
# and not independently creatable, so are not registered.
2893
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
