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
path = self.id2path(file_id)
457
return self.get_file_byname(path)
459
def get_file_text(self, file_id):
460
return self.get_file(file_id).read()
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
466
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
467
"""See Tree.annotate_iter
469
This implementation will use the basis tree implementation if possible.
470
Lines not in the basis are attributed to CURRENT_REVISION
472
If there are pending merges, lines added by those merges will be
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
attribution will be correct).
476
basis = self.basis_tree()
479
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
480
require_versioned=True).next()
481
changed_content, kind = changes[2], changes[6]
482
if not changed_content:
483
return basis.annotate_iter(file_id)
487
if kind[0] != 'file':
490
old_lines = list(basis.annotate_iter(file_id))
492
for tree in self.branch.repository.revision_trees(
493
self.get_parent_ids()[1:]):
494
if file_id not in tree:
496
old.append(list(tree.annotate_iter(file_id)))
497
return annotate.reannotate(old, self.get_file(file_id).readlines(),
502
def _get_ancestors(self, default_revision):
503
ancestors = set([default_revision])
504
for parent_id in self.get_parent_ids():
505
ancestors.update(self.branch.repository.get_ancestry(
506
parent_id, topo_sorted=False))
509
def get_parent_ids(self):
510
"""See Tree.get_parent_ids.
512
This implementation reads the pending merges list and last_revision
513
value and uses that to decide what the parents list should be.
515
last_rev = _mod_revision.ensure_null(self._last_revision())
516
if _mod_revision.NULL_REVISION == last_rev:
521
merges_file = self._control_files.get('pending-merges')
522
except errors.NoSuchFile:
525
for l in merges_file.readlines():
526
revision_id = l.rstrip('\n')
527
parents.append(revision_id)
531
def get_root_id(self):
532
"""Return the id of this trees root"""
533
return self._inventory.root.file_id
535
def _get_store_filename(self, file_id):
536
## XXX: badly named; this is not in the store at all
537
return self.abspath(self.id2path(file_id))
540
def clone(self, to_bzrdir, revision_id=None):
541
"""Duplicate this working tree into to_bzr, including all state.
543
Specifically modified files are kept as modified, but
544
ignored and unknown files are discarded.
546
If you want to make a new line of development, see bzrdir.sprout()
549
If not None, the cloned tree will have its last revision set to
550
revision, and and difference between the source trees last revision
551
and this one merged in.
553
# assumes the target bzr dir format is compatible.
554
result = self._format.initialize(to_bzrdir)
555
self.copy_content_into(result, revision_id)
559
def copy_content_into(self, tree, revision_id=None):
560
"""Copy the current content and user files of this tree into tree."""
561
tree.set_root_id(self.get_root_id())
562
if revision_id is None:
563
merge.transform_tree(tree, self)
565
# TODO now merge from tree.last_revision to revision (to preserve
566
# user local changes)
567
merge.transform_tree(tree, self)
568
tree.set_parent_ids([revision_id])
570
def id2abspath(self, file_id):
571
return self.abspath(self.id2path(file_id))
573
def has_id(self, file_id):
574
# files that have been deleted are excluded
576
if not inv.has_id(file_id):
578
path = inv.id2path(file_id)
579
return osutils.lexists(self.abspath(path))
581
def has_or_had_id(self, file_id):
582
if file_id == self.inventory.root.file_id:
584
return self.inventory.has_id(file_id)
586
__contains__ = has_id
588
def get_file_size(self, file_id):
589
return os.path.getsize(self.id2abspath(file_id))
592
def get_file_sha1(self, file_id, path=None, stat_value=None):
594
path = self._inventory.id2path(file_id)
595
return self._hashcache.get_sha1(path, stat_value)
597
def get_file_mtime(self, file_id, path=None):
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
return self._inventory[file_id].executable
606
def is_executable(self, file_id, path=None):
608
path = self.id2path(file_id)
609
mode = os.lstat(self.abspath(path)).st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
612
@needs_tree_write_lock
613
def _add(self, files, ids, kinds):
614
"""See MutableTree._add."""
615
# TODO: Re-adding a file that is removed in the working copy
616
# should probably put it back with the previous ID.
617
# the read and write working inventory should not occur in this
618
# function - they should be part of lock_write and unlock.
620
for f, file_id, kind in zip(files, ids, kinds):
621
assert kind is not None
623
inv.add_path(f, kind=kind)
625
inv.add_path(f, kind=kind, file_id=file_id)
626
self._inventory_is_modified = True
628
@needs_tree_write_lock
629
def _gather_kinds(self, files, kinds):
630
"""See MutableTree._gather_kinds."""
631
for pos, f in enumerate(files):
632
if kinds[pos] is None:
633
fullpath = normpath(self.abspath(f))
635
kinds[pos] = file_kind(fullpath)
637
if e.errno == errno.ENOENT:
638
raise errors.NoSuchFile(fullpath)
641
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
642
"""Add revision_id as a parent.
644
This is equivalent to retrieving the current list of parent ids
645
and setting the list to its value plus revision_id.
647
:param revision_id: The revision id to add to the parent list. It may
648
be a ghost revision as long as its not the first parent to be added,
649
or the allow_leftmost_as_ghost parameter is set True.
650
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
parents = self.get_parent_ids() + [revision_id]
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
654
or allow_leftmost_as_ghost)
656
@needs_tree_write_lock
657
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
658
"""Add revision_id, tree tuple as a parent.
660
This is equivalent to retrieving the current list of parent trees
661
and setting the list to its value plus parent_tuple. See also
662
add_parent_tree_id - if you only have a parent id available it will be
663
simpler to use that api. If you have the parent already available, using
664
this api is preferred.
666
:param parent_tuple: The (revision id, tree) to add to the parent list.
667
If the revision_id is a ghost, pass None for the tree.
668
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
671
if len(parent_ids) > 1:
672
# the leftmost may have already been a ghost, preserve that if it
674
allow_leftmost_as_ghost = True
675
self.set_parent_ids(parent_ids,
676
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
678
@needs_tree_write_lock
679
def add_pending_merge(self, *revision_ids):
680
# TODO: Perhaps should check at this point that the
681
# history of the revision is actually present?
682
parents = self.get_parent_ids()
684
for rev_id in revision_ids:
685
if rev_id in parents:
687
parents.append(rev_id)
690
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
692
def path_content_summary(self, path, _lstat=osutils.lstat,
693
_mapper=osutils.file_kind_from_stat_mode):
694
"""See Tree.path_content_summary."""
695
abspath = self.abspath(path)
697
stat_result = _lstat(abspath)
699
if getattr(e, 'errno', None) == errno.ENOENT:
701
return ('missing', None, None, None)
702
# propagate other errors
704
kind = _mapper(stat_result.st_mode)
706
size = stat_result.st_size
707
# try for a stat cache lookup
708
if not supports_executable():
709
executable = None # caller can decide policy.
711
mode = stat_result.st_mode
712
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
713
return (kind, size, executable, self._sha_from_stat(
715
elif kind == 'directory':
716
# perhaps it looks like a plain directory, but it's really a
718
if self._directory_is_tree_reference(path):
719
kind = 'tree-reference'
720
return kind, None, None, None
721
elif kind == 'symlink':
722
return ('symlink', None, None, os.readlink(abspath))
724
return (kind, None, None, None)
726
@deprecated_method(zero_eleven)
728
def pending_merges(self):
729
"""Return a list of pending merges.
731
These are revisions that have been merged into the working
732
directory but not yet committed.
734
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
735
instead - which is available on all tree objects.
737
return self.get_parent_ids()[1:]
739
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
740
"""Common ghost checking functionality from set_parent_*.
742
This checks that the left hand-parent exists if there are any
745
if len(revision_ids) > 0:
746
leftmost_id = revision_ids[0]
747
if (not allow_leftmost_as_ghost and not
748
self.branch.repository.has_revision(leftmost_id)):
749
raise errors.GhostRevisionUnusableHere(leftmost_id)
751
def _set_merges_from_parent_ids(self, parent_ids):
752
merges = parent_ids[1:]
753
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
755
@needs_tree_write_lock
756
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
757
"""Set the parent ids to revision_ids.
759
See also set_parent_trees. This api will try to retrieve the tree data
760
for each element of revision_ids from the trees repository. If you have
761
tree data already available, it is more efficient to use
762
set_parent_trees rather than set_parent_ids. set_parent_ids is however
763
an easier API to use.
765
:param revision_ids: The revision_ids to set as the parent ids of this
766
working tree. Any of these may be ghosts.
768
self._check_parents_for_ghosts(revision_ids,
769
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
770
for revision_id in revision_ids:
771
_mod_revision.check_not_reserved_id(revision_id)
773
if len(revision_ids) > 0:
774
self.set_last_revision(revision_ids[0])
776
self.set_last_revision(_mod_revision.NULL_REVISION)
778
self._set_merges_from_parent_ids(revision_ids)
780
@needs_tree_write_lock
781
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
782
"""See MutableTree.set_parent_trees."""
783
parent_ids = [rev for (rev, tree) in parents_list]
784
for revision_id in parent_ids:
785
_mod_revision.check_not_reserved_id(revision_id)
787
self._check_parents_for_ghosts(parent_ids,
788
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
790
if len(parent_ids) == 0:
791
leftmost_parent_id = _mod_revision.NULL_REVISION
792
leftmost_parent_tree = None
794
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
796
if self._change_last_revision(leftmost_parent_id):
797
if leftmost_parent_tree is None:
798
# If we don't have a tree, fall back to reading the
799
# parent tree from the repository.
800
self._cache_basis_inventory(leftmost_parent_id)
802
inv = leftmost_parent_tree.inventory
803
xml = self._create_basis_xml_from_inventory(
804
leftmost_parent_id, inv)
805
self._write_basis_inventory(xml)
806
self._set_merges_from_parent_ids(parent_ids)
808
@needs_tree_write_lock
809
def set_pending_merges(self, rev_list):
810
parents = self.get_parent_ids()
811
leftmost = parents[:1]
812
new_parents = leftmost + rev_list
813
self.set_parent_ids(new_parents)
815
@needs_tree_write_lock
816
def set_merge_modified(self, modified_hashes):
818
for file_id, hash in modified_hashes.iteritems():
819
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
820
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
822
def _sha_from_stat(self, path, stat_result):
823
"""Get a sha digest from the tree's stat cache.
825
The default implementation assumes no stat cache is present.
827
:param path: The path.
828
:param stat_result: The stat result being looked up.
832
def _put_rio(self, filename, stanzas, header):
833
self._must_be_locked()
834
my_file = rio_file(stanzas, header)
835
self._control_files.put(filename, my_file)
837
@needs_write_lock # because merge pulls data into the branch.
838
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
840
"""Merge from a branch into this working tree.
842
:param branch: The branch to merge from.
843
:param to_revision: If non-None, the merge will merge to to_revision,
844
but not beyond it. to_revision does not need to be in the history
845
of the branch when it is supplied. If None, to_revision defaults to
846
branch.last_revision().
848
from bzrlib.merge import Merger, Merge3Merger
849
pb = bzrlib.ui.ui_factory.nested_progress_bar()
851
merger = Merger(self.branch, this_tree=self, pb=pb)
852
merger.pp = ProgressPhase("Merge phase", 5, pb)
853
merger.pp.next_phase()
854
# check that there are no
856
merger.check_basis(check_clean=True, require_commits=False)
857
if to_revision is None:
858
to_revision = _mod_revision.ensure_null(branch.last_revision())
859
merger.other_rev_id = to_revision
860
if _mod_revision.is_null(merger.other_rev_id):
861
raise errors.NoCommits(branch)
862
self.branch.fetch(branch, last_revision=merger.other_rev_id)
863
merger.other_basis = merger.other_rev_id
864
merger.other_tree = self.branch.repository.revision_tree(
866
merger.other_branch = branch
867
merger.pp.next_phase()
868
if from_revision is None:
871
merger.set_base_revision(from_revision, branch)
872
if merger.base_rev_id == merger.other_rev_id:
873
raise errors.PointlessMerge
874
merger.backup_files = False
875
if merge_type is None:
876
merger.merge_type = Merge3Merger
878
merger.merge_type = merge_type
879
merger.set_interesting_files(None)
880
merger.show_base = False
881
merger.reprocess = False
882
conflicts = merger.do_merge()
889
def merge_modified(self):
890
"""Return a dictionary of files modified by a merge.
892
The list is initialized by WorkingTree.set_merge_modified, which is
893
typically called after we make some automatic updates to the tree
896
This returns a map of file_id->sha1, containing only files which are
897
still in the working inventory and have that text hash.
900
hashfile = self._control_files.get('merge-hashes')
901
except errors.NoSuchFile:
905
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
906
raise errors.MergeModifiedFormatError()
907
except StopIteration:
908
raise errors.MergeModifiedFormatError()
909
for s in RioReader(hashfile):
910
# RioReader reads in Unicode, so convert file_ids back to utf8
911
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
912
if file_id not in self.inventory:
914
text_hash = s.get("hash")
915
if text_hash == self.get_file_sha1(file_id):
916
merge_hashes[file_id] = text_hash
920
def mkdir(self, path, file_id=None):
921
"""See MutableTree.mkdir()."""
923
file_id = generate_ids.gen_file_id(os.path.basename(path))
924
os.mkdir(self.abspath(path))
925
self.add(path, file_id, 'directory')
928
def get_symlink_target(self, file_id):
929
return os.readlink(self.id2abspath(file_id))
932
def subsume(self, other_tree):
933
def add_children(inventory, entry):
934
for child_entry in entry.children.values():
935
inventory._byid[child_entry.file_id] = child_entry
936
if child_entry.kind == 'directory':
937
add_children(inventory, child_entry)
938
if other_tree.get_root_id() == self.get_root_id():
939
raise errors.BadSubsumeSource(self, other_tree,
940
'Trees have the same root')
942
other_tree_path = self.relpath(other_tree.basedir)
943
except errors.PathNotChild:
944
raise errors.BadSubsumeSource(self, other_tree,
945
'Tree is not contained by the other')
946
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
947
if new_root_parent is None:
948
raise errors.BadSubsumeSource(self, other_tree,
949
'Parent directory is not versioned.')
950
# We need to ensure that the result of a fetch will have a
951
# versionedfile for the other_tree root, and only fetching into
952
# RepositoryKnit2 guarantees that.
953
if not self.branch.repository.supports_rich_root():
954
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
955
other_tree.lock_tree_write()
957
new_parents = other_tree.get_parent_ids()
958
other_root = other_tree.inventory.root
959
other_root.parent_id = new_root_parent
960
other_root.name = osutils.basename(other_tree_path)
961
self.inventory.add(other_root)
962
add_children(self.inventory, other_root)
963
self._write_inventory(self.inventory)
964
# normally we don't want to fetch whole repositories, but i think
965
# here we really do want to consolidate the whole thing.
966
for parent_id in other_tree.get_parent_ids():
967
self.branch.fetch(other_tree.branch, parent_id)
968
self.add_parent_tree_id(parent_id)
971
other_tree.bzrdir.retire_bzrdir()
973
def _directory_is_tree_reference(self, relpath):
974
# as a special case, if a directory contains control files then
975
# it's a tree reference, except that the root of the tree is not
976
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
977
# TODO: We could ask all the control formats whether they
978
# recognize this directory, but at the moment there's no cheap api
979
# to do that. Since we probably can only nest bzr checkouts and
980
# they always use this name it's ok for now. -- mbp 20060306
982
# FIXME: There is an unhandled case here of a subdirectory
983
# containing .bzr but not a branch; that will probably blow up
984
# when you try to commit it. It might happen if there is a
985
# checkout in a subdirectory. This can be avoided by not adding
988
@needs_tree_write_lock
989
def extract(self, file_id, format=None):
990
"""Extract a subtree from this tree.
992
A new branch will be created, relative to the path for this tree.
996
segments = osutils.splitpath(path)
997
transport = self.branch.bzrdir.root_transport
998
for name in segments:
999
transport = transport.clone(name)
1000
transport.ensure_base()
1003
sub_path = self.id2path(file_id)
1004
branch_transport = mkdirs(sub_path)
1006
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1007
branch_transport.ensure_base()
1008
branch_bzrdir = format.initialize_on_transport(branch_transport)
1010
repo = branch_bzrdir.find_repository()
1011
except errors.NoRepositoryPresent:
1012
repo = branch_bzrdir.create_repository()
1013
assert repo.supports_rich_root()
1015
if not repo.supports_rich_root():
1016
raise errors.RootNotRich()
1017
new_branch = branch_bzrdir.create_branch()
1018
new_branch.pull(self.branch)
1019
for parent_id in self.get_parent_ids():
1020
new_branch.fetch(self.branch, parent_id)
1021
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1022
if tree_transport.base != branch_transport.base:
1023
tree_bzrdir = format.initialize_on_transport(tree_transport)
1024
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1026
tree_bzrdir = branch_bzrdir
1027
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1028
wt.set_parent_ids(self.get_parent_ids())
1029
my_inv = self.inventory
1030
child_inv = Inventory(root_id=None)
1031
new_root = my_inv[file_id]
1032
my_inv.remove_recursive_id(file_id)
1033
new_root.parent_id = None
1034
child_inv.add(new_root)
1035
self._write_inventory(my_inv)
1036
wt._write_inventory(child_inv)
1039
def _serialize(self, inventory, out_file):
1040
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1043
def _deserialize(selt, in_file):
1044
return xml5.serializer_v5.read_inventory(in_file)
1047
"""Write the in memory inventory to disk."""
1048
# TODO: Maybe this should only write on dirty ?
1049
if self._control_files._lock_mode != 'w':
1050
raise errors.NotWriteLocked(self)
1052
self._serialize(self._inventory, sio)
1054
self._control_files.put('inventory', sio)
1055
self._inventory_is_modified = False
1057
def _kind(self, relpath):
1058
return osutils.file_kind(self.abspath(relpath))
1060
def list_files(self, include_root=False):
1061
"""Recursively list all files as (path, class, kind, id, entry).
1063
Lists, but does not descend into unversioned directories.
1065
This does not include files that have been deleted in this
1068
Skips the control directory.
1070
# list_files is an iterator, so @needs_read_lock doesn't work properly
1071
# with it. So callers should be careful to always read_lock the tree.
1072
if not self.is_locked():
1073
raise errors.ObjectNotLocked(self)
1075
inv = self.inventory
1076
if include_root is True:
1077
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1078
# Convert these into local objects to save lookup times
1079
pathjoin = osutils.pathjoin
1080
file_kind = self._kind
1082
# transport.base ends in a slash, we want the piece
1083
# between the last two slashes
1084
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1086
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1088
# directory file_id, relative path, absolute path, reverse sorted children
1089
children = os.listdir(self.basedir)
1091
# jam 20060527 The kernel sized tree seems equivalent whether we
1092
# use a deque and popleft to keep them sorted, or if we use a plain
1093
# list and just reverse() them.
1094
children = collections.deque(children)
1095
stack = [(inv.root.file_id, u'', self.basedir, children)]
1097
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1100
f = children.popleft()
1101
## TODO: If we find a subdirectory with its own .bzr
1102
## directory, then that is a separate tree and we
1103
## should exclude it.
1105
# the bzrdir for this tree
1106
if transport_base_dir == f:
1109
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1110
# and 'f' doesn't begin with one, we can do a string op, rather
1111
# than the checks of pathjoin(), all relative paths will have an extra slash
1113
fp = from_dir_relpath + '/' + f
1116
fap = from_dir_abspath + '/' + f
1118
f_ie = inv.get_child(from_dir_id, f)
1121
elif self.is_ignored(fp[1:]):
1124
# we may not have found this file, because of a unicode issue
1125
f_norm, can_access = osutils.normalized_filename(f)
1126
if f == f_norm or not can_access:
1127
# No change, so treat this file normally
1130
# this file can be accessed by a normalized path
1131
# check again if it is versioned
1132
# these lines are repeated here for performance
1134
fp = from_dir_relpath + '/' + f
1135
fap = from_dir_abspath + '/' + f
1136
f_ie = inv.get_child(from_dir_id, f)
1139
elif self.is_ignored(fp[1:]):
1146
# make a last minute entry
1148
yield fp[1:], c, fk, f_ie.file_id, f_ie
1151
yield fp[1:], c, fk, None, fk_entries[fk]()
1153
yield fp[1:], c, fk, None, TreeEntry()
1156
if fk != 'directory':
1159
# But do this child first
1160
new_children = os.listdir(fap)
1162
new_children = collections.deque(new_children)
1163
stack.append((f_ie.file_id, fp, fap, new_children))
1164
# Break out of inner loop,
1165
# so that we start outer loop with child
1168
# if we finished all children, pop it off the stack
1171
@needs_tree_write_lock
1172
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1175
to_dir must exist in the inventory.
1177
If to_dir exists and is a directory, the files are moved into
1178
it, keeping their old names.
1180
Note that to_dir is only the last component of the new name;
1181
this doesn't change the directory.
1183
For each entry in from_paths the move mode will be determined
1186
The first mode moves the file in the filesystem and updates the
1187
inventory. The second mode only updates the inventory without
1188
touching the file on the filesystem. This is the new mode introduced
1191
move uses the second mode if 'after == True' and the target is not
1192
versioned but present in the working tree.
1194
move uses the second mode if 'after == False' and the source is
1195
versioned but no longer in the working tree, and the target is not
1196
versioned but present in the working tree.
1198
move uses the first mode if 'after == False' and the source is
1199
versioned and present in the working tree, and the target is not
1200
versioned and not present in the working tree.
1202
Everything else results in an error.
1204
This returns a list of (from_path, to_path) pairs for each
1205
entry that is moved.
1210
# check for deprecated use of signature
1212
to_dir = kwargs.get('to_name', None)
1214
raise TypeError('You must supply a target directory')
1216
symbol_versioning.warn('The parameter to_name was deprecated'
1217
' in version 0.13. Use to_dir instead',
1220
# check destination directory
1221
assert not isinstance(from_paths, basestring)
1222
inv = self.inventory
1223
to_abs = self.abspath(to_dir)
1224
if not isdir(to_abs):
1225
raise errors.BzrMoveFailedError('',to_dir,
1226
errors.NotADirectory(to_abs))
1227
if not self.has_filename(to_dir):
1228
raise errors.BzrMoveFailedError('',to_dir,
1229
errors.NotInWorkingDirectory(to_dir))
1230
to_dir_id = inv.path2id(to_dir)
1231
if to_dir_id is None:
1232
raise errors.BzrMoveFailedError('',to_dir,
1233
errors.NotVersionedError(path=str(to_dir)))
1235
to_dir_ie = inv[to_dir_id]
1236
if to_dir_ie.kind != 'directory':
1237
raise errors.BzrMoveFailedError('',to_dir,
1238
errors.NotADirectory(to_abs))
1240
# create rename entries and tuples
1241
for from_rel in from_paths:
1242
from_tail = splitpath(from_rel)[-1]
1243
from_id = inv.path2id(from_rel)
1245
raise errors.BzrMoveFailedError(from_rel,to_dir,
1246
errors.NotVersionedError(path=str(from_rel)))
1248
from_entry = inv[from_id]
1249
from_parent_id = from_entry.parent_id
1250
to_rel = pathjoin(to_dir, from_tail)
1251
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1253
from_tail=from_tail,
1254
from_parent_id=from_parent_id,
1255
to_rel=to_rel, to_tail=from_tail,
1256
to_parent_id=to_dir_id)
1257
rename_entries.append(rename_entry)
1258
rename_tuples.append((from_rel, to_rel))
1260
# determine which move mode to use. checks also for movability
1261
rename_entries = self._determine_mv_mode(rename_entries, after)
1263
original_modified = self._inventory_is_modified
1266
self._inventory_is_modified = True
1267
self._move(rename_entries)
1269
# restore the inventory on error
1270
self._inventory_is_modified = original_modified
1272
self._write_inventory(inv)
1273
return rename_tuples
1275
def _determine_mv_mode(self, rename_entries, after=False):
1276
"""Determines for each from-to pair if both inventory and working tree
1277
or only the inventory has to be changed.
1279
Also does basic plausability tests.
1281
inv = self.inventory
1283
for rename_entry in rename_entries:
1284
# store to local variables for easier reference
1285
from_rel = rename_entry.from_rel
1286
from_id = rename_entry.from_id
1287
to_rel = rename_entry.to_rel
1288
to_id = inv.path2id(to_rel)
1289
only_change_inv = False
1291
# check the inventory for source and destination
1293
raise errors.BzrMoveFailedError(from_rel,to_rel,
1294
errors.NotVersionedError(path=str(from_rel)))
1295
if to_id is not None:
1296
raise errors.BzrMoveFailedError(from_rel,to_rel,
1297
errors.AlreadyVersionedError(path=str(to_rel)))
1299
# try to determine the mode for rename (only change inv or change
1300
# inv and file system)
1302
if not self.has_filename(to_rel):
1303
raise errors.BzrMoveFailedError(from_id,to_rel,
1304
errors.NoSuchFile(path=str(to_rel),
1305
extra="New file has not been created yet"))
1306
only_change_inv = True
1307
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1308
only_change_inv = True
1309
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1310
only_change_inv = False
1312
# something is wrong, so lets determine what exactly
1313
if not self.has_filename(from_rel) and \
1314
not self.has_filename(to_rel):
1315
raise errors.BzrRenameFailedError(from_rel,to_rel,
1316
errors.PathsDoNotExist(paths=(str(from_rel),
1319
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1320
extra="(Use --after to update the Bazaar id)")
1321
rename_entry.only_change_inv = only_change_inv
1322
return rename_entries
1324
def _move(self, rename_entries):
1325
"""Moves a list of files.
1327
Depending on the value of the flag 'only_change_inv', the
1328
file will be moved on the file system or not.
1330
inv = self.inventory
1333
for entry in rename_entries:
1335
self._move_entry(entry)
1337
self._rollback_move(moved)
1341
def _rollback_move(self, moved):
1342
"""Try to rollback a previous move in case of an filesystem error."""
1343
inv = self.inventory
1346
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1347
entry.to_tail, entry.to_parent_id, entry.from_rel,
1348
entry.from_tail, entry.from_parent_id,
1349
entry.only_change_inv))
1350
except errors.BzrMoveFailedError, e:
1351
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1352
" The working tree is in an inconsistent state."
1353
" Please consider doing a 'bzr revert'."
1354
" Error message is: %s" % e)
1356
def _move_entry(self, entry):
1357
inv = self.inventory
1358
from_rel_abs = self.abspath(entry.from_rel)
1359
to_rel_abs = self.abspath(entry.to_rel)
1360
if from_rel_abs == to_rel_abs:
1361
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1362
"Source and target are identical.")
1364
if not entry.only_change_inv:
1366
osutils.rename(from_rel_abs, to_rel_abs)
1368
raise errors.BzrMoveFailedError(entry.from_rel,
1370
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1372
@needs_tree_write_lock
1373
def rename_one(self, from_rel, to_rel, after=False):
1376
This can change the directory or the filename or both.
1378
rename_one has several 'modes' to work. First, it can rename a physical
1379
file and change the file_id. That is the normal mode. Second, it can
1380
only change the file_id without touching any physical file. This is
1381
the new mode introduced in version 0.15.
1383
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1384
versioned but present in the working tree.
1386
rename_one uses the second mode if 'after == False' and 'from_rel' is
1387
versioned but no longer in the working tree, and 'to_rel' is not
1388
versioned but present in the working tree.
1390
rename_one uses the first mode if 'after == False' and 'from_rel' is
1391
versioned and present in the working tree, and 'to_rel' is not
1392
versioned and not present in the working tree.
1394
Everything else results in an error.
1396
inv = self.inventory
1399
# create rename entries and tuples
1400
from_tail = splitpath(from_rel)[-1]
1401
from_id = inv.path2id(from_rel)
1403
raise errors.BzrRenameFailedError(from_rel,to_rel,
1404
errors.NotVersionedError(path=str(from_rel)))
1405
from_entry = inv[from_id]
1406
from_parent_id = from_entry.parent_id
1407
to_dir, to_tail = os.path.split(to_rel)
1408
to_dir_id = inv.path2id(to_dir)
1409
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1411
from_tail=from_tail,
1412
from_parent_id=from_parent_id,
1413
to_rel=to_rel, to_tail=to_tail,
1414
to_parent_id=to_dir_id)
1415
rename_entries.append(rename_entry)
1417
# determine which move mode to use. checks also for movability
1418
rename_entries = self._determine_mv_mode(rename_entries, after)
1420
# check if the target changed directory and if the target directory is
1422
if to_dir_id is None:
1423
raise errors.BzrMoveFailedError(from_rel,to_rel,
1424
errors.NotVersionedError(path=str(to_dir)))
1426
# all checks done. now we can continue with our actual work
1427
mutter('rename_one:\n'
1432
' to_dir_id {%s}\n',
1433
from_id, from_rel, to_rel, to_dir, to_dir_id)
1435
self._move(rename_entries)
1436
self._write_inventory(inv)
1438
class _RenameEntry(object):
1439
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1440
to_rel, to_tail, to_parent_id, only_change_inv=False):
1441
self.from_rel = from_rel
1442
self.from_id = from_id
1443
self.from_tail = from_tail
1444
self.from_parent_id = from_parent_id
1445
self.to_rel = to_rel
1446
self.to_tail = to_tail
1447
self.to_parent_id = to_parent_id
1448
self.only_change_inv = only_change_inv
1452
"""Return all unknown files.
1454
These are files in the working directory that are not versioned or
1455
control files or ignored.
1457
# force the extras method to be fully executed before returning, to
1458
# prevent race conditions with the lock
1460
[subp for subp in self.extras() if not self.is_ignored(subp)])
1462
@needs_tree_write_lock
1463
def unversion(self, file_ids):
1464
"""Remove the file ids in file_ids from the current versioned set.
1466
When a file_id is unversioned, all of its children are automatically
1469
:param file_ids: The file ids to stop versioning.
1470
:raises: NoSuchId if any fileid is not currently versioned.
1472
for file_id in file_ids:
1473
if self._inventory.has_id(file_id):
1474
self._inventory.remove_recursive_id(file_id)
1476
raise errors.NoSuchId(self, file_id)
1478
# in the future this should just set a dirty bit to wait for the
1479
# final unlock. However, until all methods of workingtree start
1480
# with the current in -memory inventory rather than triggering
1481
# a read, it is more complex - we need to teach read_inventory
1482
# to know when to read, and when to not read first... and possibly
1483
# to save first when the in memory one may be corrupted.
1484
# so for now, we just only write it if it is indeed dirty.
1486
self._write_inventory(self._inventory)
1488
@deprecated_method(zero_eight)
1489
def iter_conflicts(self):
1490
"""List all files in the tree that have text or content conflicts.
1491
DEPRECATED. Use conflicts instead."""
1492
return self._iter_conflicts()
1494
def _iter_conflicts(self):
1496
for info in self.list_files():
1498
stem = get_conflicted_stem(path)
1501
if stem not in conflicted:
1502
conflicted.add(stem)
1506
def pull(self, source, overwrite=False, stop_revision=None,
1507
change_reporter=None, possible_transports=None):
1508
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1511
pp = ProgressPhase("Pull phase", 2, top_pb)
1513
old_revision_info = self.branch.last_revision_info()
1514
basis_tree = self.basis_tree()
1515
count = self.branch.pull(source, overwrite, stop_revision,
1516
possible_transports=possible_transports)
1517
new_revision_info = self.branch.last_revision_info()
1518
if new_revision_info != old_revision_info:
1520
repository = self.branch.repository
1521
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1522
basis_tree.lock_read()
1524
new_basis_tree = self.branch.basis_tree()
1531
change_reporter=change_reporter)
1532
if (basis_tree.inventory.root is None and
1533
new_basis_tree.inventory.root is not None):
1534
self.set_root_id(new_basis_tree.inventory.root.file_id)
1538
# TODO - dedup parents list with things merged by pull ?
1539
# reuse the revisiontree we merged against to set the new
1541
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1542
# we have to pull the merge trees out again, because
1543
# merge_inner has set the ids. - this corner is not yet
1544
# layered well enough to prevent double handling.
1545
# XXX TODO: Fix the double handling: telling the tree about
1546
# the already known parent data is wasteful.
1547
merges = self.get_parent_ids()[1:]
1548
parent_trees.extend([
1549
(parent, repository.revision_tree(parent)) for
1551
self.set_parent_trees(parent_trees)
1558
def put_file_bytes_non_atomic(self, file_id, bytes):
1559
"""See MutableTree.put_file_bytes_non_atomic."""
1560
stream = file(self.id2abspath(file_id), 'wb')
1565
# TODO: update the hashcache here ?
1568
"""Yield all unversioned files in this WorkingTree.
1570
If there are any unversioned directories then only the directory is
1571
returned, not all its children. But if there are unversioned files
1572
under a versioned subdirectory, they are returned.
1574
Currently returned depth-first, sorted by name within directories.
1575
This is the same order used by 'osutils.walkdirs'.
1577
## TODO: Work from given directory downwards
1578
for path, dir_entry in self.inventory.directories():
1579
# mutter("search for unknowns in %r", path)
1580
dirabs = self.abspath(path)
1581
if not isdir(dirabs):
1582
# e.g. directory deleted
1586
for subf in os.listdir(dirabs):
1589
if subf not in dir_entry.children:
1590
subf_norm, can_access = osutils.normalized_filename(subf)
1591
if subf_norm != subf and can_access:
1592
if subf_norm not in dir_entry.children:
1593
fl.append(subf_norm)
1599
subp = pathjoin(path, subf)
1602
def ignored_files(self):
1603
"""Yield list of PATH, IGNORE_PATTERN"""
1604
for subp in self.extras():
1605
pat = self.is_ignored(subp)
1609
def get_ignore_list(self):
1610
"""Return list of ignore patterns.
1612
Cached in the Tree object after the first call.
1614
ignoreset = getattr(self, '_ignoreset', None)
1615
if ignoreset is not None:
1618
ignore_globs = set()
1619
ignore_globs.update(ignores.get_runtime_ignores())
1620
ignore_globs.update(ignores.get_user_ignores())
1621
if self.has_filename(bzrlib.IGNORE_FILENAME):
1622
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1624
ignore_globs.update(ignores.parse_ignore_file(f))
1627
self._ignoreset = ignore_globs
1630
def _flush_ignore_list_cache(self):
1631
"""Resets the cached ignore list to force a cache rebuild."""
1632
self._ignoreset = None
1633
self._ignoreglobster = None
1635
def is_ignored(self, filename):
1636
r"""Check whether the filename matches an ignore pattern.
1638
Patterns containing '/' or '\' need to match the whole path;
1639
others match against only the last component.
1641
If the file is ignored, returns the pattern which caused it to
1642
be ignored, otherwise None. So this can simply be used as a
1643
boolean if desired."""
1644
if getattr(self, '_ignoreglobster', None) is None:
1645
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1646
return self._ignoreglobster.match(filename)
1648
def kind(self, file_id):
1649
return file_kind(self.id2abspath(file_id))
1651
def _comparison_data(self, entry, path):
1652
abspath = self.abspath(path)
1654
stat_value = os.lstat(abspath)
1656
if getattr(e, 'errno', None) == errno.ENOENT:
1663
mode = stat_value.st_mode
1664
kind = osutils.file_kind_from_stat_mode(mode)
1665
if not supports_executable():
1666
executable = entry is not None and entry.executable
1668
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1669
return kind, executable, stat_value
1671
def _file_size(self, entry, stat_value):
1672
return stat_value.st_size
1674
def last_revision(self):
1675
"""Return the last revision of the branch for this tree.
1677
This format tree does not support a separate marker for last-revision
1678
compared to the branch.
1680
See MutableTree.last_revision
1682
return self._last_revision()
1685
def _last_revision(self):
1686
"""helper for get_parent_ids."""
1687
return _mod_revision.ensure_null(self.branch.last_revision())
1689
def is_locked(self):
1690
return self._control_files.is_locked()
1692
def _must_be_locked(self):
1693
if not self.is_locked():
1694
raise errors.ObjectNotLocked(self)
1696
def lock_read(self):
1697
"""See Branch.lock_read, and WorkingTree.unlock."""
1698
if not self.is_locked():
1700
self.branch.lock_read()
1702
return self._control_files.lock_read()
1704
self.branch.unlock()
1707
def lock_tree_write(self):
1708
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1709
if not self.is_locked():
1711
self.branch.lock_read()
1713
return self._control_files.lock_write()
1715
self.branch.unlock()
1718
def lock_write(self):
1719
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1720
if not self.is_locked():
1722
self.branch.lock_write()
1724
return self._control_files.lock_write()
1726
self.branch.unlock()
1729
def get_physical_lock_status(self):
1730
return self._control_files.get_physical_lock_status()
1732
def _basis_inventory_name(self):
1733
return 'basis-inventory-cache'
1735
def _reset_data(self):
1736
"""Reset transient data that cannot be revalidated."""
1737
self._inventory_is_modified = False
1738
result = self._deserialize(self._control_files.get('inventory'))
1739
self._set_inventory(result, dirty=False)
1741
@needs_tree_write_lock
1742
def set_last_revision(self, new_revision):
1743
"""Change the last revision in the working tree."""
1744
if self._change_last_revision(new_revision):
1745
self._cache_basis_inventory(new_revision)
1747
def _change_last_revision(self, new_revision):
1748
"""Template method part of set_last_revision to perform the change.
1750
This is used to allow WorkingTree3 instances to not affect branch
1751
when their last revision is set.
1753
if _mod_revision.is_null(new_revision):
1754
self.branch.set_revision_history([])
1757
self.branch.generate_revision_history(new_revision)
1758
except errors.NoSuchRevision:
1759
# not present in the repo - dont try to set it deeper than the tip
1760
self.branch.set_revision_history([new_revision])
1763
def _write_basis_inventory(self, xml):
1764
"""Write the basis inventory XML to the basis-inventory file"""
1765
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1766
path = self._basis_inventory_name()
1768
self._control_files.put(path, sio)
1770
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1771
"""Create the text that will be saved in basis-inventory"""
1772
inventory.revision_id = revision_id
1773
return xml7.serializer_v7.write_inventory_to_string(inventory)
1775
def _cache_basis_inventory(self, new_revision):
1776
"""Cache new_revision as the basis inventory."""
1777
# TODO: this should allow the ready-to-use inventory to be passed in,
1778
# as commit already has that ready-to-use [while the format is the
1781
# this double handles the inventory - unpack and repack -
1782
# but is easier to understand. We can/should put a conditional
1783
# in here based on whether the inventory is in the latest format
1784
# - perhaps we should repack all inventories on a repository
1786
# the fast path is to copy the raw xml from the repository. If the
1787
# xml contains 'revision_id="', then we assume the right
1788
# revision_id is set. We must check for this full string, because a
1789
# root node id can legitimately look like 'revision_id' but cannot
1791
xml = self.branch.repository.get_inventory_xml(new_revision)
1792
firstline = xml.split('\n', 1)[0]
1793
if (not 'revision_id="' in firstline or
1794
'format="7"' not in firstline):
1795
inv = self.branch.repository.deserialise_inventory(
1797
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1798
self._write_basis_inventory(xml)
1799
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1802
def read_basis_inventory(self):
1803
"""Read the cached basis inventory."""
1804
path = self._basis_inventory_name()
1805
return self._control_files.get(path).read()
1808
def read_working_inventory(self):
1809
"""Read the working inventory.
1811
:raises errors.InventoryModified: read_working_inventory will fail
1812
when the current in memory inventory has been modified.
1814
# conceptually this should be an implementation detail of the tree.
1815
# XXX: Deprecate this.
1816
# ElementTree does its own conversion from UTF-8, so open in
1818
if self._inventory_is_modified:
1819
raise errors.InventoryModified(self)
1820
result = self._deserialize(self._control_files.get('inventory'))
1821
self._set_inventory(result, dirty=False)
1824
@needs_tree_write_lock
1825
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1827
"""Remove nominated files from the working inventory.
1829
:files: File paths relative to the basedir.
1830
:keep_files: If true, the files will also be kept.
1831
:force: Delete files and directories, even if they are changed and
1832
even if the directories are not empty.
1834
if isinstance(files, basestring):
1840
unknown_nested_files=set()
1842
def recurse_directory_to_add_files(directory):
1843
# Recurse directory and add all files
1844
# so we can check if they have changed.
1845
for parent_info, file_infos in\
1846
osutils.walkdirs(self.abspath(directory),
1848
for relpath, basename, kind, lstat, abspath in file_infos:
1849
# Is it versioned or ignored?
1850
if self.path2id(relpath) or self.is_ignored(relpath):
1851
# Add nested content for deletion.
1852
new_files.add(relpath)
1854
# Files which are not versioned and not ignored
1855
# should be treated as unknown.
1856
unknown_nested_files.add((relpath, None, kind))
1858
for filename in files:
1859
# Get file name into canonical form.
1860
abspath = self.abspath(filename)
1861
filename = self.relpath(abspath)
1862
if len(filename) > 0:
1863
new_files.add(filename)
1864
if osutils.isdir(abspath):
1865
recurse_directory_to_add_files(filename)
1867
files = list(new_files)
1870
return # nothing to do
1872
# Sort needed to first handle directory content before the directory
1873
files.sort(reverse=True)
1875
# Bail out if we are going to delete files we shouldn't
1876
if not keep_files and not force:
1877
has_changed_files = len(unknown_nested_files) > 0
1878
if not has_changed_files:
1879
for (file_id, path, content_change, versioned, parent_id, name,
1880
kind, executable) in self._iter_changes(self.basis_tree(),
1881
include_unchanged=True, require_versioned=False,
1882
want_unversioned=True, specific_files=files):
1883
# Check if it's an unknown (but not ignored) OR
1884
# changed (but not deleted) :
1885
if not self.is_ignored(path[1]) and (
1886
versioned == (False, False) or
1887
content_change and kind[1] != None):
1888
has_changed_files = True
1891
if has_changed_files:
1892
# Make delta show ALL applicable changes in error message.
1893
tree_delta = self.changes_from(self.basis_tree(),
1894
require_versioned=False, want_unversioned=True,
1895
specific_files=files)
1896
for unknown_file in unknown_nested_files:
1897
if unknown_file not in tree_delta.unversioned:
1898
tree_delta.unversioned.extend((unknown_file,))
1899
raise errors.BzrRemoveChangedFilesError(tree_delta)
1901
# Build inv_delta and delete files where applicaple,
1902
# do this before any modifications to inventory.
1904
fid = self.path2id(f)
1907
message = "%s is not versioned." % (f,)
1910
# having removed it, it must be either ignored or unknown
1911
if self.is_ignored(f):
1915
textui.show_status(new_status, self.kind(fid), f,
1918
inv_delta.append((f, None, fid, None))
1919
message = "removed %s" % (f,)
1922
abs_path = self.abspath(f)
1923
if osutils.lexists(abs_path):
1924
if (osutils.isdir(abs_path) and
1925
len(os.listdir(abs_path)) > 0):
1927
osutils.rmtree(abs_path)
1929
message = "%s is not an empty directory "\
1930
"and won't be deleted." % (f,)
1932
osutils.delete_any(abs_path)
1933
message = "deleted %s" % (f,)
1934
elif message is not None:
1935
# Only care if we haven't done anything yet.
1936
message = "%s does not exist." % (f,)
1938
# Print only one message (if any) per file.
1939
if message is not None:
1941
self.apply_inventory_delta(inv_delta)
1943
@needs_tree_write_lock
1944
def revert(self, filenames=None, old_tree=None, backups=True,
1945
pb=DummyProgress(), report_changes=False):
1946
from bzrlib.conflicts import resolve
1949
symbol_versioning.warn('Using [] to revert all files is deprecated'
1950
' as of bzr 0.91. Please use None (the default) instead.',
1951
DeprecationWarning, stacklevel=2)
1952
if old_tree is None:
1953
old_tree = self.basis_tree()
1954
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1956
if filenames is None:
1957
self.set_parent_ids(self.get_parent_ids()[:1])
1960
resolve(self, filenames, ignore_misses=True)
1963
def revision_tree(self, revision_id):
1964
"""See Tree.revision_tree.
1966
WorkingTree can supply revision_trees for the basis revision only
1967
because there is only one cached inventory in the bzr directory.
1969
if revision_id == self.last_revision():
1971
xml = self.read_basis_inventory()
1972
except errors.NoSuchFile:
1976
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1977
# dont use the repository revision_tree api because we want
1978
# to supply the inventory.
1979
if inv.revision_id == revision_id:
1980
return revisiontree.RevisionTree(self.branch.repository,
1982
except errors.BadInventoryFormat:
1984
# raise if there was no inventory, or if we read the wrong inventory.
1985
raise errors.NoSuchRevisionInTree(self, revision_id)
1987
# XXX: This method should be deprecated in favour of taking in a proper
1988
# new Inventory object.
1989
@needs_tree_write_lock
1990
def set_inventory(self, new_inventory_list):
1991
from bzrlib.inventory import (Inventory,
1996
inv = Inventory(self.get_root_id())
1997
for path, file_id, parent, kind in new_inventory_list:
1998
name = os.path.basename(path)
2001
# fixme, there should be a factory function inv,add_??
2002
if kind == 'directory':
2003
inv.add(InventoryDirectory(file_id, name, parent))
2004
elif kind == 'file':
2005
inv.add(InventoryFile(file_id, name, parent))
2006
elif kind == 'symlink':
2007
inv.add(InventoryLink(file_id, name, parent))
2009
raise errors.BzrError("unknown kind %r" % kind)
2010
self._write_inventory(inv)
2012
@needs_tree_write_lock
2013
def set_root_id(self, file_id):
2014
"""Set the root id for this tree."""
2017
symbol_versioning.warn(symbol_versioning.zero_twelve
2018
% 'WorkingTree.set_root_id with fileid=None',
2023
file_id = osutils.safe_file_id(file_id)
2024
self._set_root_id(file_id)
2026
def _set_root_id(self, file_id):
2027
"""Set the root id for this tree, in a format specific manner.
2029
:param file_id: The file id to assign to the root. It must not be
2030
present in the current inventory or an error will occur. It must
2031
not be None, but rather a valid file id.
2033
inv = self._inventory
2034
orig_root_id = inv.root.file_id
2035
# TODO: it might be nice to exit early if there was nothing
2036
# to do, saving us from trigger a sync on unlock.
2037
self._inventory_is_modified = True
2038
# we preserve the root inventory entry object, but
2039
# unlinkit from the byid index
2040
del inv._byid[inv.root.file_id]
2041
inv.root.file_id = file_id
2042
# and link it into the index with the new changed id.
2043
inv._byid[inv.root.file_id] = inv.root
2044
# and finally update all children to reference the new id.
2045
# XXX: this should be safe to just look at the root.children
2046
# list, not the WHOLE INVENTORY.
2049
if entry.parent_id == orig_root_id:
2050
entry.parent_id = inv.root.file_id
2053
"""See Branch.unlock.
2055
WorkingTree locking just uses the Branch locking facilities.
2056
This is current because all working trees have an embedded branch
2057
within them. IF in the future, we were to make branch data shareable
2058
between multiple working trees, i.e. via shared storage, then we
2059
would probably want to lock both the local tree, and the branch.
2061
raise NotImplementedError(self.unlock)
2063
def update(self, change_reporter=None, possible_transports=None):
2064
"""Update a working tree along its branch.
2066
This will update the branch if its bound too, which means we have
2067
multiple trees involved:
2069
- The new basis tree of the master.
2070
- The old basis tree of the branch.
2071
- The old basis tree of the working tree.
2072
- The current working tree state.
2074
Pathologically, all three may be different, and non-ancestors of each
2075
other. Conceptually we want to:
2077
- Preserve the wt.basis->wt.state changes
2078
- Transform the wt.basis to the new master basis.
2079
- Apply a merge of the old branch basis to get any 'local' changes from
2081
- Restore the wt.basis->wt.state changes.
2083
There isn't a single operation at the moment to do that, so we:
2084
- Merge current state -> basis tree of the master w.r.t. the old tree
2086
- Do a 'normal' merge of the old branch basis if it is relevant.
2088
if self.branch.get_master_branch(possible_transports) is not None:
2090
update_branch = True
2092
self.lock_tree_write()
2093
update_branch = False
2096
old_tip = self.branch.update(possible_transports)
2099
return self._update_tree(old_tip, change_reporter)
2103
@needs_tree_write_lock
2104
def _update_tree(self, old_tip=None, change_reporter=None):
2105
"""Update a tree to the master branch.
2107
:param old_tip: if supplied, the previous tip revision the branch,
2108
before it was changed to the master branch's tip.
2110
# here if old_tip is not None, it is the old tip of the branch before
2111
# it was updated from the master branch. This should become a pending
2112
# merge in the working tree to preserve the user existing work. we
2113
# cant set that until we update the working trees last revision to be
2114
# one from the new branch, because it will just get absorbed by the
2115
# parent de-duplication logic.
2117
# We MUST save it even if an error occurs, because otherwise the users
2118
# local work is unreferenced and will appear to have been lost.
2122
last_rev = self.get_parent_ids()[0]
2124
last_rev = _mod_revision.NULL_REVISION
2125
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2126
# merge tree state up to new branch tip.
2127
basis = self.basis_tree()
2130
to_tree = self.branch.basis_tree()
2131
if basis.inventory.root is None:
2132
self.set_root_id(to_tree.inventory.root.file_id)
2134
result += merge.merge_inner(
2139
change_reporter=change_reporter)
2142
# TODO - dedup parents list with things merged by pull ?
2143
# reuse the tree we've updated to to set the basis:
2144
parent_trees = [(self.branch.last_revision(), to_tree)]
2145
merges = self.get_parent_ids()[1:]
2146
# Ideally we ask the tree for the trees here, that way the working
2147
# tree can decide whether to give us teh entire tree or give us a
2148
# lazy initialised tree. dirstate for instance will have the trees
2149
# in ram already, whereas a last-revision + basis-inventory tree
2150
# will not, but also does not need them when setting parents.
2151
for parent in merges:
2152
parent_trees.append(
2153
(parent, self.branch.repository.revision_tree(parent)))
2154
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2155
parent_trees.append(
2156
(old_tip, self.branch.repository.revision_tree(old_tip)))
2157
self.set_parent_trees(parent_trees)
2158
last_rev = parent_trees[0][0]
2160
# the working tree had the same last-revision as the master
2161
# branch did. We may still have pivot local work from the local
2162
# branch into old_tip:
2163
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2164
self.add_parent_tree_id(old_tip)
2165
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2166
and old_tip != last_rev):
2167
# our last revision was not the prior branch last revision
2168
# and we have converted that last revision to a pending merge.
2169
# base is somewhere between the branch tip now
2170
# and the now pending merge
2172
# Since we just modified the working tree and inventory, flush out
2173
# the current state, before we modify it again.
2174
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2175
# requires it only because TreeTransform directly munges the
2176
# inventory and calls tree._write_inventory(). Ultimately we
2177
# should be able to remove this extra flush.
2179
graph = self.branch.repository.get_graph()
2180
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2182
base_tree = self.branch.repository.revision_tree(base_rev_id)
2183
other_tree = self.branch.repository.revision_tree(old_tip)
2184
result += merge.merge_inner(
2189
change_reporter=change_reporter)
2192
def _write_hashcache_if_dirty(self):
2193
"""Write out the hashcache if it is dirty."""
2194
if self._hashcache.needs_write:
2196
self._hashcache.write()
2198
if e.errno not in (errno.EPERM, errno.EACCES):
2200
# TODO: jam 20061219 Should this be a warning? A single line
2201
# warning might be sufficient to let the user know what
2203
mutter('Could not write hashcache for %s\nError: %s',
2204
self._hashcache.cache_file_name(), e)
2206
@needs_tree_write_lock
2207
def _write_inventory(self, inv):
2208
"""Write inventory as the current inventory."""
2209
self._set_inventory(inv, dirty=True)
2212
def set_conflicts(self, arg):
2213
raise errors.UnsupportedOperation(self.set_conflicts, self)
2215
def add_conflicts(self, arg):
2216
raise errors.UnsupportedOperation(self.add_conflicts, self)
2219
def conflicts(self):
2220
conflicts = _mod_conflicts.ConflictList()
2221
for conflicted in self._iter_conflicts():
2224
if file_kind(self.abspath(conflicted)) != "file":
2226
except errors.NoSuchFile:
2229
for suffix in ('.THIS', '.OTHER'):
2231
kind = file_kind(self.abspath(conflicted+suffix))
2234
except errors.NoSuchFile:
2238
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2239
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2241
file_id=self.path2id(conflicted)))
2244
def walkdirs(self, prefix=""):
2245
"""Walk the directories of this tree.
2247
returns a generator which yields items in the form:
2248
((curren_directory_path, fileid),
2249
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2252
This API returns a generator, which is only valid during the current
2253
tree transaction - within a single lock_read or lock_write duration.
2255
If the tree is not locked, it may cause an error to be raised,
2256
depending on the tree implementation.
2258
disk_top = self.abspath(prefix)
2259
if disk_top.endswith('/'):
2260
disk_top = disk_top[:-1]
2261
top_strip_len = len(disk_top) + 1
2262
inventory_iterator = self._walkdirs(prefix)
2263
disk_iterator = osutils.walkdirs(disk_top, prefix)
2265
current_disk = disk_iterator.next()
2266
disk_finished = False
2268
if not (e.errno == errno.ENOENT or
2269
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2272
disk_finished = True
2274
current_inv = inventory_iterator.next()
2275
inv_finished = False
2276
except StopIteration:
2279
while not inv_finished or not disk_finished:
2280
if not disk_finished:
2281
# strip out .bzr dirs
2282
if current_disk[0][1][top_strip_len:] == '':
2283
# osutils.walkdirs can be made nicer -
2284
# yield the path-from-prefix rather than the pathjoined
2286
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2287
if current_disk[1][bzrdir_loc][0] == '.bzr':
2288
# we dont yield the contents of, or, .bzr itself.
2289
del current_disk[1][bzrdir_loc]
2291
# everything is unknown
2294
# everything is missing
2297
direction = cmp(current_inv[0][0], current_disk[0][0])
2299
# disk is before inventory - unknown
2300
dirblock = [(relpath, basename, kind, stat, None, None) for
2301
relpath, basename, kind, stat, top_path in current_disk[1]]
2302
yield (current_disk[0][0], None), dirblock
2304
current_disk = disk_iterator.next()
2305
except StopIteration:
2306
disk_finished = True
2308
# inventory is before disk - missing.
2309
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2310
for relpath, basename, dkind, stat, fileid, kind in
2312
yield (current_inv[0][0], current_inv[0][1]), dirblock
2314
current_inv = inventory_iterator.next()
2315
except StopIteration:
2318
# versioned present directory
2319
# merge the inventory and disk data together
2321
for relpath, subiterator in itertools.groupby(sorted(
2322
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2323
path_elements = list(subiterator)
2324
if len(path_elements) == 2:
2325
inv_row, disk_row = path_elements
2326
# versioned, present file
2327
dirblock.append((inv_row[0],
2328
inv_row[1], disk_row[2],
2329
disk_row[3], inv_row[4],
2331
elif len(path_elements[0]) == 5:
2333
dirblock.append((path_elements[0][0],
2334
path_elements[0][1], path_elements[0][2],
2335
path_elements[0][3], None, None))
2336
elif len(path_elements[0]) == 6:
2337
# versioned, absent file.
2338
dirblock.append((path_elements[0][0],
2339
path_elements[0][1], 'unknown', None,
2340
path_elements[0][4], path_elements[0][5]))
2342
raise NotImplementedError('unreachable code')
2343
yield current_inv[0], dirblock
2345
current_inv = inventory_iterator.next()
2346
except StopIteration:
2349
current_disk = disk_iterator.next()
2350
except StopIteration:
2351
disk_finished = True
2353
def _walkdirs(self, prefix=""):
2354
"""Walk the directories of this tree.
2356
:prefix: is used as the directrory to start with.
2357
returns a generator which yields items in the form:
2358
((curren_directory_path, fileid),
2359
[(file1_path, file1_name, file1_kind, None, file1_id,
2362
_directory = 'directory'
2363
# get the root in the inventory
2364
inv = self.inventory
2365
top_id = inv.path2id(prefix)
2369
pending = [(prefix, '', _directory, None, top_id, None)]
2372
currentdir = pending.pop()
2373
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2374
top_id = currentdir[4]
2376
relroot = currentdir[0] + '/'
2379
# FIXME: stash the node in pending
2381
for name, child in entry.sorted_children():
2382
dirblock.append((relroot + name, name, child.kind, None,
2383
child.file_id, child.kind
2385
yield (currentdir[0], entry.file_id), dirblock
2386
# push the user specified dirs from dirblock
2387
for dir in reversed(dirblock):
2388
if dir[2] == _directory:
2391
@needs_tree_write_lock
2392
def auto_resolve(self):
2393
"""Automatically resolve text conflicts according to contents.
2395
Only text conflicts are auto_resolvable. Files with no conflict markers
2396
are considered 'resolved', because bzr always puts conflict markers
2397
into files that have text conflicts. The corresponding .THIS .BASE and
2398
.OTHER files are deleted, as per 'resolve'.
2399
:return: a tuple of ConflictLists: (un_resolved, resolved).
2401
un_resolved = _mod_conflicts.ConflictList()
2402
resolved = _mod_conflicts.ConflictList()
2403
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2404
for conflict in self.conflicts():
2405
if (conflict.typestring != 'text conflict' or
2406
self.kind(conflict.file_id) != 'file'):
2407
un_resolved.append(conflict)
2409
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2411
for line in my_file:
2412
if conflict_re.search(line):
2413
un_resolved.append(conflict)
2416
resolved.append(conflict)
2419
resolved.remove_files(self)
2420
self.set_conflicts(un_resolved)
2421
return un_resolved, resolved
2423
def _validate(self):
2424
"""Validate internal structures.
2426
This is meant mostly for the test suite. To give it a chance to detect
2427
corruption after actions have occurred. The default implementation is a
2430
:return: None. An exception should be raised if there is an error.
2435
class WorkingTree2(WorkingTree):
2436
"""This is the Format 2 working tree.
2438
This was the first weave based working tree.
2439
- uses os locks for locking.
2440
- uses the branch last-revision.
2443
def __init__(self, *args, **kwargs):
2444
super(WorkingTree2, self).__init__(*args, **kwargs)
2445
# WorkingTree2 has more of a constraint that self._inventory must
2446
# exist. Because this is an older format, we don't mind the overhead
2447
# caused by the extra computation here.
2449
# Newer WorkingTree's should only have self._inventory set when they
2451
if self._inventory is None:
2452
self.read_working_inventory()
2454
def lock_tree_write(self):
2455
"""See WorkingTree.lock_tree_write().
2457
In Format2 WorkingTrees we have a single lock for the branch and tree
2458
so lock_tree_write() degrades to lock_write().
2460
self.branch.lock_write()
2462
return self._control_files.lock_write()
2464
self.branch.unlock()
2468
# do non-implementation specific cleanup
2471
# we share control files:
2472
if self._control_files._lock_count == 3:
2473
# _inventory_is_modified is always False during a read lock.
2474
if self._inventory_is_modified:
2476
self._write_hashcache_if_dirty()
2478
# reverse order of locking.
2480
return self._control_files.unlock()
2482
self.branch.unlock()
2485
class WorkingTree3(WorkingTree):
2486
"""This is the Format 3 working tree.
2488
This differs from the base WorkingTree by:
2489
- having its own file lock
2490
- having its own last-revision property.
2492
This is new in bzr 0.8
2496
def _last_revision(self):
2497
"""See Mutable.last_revision."""
2499
return self._control_files.get('last-revision').read()
2500
except errors.NoSuchFile:
2501
return _mod_revision.NULL_REVISION
2503
def _change_last_revision(self, revision_id):
2504
"""See WorkingTree._change_last_revision."""
2505
if revision_id is None or revision_id == NULL_REVISION:
2507
self._control_files._transport.delete('last-revision')
2508
except errors.NoSuchFile:
2512
self._control_files.put_bytes('last-revision', revision_id)
2515
@needs_tree_write_lock
2516
def set_conflicts(self, conflicts):
2517
self._put_rio('conflicts', conflicts.to_stanzas(),
2520
@needs_tree_write_lock
2521
def add_conflicts(self, new_conflicts):
2522
conflict_set = set(self.conflicts())
2523
conflict_set.update(set(list(new_conflicts)))
2524
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2525
key=_mod_conflicts.Conflict.sort_key)))
2528
def conflicts(self):
2530
confile = self._control_files.get('conflicts')
2531
except errors.NoSuchFile:
2532
return _mod_conflicts.ConflictList()
2534
if confile.next() != CONFLICT_HEADER_1 + '\n':
2535
raise errors.ConflictFormatError()
2536
except StopIteration:
2537
raise errors.ConflictFormatError()
2538
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2541
# do non-implementation specific cleanup
2543
if self._control_files._lock_count == 1:
2544
# _inventory_is_modified is always False during a read lock.
2545
if self._inventory_is_modified:
2547
self._write_hashcache_if_dirty()
2548
# reverse order of locking.
2550
return self._control_files.unlock()
2552
self.branch.unlock()
2555
def get_conflicted_stem(path):
2556
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2557
if path.endswith(suffix):
2558
return path[:-len(suffix)]
2561
@deprecated_function(zero_eight)
2562
def is_control_file(filename):
2563
"""See WorkingTree.is_control_filename(filename)."""
2564
## FIXME: better check
2565
filename = normpath(filename)
2566
while filename != '':
2567
head, tail = os.path.split(filename)
2568
## mutter('check %r for control file' % ((head, tail),))
2571
if filename == head:
2577
class WorkingTreeFormat(object):
2578
"""An encapsulation of the initialization and open routines for a format.
2580
Formats provide three things:
2581
* An initialization routine,
2585
Formats are placed in an dict by their format string for reference
2586
during workingtree opening. Its not required that these be instances, they
2587
can be classes themselves with class methods - it simply depends on
2588
whether state is needed for a given format or not.
2590
Once a format is deprecated, just deprecate the initialize and open
2591
methods on the format class. Do not deprecate the object, as the
2592
object will be created every time regardless.
2595
_default_format = None
2596
"""The default format used for new trees."""
2599
"""The known formats."""
2601
requires_rich_root = False
2603
upgrade_recommended = False
2606
def find_format(klass, a_bzrdir):
2607
"""Return the format for the working tree object in a_bzrdir."""
2609
transport = a_bzrdir.get_workingtree_transport(None)
2610
format_string = transport.get("format").read()
2611
return klass._formats[format_string]
2612
except errors.NoSuchFile:
2613
raise errors.NoWorkingTree(base=transport.base)
2615
raise errors.UnknownFormatError(format=format_string)
2617
def __eq__(self, other):
2618
return self.__class__ is other.__class__
2620
def __ne__(self, other):
2621
return not (self == other)
2624
def get_default_format(klass):
2625
"""Return the current default format."""
2626
return klass._default_format
2628
def get_format_string(self):
2629
"""Return the ASCII format string that identifies this format."""
2630
raise NotImplementedError(self.get_format_string)
2632
def get_format_description(self):
2633
"""Return the short description for this format."""
2634
raise NotImplementedError(self.get_format_description)
2636
def is_supported(self):
2637
"""Is this format supported?
2639
Supported formats can be initialized and opened.
2640
Unsupported formats may not support initialization or committing or
2641
some other features depending on the reason for not being supported.
2646
def register_format(klass, format):
2647
klass._formats[format.get_format_string()] = format
2650
def set_default_format(klass, format):
2651
klass._default_format = format
2654
def unregister_format(klass, format):
2655
assert klass._formats[format.get_format_string()] is format
2656
del klass._formats[format.get_format_string()]
2659
class WorkingTreeFormat2(WorkingTreeFormat):
2660
"""The second working tree format.
2662
This format modified the hash cache from the format 1 hash cache.
2665
upgrade_recommended = True
2667
def get_format_description(self):
2668
"""See WorkingTreeFormat.get_format_description()."""
2669
return "Working tree format 2"
2671
def stub_initialize_remote(self, control_files):
2672
"""As a special workaround create critical control files for a remote working tree
2674
This ensures that it can later be updated and dealt with locally,
2675
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2676
no working tree. (See bug #43064).
2680
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2682
control_files.put('inventory', sio)
2684
control_files.put_bytes('pending-merges', '')
2687
def initialize(self, a_bzrdir, revision_id=None):
2688
"""See WorkingTreeFormat.initialize()."""
2689
if not isinstance(a_bzrdir.transport, LocalTransport):
2690
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2691
branch = a_bzrdir.open_branch()
2692
if revision_id is None:
2693
revision_id = _mod_revision.ensure_null(branch.last_revision())
2696
branch.generate_revision_history(revision_id)
2700
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2706
basis_tree = branch.repository.revision_tree(revision_id)
2707
if basis_tree.inventory.root is not None:
2708
wt.set_root_id(basis_tree.inventory.root.file_id)
2709
# set the parent list and cache the basis tree.
2710
if _mod_revision.is_null(revision_id):
2713
parent_trees = [(revision_id, basis_tree)]
2714
wt.set_parent_trees(parent_trees)
2715
transform.build_tree(basis_tree, wt)
2719
super(WorkingTreeFormat2, self).__init__()
2720
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2722
def open(self, a_bzrdir, _found=False):
2723
"""Return the WorkingTree object for a_bzrdir
2725
_found is a private parameter, do not use it. It is used to indicate
2726
if format probing has already been done.
2729
# we are being called directly and must probe.
2730
raise NotImplementedError
2731
if not isinstance(a_bzrdir.transport, LocalTransport):
2732
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2733
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2739
class WorkingTreeFormat3(WorkingTreeFormat):
2740
"""The second working tree format updated to record a format marker.
2743
- exists within a metadir controlling .bzr
2744
- includes an explicit version marker for the workingtree control
2745
files, separate from the BzrDir format
2746
- modifies the hash cache format
2748
- uses a LockDir to guard access for writes.
2751
upgrade_recommended = True
2753
def get_format_string(self):
2754
"""See WorkingTreeFormat.get_format_string()."""
2755
return "Bazaar-NG Working Tree format 3"
2757
def get_format_description(self):
2758
"""See WorkingTreeFormat.get_format_description()."""
2759
return "Working tree format 3"
2761
_lock_file_name = 'lock'
2762
_lock_class = LockDir
2764
_tree_class = WorkingTree3
2766
def __get_matchingbzrdir(self):
2767
return bzrdir.BzrDirMetaFormat1()
2769
_matchingbzrdir = property(__get_matchingbzrdir)
2771
def _open_control_files(self, a_bzrdir):
2772
transport = a_bzrdir.get_workingtree_transport(None)
2773
return LockableFiles(transport, self._lock_file_name,
2776
def initialize(self, a_bzrdir, revision_id=None):
2777
"""See WorkingTreeFormat.initialize().
2779
revision_id allows creating a working tree at a different
2780
revision than the branch is at.
2782
if not isinstance(a_bzrdir.transport, LocalTransport):
2783
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2784
transport = a_bzrdir.get_workingtree_transport(self)
2785
control_files = self._open_control_files(a_bzrdir)
2786
control_files.create_lock()
2787
control_files.lock_write()
2788
control_files.put_utf8('format', self.get_format_string())
2789
branch = a_bzrdir.open_branch()
2790
if revision_id is None:
2791
revision_id = _mod_revision.ensure_null(branch.last_revision())
2792
# WorkingTree3 can handle an inventory which has a unique root id.
2793
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2794
# those trees. And because there isn't a format bump inbetween, we
2795
# are maintaining compatibility with older clients.
2796
# inv = Inventory(root_id=gen_root_id())
2797
inv = self._initial_inventory()
2798
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2804
_control_files=control_files)
2805
wt.lock_tree_write()
2807
basis_tree = branch.repository.revision_tree(revision_id)
2808
# only set an explicit root id if there is one to set.
2809
if basis_tree.inventory.root is not None:
2810
wt.set_root_id(basis_tree.inventory.root.file_id)
2811
if revision_id == NULL_REVISION:
2812
wt.set_parent_trees([])
2814
wt.set_parent_trees([(revision_id, basis_tree)])
2815
transform.build_tree(basis_tree, wt)
2817
# Unlock in this order so that the unlock-triggers-flush in
2818
# WorkingTree is given a chance to fire.
2819
control_files.unlock()
2823
def _initial_inventory(self):
2827
super(WorkingTreeFormat3, self).__init__()
2829
def open(self, a_bzrdir, _found=False):
2830
"""Return the WorkingTree object for a_bzrdir
2832
_found is a private parameter, do not use it. It is used to indicate
2833
if format probing has already been done.
2836
# we are being called directly and must probe.
2837
raise NotImplementedError
2838
if not isinstance(a_bzrdir.transport, LocalTransport):
2839
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2840
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2843
def _open(self, a_bzrdir, control_files):
2844
"""Open the tree itself.
2846
:param a_bzrdir: the dir for the tree.
2847
:param control_files: the control files for the tree.
2849
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2853
_control_files=control_files)
2856
return self.get_format_string()
2859
__default_format = WorkingTreeFormat4()
2860
WorkingTreeFormat.register_format(__default_format)
2861
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2862
WorkingTreeFormat.set_default_format(__default_format)
2863
# formats which have no format string are not discoverable
2864
# and not independently creatable, so are not registered.
2865
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
