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,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
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,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
class TreeEntry(object):
124
"""An entry that implements the minimum interface used by commands.
126
This needs further inspection, it may be better to have
127
InventoryEntries without ids - though that seems wrong. For now,
128
this is a parallel hierarchy to InventoryEntry, and needs to become
129
one of several things: decorates to that hierarchy, children of, or
131
Another note is that these objects are currently only used when there is
132
no InventoryEntry available - i.e. for unversioned objects.
133
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
136
def __eq__(self, other):
137
# yes, this us ugly, TODO: best practice __eq__ style.
138
return (isinstance(other, TreeEntry)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeDirectory(TreeEntry):
146
"""See TreeEntry. This is a directory in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeDirectory)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeFile(TreeEntry):
157
"""See TreeEntry. This is a regular file in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeFile)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeLink(TreeEntry):
168
"""See TreeEntry. This is a symlink in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeLink)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
179
"""Working copy tree.
181
The inventory is held in the `Branch` working-inventory, and the
182
files are in a directory on disk.
184
It is possible for a `WorkingTree` to have a filename which is
185
not listed in the Inventory and vice versa.
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
assert isinstance(basedir, basestring), \
205
"base directory %r is not a string" % basedir
206
basedir = safe_unicode(basedir)
207
mutter("opening working tree %r", basedir)
208
if deprecated_passed(branch):
209
self._branch = branch
211
self._branch = self.bzrdir.open_branch()
212
self.basedir = realpath(basedir)
213
# if branch is at our basedir and is a format 6 or less
214
if isinstance(self._format, WorkingTreeFormat2):
215
# share control object
216
self._control_files = self.branch.control_files
218
# assume all other formats have their own control files.
219
assert isinstance(_control_files, LockableFiles), \
220
"_control_files must be a LockableFiles, not %r" \
222
self._control_files = _control_files
223
# update the whole cache up front and write to disk if anything changed;
224
# in the future we might want to do this more selectively
225
# two possible ways offer themselves : in self._unlock, write the cache
226
# if needed, or, when the cache sees a change, append it to the hash
227
# cache file, and have the parser take the most recent entry for a
229
wt_trans = self.bzrdir.get_workingtree_transport(None)
230
cache_filename = wt_trans.local_abspath('stat-cache')
231
self._hashcache = hashcache.HashCache(basedir, cache_filename,
232
self._control_files._file_mode)
235
# is this scan needed ? it makes things kinda slow.
242
if _inventory is None:
243
# This will be acquired on lock_read() or lock_write()
244
self._inventory_is_modified = False
245
self._inventory = None
247
# the caller of __init__ has provided an inventory,
248
# we assume they know what they are doing - as its only
249
# the Format factory and creation methods that are
250
# permitted to do this.
251
self._set_inventory(_inventory, dirty=False)
252
self._detect_case_handling()
254
def _detect_case_handling(self):
255
wt_trans = self.bzrdir.get_workingtree_transport(None)
257
wt_trans.stat("FoRMaT")
258
except errors.NoSuchFile:
259
self.case_sensitive = True
261
self.case_sensitive = False
263
self._setup_directory_is_tree_reference()
266
fget=lambda self: self._branch,
267
doc="""The branch this WorkingTree is connected to.
269
This cannot be set - it is reflective of the actual disk structure
270
the working tree has been constructed from.
273
def break_lock(self):
274
"""Break a lock if one is present from another instance.
276
Uses the ui factory to ask for confirmation if the lock may be from
279
This will probe the repository for its lock as well.
281
self._control_files.break_lock()
282
self.branch.break_lock()
284
def requires_rich_root(self):
285
return self._format.requires_rich_root
287
def supports_tree_reference(self):
290
def _set_inventory(self, inv, dirty):
291
"""Set the internal cached inventory.
293
:param inv: The inventory to set.
294
:param dirty: A boolean indicating whether the inventory is the same
295
logical inventory as whats on disk. If True the inventory is not
296
the same and should be written to disk or data will be lost, if
297
False then the inventory is the same as that on disk and any
298
serialisation would be unneeded overhead.
300
assert inv.root is not None
301
self._inventory = inv
302
self._inventory_is_modified = dirty
305
def open(path=None, _unsupported=False):
306
"""Open an existing working tree at path.
310
path = os.path.getcwdu()
311
control = bzrdir.BzrDir.open(path, _unsupported)
312
return control.open_workingtree(_unsupported)
315
def open_containing(path=None):
316
"""Open an existing working tree which has its root about path.
318
This probes for a working tree at path and searches upwards from there.
320
Basically we keep looking up until we find the control directory or
321
run into /. If there isn't one, raises NotBranchError.
322
TODO: give this a new exception.
323
If there is one, it is returned, along with the unused portion of path.
325
:return: The WorkingTree that contains 'path', and the rest of path
328
path = osutils.getcwd()
329
control, relpath = bzrdir.BzrDir.open_containing(path)
331
return control.open_workingtree(), relpath
334
def open_downlevel(path=None):
335
"""Open an unsupported working tree.
337
Only intended for advanced situations like upgrading part of a bzrdir.
339
return WorkingTree.open(path, _unsupported=True)
342
def find_trees(location):
343
def list_current(transport):
344
return [d for d in transport.list_dir('') if d != '.bzr']
345
def evaluate(bzrdir):
347
tree = bzrdir.open_workingtree()
348
except errors.NoWorkingTree:
352
transport = get_transport(location)
353
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
354
list_current=list_current)
355
return [t for t in iterator if t is not None]
357
# should be deprecated - this is slow and in any case treating them as a
358
# container is (we now know) bad style -- mbp 20070302
359
## @deprecated_method(zero_fifteen)
361
"""Iterate through file_ids for this tree.
363
file_ids are in a WorkingTree if they are in the working inventory
364
and the working file exists.
366
inv = self._inventory
367
for path, ie in inv.iter_entries():
368
if osutils.lexists(self.abspath(path)):
371
def all_file_ids(self):
372
"""See Tree.iter_all_file_ids"""
373
return set(self.inventory)
376
return "<%s of %s>" % (self.__class__.__name__,
377
getattr(self, 'basedir', None))
379
def abspath(self, filename):
380
return pathjoin(self.basedir, filename)
382
def basis_tree(self):
383
"""Return RevisionTree for the current last revision.
385
If the left most parent is a ghost then the returned tree will be an
386
empty tree - one obtained by calling repository.revision_tree(None).
389
revision_id = self.get_parent_ids()[0]
391
# no parents, return an empty revision tree.
392
# in the future this should return the tree for
393
# 'empty:' - the implicit root empty tree.
394
return self.branch.repository.revision_tree(None)
396
return self.revision_tree(revision_id)
397
except errors.NoSuchRevision:
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except errors.RevisionNotPresent:
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(None)
414
self._flush_ignore_list_cache()
416
def relpath(self, path):
417
"""Return the local path portion from a given path.
419
The path may be absolute or relative. If its a relative path it is
420
interpreted relative to the python current working directory.
422
return osutils.relpath(self.basedir, path)
424
def has_filename(self, filename):
425
return osutils.lexists(self.abspath(filename))
427
def get_file(self, file_id, path=None):
429
path = self.id2path(file_id)
430
return self.get_file_byname(path)
432
def get_file_text(self, file_id):
433
return self.get_file(file_id).read()
435
def get_file_byname(self, filename):
436
return file(self.abspath(filename), 'rb')
439
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
440
"""See Tree.annotate_iter
442
This implementation will use the basis tree implementation if possible.
443
Lines not in the basis are attributed to CURRENT_REVISION
445
If there are pending merges, lines added by those merges will be
446
incorrectly attributed to CURRENT_REVISION (but after committing, the
447
attribution will be correct).
449
basis = self.basis_tree()
452
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
453
require_versioned=True).next()
454
changed_content, kind = changes[2], changes[6]
455
if not changed_content:
456
return basis.annotate_iter(file_id)
460
if kind[0] != 'file':
463
old_lines = list(basis.annotate_iter(file_id))
465
for tree in self.branch.repository.revision_trees(
466
self.get_parent_ids()[1:]):
467
if file_id not in tree:
469
old.append(list(tree.annotate_iter(file_id)))
470
return annotate.reannotate(old, self.get_file(file_id).readlines(),
475
def _get_ancestors(self, default_revision):
476
ancestors = set([default_revision])
477
for parent_id in self.get_parent_ids():
478
ancestors.update(self.branch.repository.get_ancestry(
479
parent_id, topo_sorted=False))
482
def get_parent_ids(self):
483
"""See Tree.get_parent_ids.
485
This implementation reads the pending merges list and last_revision
486
value and uses that to decide what the parents list should be.
488
last_rev = _mod_revision.ensure_null(self._last_revision())
489
if _mod_revision.NULL_REVISION == last_rev:
494
merges_file = self._control_files.get('pending-merges')
495
except errors.NoSuchFile:
498
for l in merges_file.readlines():
499
revision_id = l.rstrip('\n')
500
parents.append(revision_id)
504
def get_root_id(self):
505
"""Return the id of this trees root"""
506
return self._inventory.root.file_id
508
def _get_store_filename(self, file_id):
509
## XXX: badly named; this is not in the store at all
510
return self.abspath(self.id2path(file_id))
513
def clone(self, to_bzrdir, revision_id=None):
514
"""Duplicate this working tree into to_bzr, including all state.
516
Specifically modified files are kept as modified, but
517
ignored and unknown files are discarded.
519
If you want to make a new line of development, see bzrdir.sprout()
522
If not None, the cloned tree will have its last revision set to
523
revision, and and difference between the source trees last revision
524
and this one merged in.
526
# assumes the target bzr dir format is compatible.
527
result = self._format.initialize(to_bzrdir)
528
self.copy_content_into(result, revision_id)
532
def copy_content_into(self, tree, revision_id=None):
533
"""Copy the current content and user files of this tree into tree."""
534
tree.set_root_id(self.get_root_id())
535
if revision_id is None:
536
merge.transform_tree(tree, self)
538
# TODO now merge from tree.last_revision to revision (to preserve
539
# user local changes)
540
merge.transform_tree(tree, self)
541
tree.set_parent_ids([revision_id])
543
def id2abspath(self, file_id):
544
return self.abspath(self.id2path(file_id))
546
def has_id(self, file_id):
547
# files that have been deleted are excluded
549
if not inv.has_id(file_id):
551
path = inv.id2path(file_id)
552
return osutils.lexists(self.abspath(path))
554
def has_or_had_id(self, file_id):
555
if file_id == self.inventory.root.file_id:
557
return self.inventory.has_id(file_id)
559
__contains__ = has_id
561
def get_file_size(self, file_id):
562
"""See Tree.get_file_size"""
564
return os.path.getsize(self.id2abspath(file_id))
566
if e.errno != errno.ENOENT:
572
def get_file_sha1(self, file_id, path=None, stat_value=None):
574
path = self._inventory.id2path(file_id)
575
return self._hashcache.get_sha1(path, stat_value)
577
def get_file_mtime(self, file_id, path=None):
579
path = self.inventory.id2path(file_id)
580
return os.lstat(self.abspath(path)).st_mtime
582
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
583
file_id = self.path2id(path)
584
return self._inventory[file_id].executable
586
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
587
mode = stat_result.st_mode
588
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
590
if not supports_executable():
591
def is_executable(self, file_id, path=None):
592
return self._inventory[file_id].executable
594
_is_executable_from_path_and_stat = \
595
_is_executable_from_path_and_stat_from_basis
597
def is_executable(self, file_id, path=None):
599
path = self.id2path(file_id)
600
mode = os.lstat(self.abspath(path)).st_mode
601
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
603
_is_executable_from_path_and_stat = \
604
_is_executable_from_path_and_stat_from_stat
606
@needs_tree_write_lock
607
def _add(self, files, ids, kinds):
608
"""See MutableTree._add."""
609
# TODO: Re-adding a file that is removed in the working copy
610
# should probably put it back with the previous ID.
611
# the read and write working inventory should not occur in this
612
# function - they should be part of lock_write and unlock.
614
for f, file_id, kind in zip(files, ids, kinds):
615
assert kind is not None
617
inv.add_path(f, kind=kind)
619
inv.add_path(f, kind=kind, file_id=file_id)
620
self._inventory_is_modified = True
622
@needs_tree_write_lock
623
def _gather_kinds(self, files, kinds):
624
"""See MutableTree._gather_kinds."""
625
for pos, f in enumerate(files):
626
if kinds[pos] is None:
627
fullpath = normpath(self.abspath(f))
629
kinds[pos] = file_kind(fullpath)
631
if e.errno == errno.ENOENT:
632
raise errors.NoSuchFile(fullpath)
635
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
636
"""Add revision_id as a parent.
638
This is equivalent to retrieving the current list of parent ids
639
and setting the list to its value plus revision_id.
641
:param revision_id: The revision id to add to the parent list. It may
642
be a ghost revision as long as its not the first parent to be added,
643
or the allow_leftmost_as_ghost parameter is set True.
644
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
646
parents = self.get_parent_ids() + [revision_id]
647
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
648
or allow_leftmost_as_ghost)
650
@needs_tree_write_lock
651
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
652
"""Add revision_id, tree tuple as a parent.
654
This is equivalent to retrieving the current list of parent trees
655
and setting the list to its value plus parent_tuple. See also
656
add_parent_tree_id - if you only have a parent id available it will be
657
simpler to use that api. If you have the parent already available, using
658
this api is preferred.
660
:param parent_tuple: The (revision id, tree) to add to the parent list.
661
If the revision_id is a ghost, pass None for the tree.
662
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
664
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
665
if len(parent_ids) > 1:
666
# the leftmost may have already been a ghost, preserve that if it
668
allow_leftmost_as_ghost = True
669
self.set_parent_ids(parent_ids,
670
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
672
@needs_tree_write_lock
673
def add_pending_merge(self, *revision_ids):
674
# TODO: Perhaps should check at this point that the
675
# history of the revision is actually present?
676
parents = self.get_parent_ids()
678
for rev_id in revision_ids:
679
if rev_id in parents:
681
parents.append(rev_id)
684
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
686
def path_content_summary(self, path, _lstat=os.lstat,
687
_mapper=osutils.file_kind_from_stat_mode):
688
"""See Tree.path_content_summary."""
689
abspath = self.abspath(path)
691
stat_result = _lstat(abspath)
693
if getattr(e, 'errno', None) == errno.ENOENT:
695
return ('missing', None, None, None)
696
# propagate other errors
698
kind = _mapper(stat_result.st_mode)
700
size = stat_result.st_size
701
# try for a stat cache lookup
702
executable = self._is_executable_from_path_and_stat(path, stat_result)
703
return (kind, size, executable, self._sha_from_stat(
705
elif kind == 'directory':
706
# perhaps it looks like a plain directory, but it's really a
708
if self._directory_is_tree_reference(path):
709
kind = 'tree-reference'
710
return kind, None, None, None
711
elif kind == 'symlink':
712
return ('symlink', None, None, os.readlink(abspath))
714
return (kind, None, None, None)
716
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
717
"""Common ghost checking functionality from set_parent_*.
719
This checks that the left hand-parent exists if there are any
722
if len(revision_ids) > 0:
723
leftmost_id = revision_ids[0]
724
if (not allow_leftmost_as_ghost and not
725
self.branch.repository.has_revision(leftmost_id)):
726
raise errors.GhostRevisionUnusableHere(leftmost_id)
728
def _set_merges_from_parent_ids(self, parent_ids):
729
merges = parent_ids[1:]
730
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
732
@needs_tree_write_lock
733
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
734
"""Set the parent ids to revision_ids.
736
See also set_parent_trees. This api will try to retrieve the tree data
737
for each element of revision_ids from the trees repository. If you have
738
tree data already available, it is more efficient to use
739
set_parent_trees rather than set_parent_ids. set_parent_ids is however
740
an easier API to use.
742
:param revision_ids: The revision_ids to set as the parent ids of this
743
working tree. Any of these may be ghosts.
745
self._check_parents_for_ghosts(revision_ids,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
747
for revision_id in revision_ids:
748
_mod_revision.check_not_reserved_id(revision_id)
750
if len(revision_ids) > 0:
751
self.set_last_revision(revision_ids[0])
753
self.set_last_revision(_mod_revision.NULL_REVISION)
755
self._set_merges_from_parent_ids(revision_ids)
757
@needs_tree_write_lock
758
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
759
"""See MutableTree.set_parent_trees."""
760
parent_ids = [rev for (rev, tree) in parents_list]
761
for revision_id in parent_ids:
762
_mod_revision.check_not_reserved_id(revision_id)
764
self._check_parents_for_ghosts(parent_ids,
765
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
767
if len(parent_ids) == 0:
768
leftmost_parent_id = _mod_revision.NULL_REVISION
769
leftmost_parent_tree = None
771
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
773
if self._change_last_revision(leftmost_parent_id):
774
if leftmost_parent_tree is None:
775
# If we don't have a tree, fall back to reading the
776
# parent tree from the repository.
777
self._cache_basis_inventory(leftmost_parent_id)
779
inv = leftmost_parent_tree.inventory
780
xml = self._create_basis_xml_from_inventory(
781
leftmost_parent_id, inv)
782
self._write_basis_inventory(xml)
783
self._set_merges_from_parent_ids(parent_ids)
785
@needs_tree_write_lock
786
def set_pending_merges(self, rev_list):
787
parents = self.get_parent_ids()
788
leftmost = parents[:1]
789
new_parents = leftmost + rev_list
790
self.set_parent_ids(new_parents)
792
@needs_tree_write_lock
793
def set_merge_modified(self, modified_hashes):
795
for file_id, hash in modified_hashes.iteritems():
796
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
797
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
799
def _sha_from_stat(self, path, stat_result):
800
"""Get a sha digest from the tree's stat cache.
802
The default implementation assumes no stat cache is present.
804
:param path: The path.
805
:param stat_result: The stat result being looked up.
809
def _put_rio(self, filename, stanzas, header):
810
self._must_be_locked()
811
my_file = rio_file(stanzas, header)
812
self._control_files.put(filename, my_file)
814
@needs_write_lock # because merge pulls data into the branch.
815
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
817
"""Merge from a branch into this working tree.
819
:param branch: The branch to merge from.
820
:param to_revision: If non-None, the merge will merge to to_revision,
821
but not beyond it. to_revision does not need to be in the history
822
of the branch when it is supplied. If None, to_revision defaults to
823
branch.last_revision().
825
from bzrlib.merge import Merger, Merge3Merger
826
pb = bzrlib.ui.ui_factory.nested_progress_bar()
828
merger = Merger(self.branch, this_tree=self, pb=pb)
829
merger.pp = ProgressPhase("Merge phase", 5, pb)
830
merger.pp.next_phase()
831
# check that there are no
833
merger.check_basis(check_clean=True, require_commits=False)
834
if to_revision is None:
835
to_revision = _mod_revision.ensure_null(branch.last_revision())
836
merger.other_rev_id = to_revision
837
if _mod_revision.is_null(merger.other_rev_id):
838
raise errors.NoCommits(branch)
839
self.branch.fetch(branch, last_revision=merger.other_rev_id)
840
merger.other_basis = merger.other_rev_id
841
merger.other_tree = self.branch.repository.revision_tree(
843
merger.other_branch = branch
844
merger.pp.next_phase()
845
if from_revision is None:
848
merger.set_base_revision(from_revision, branch)
849
if merger.base_rev_id == merger.other_rev_id:
850
raise errors.PointlessMerge
851
merger.backup_files = False
852
if merge_type is None:
853
merger.merge_type = Merge3Merger
855
merger.merge_type = merge_type
856
merger.set_interesting_files(None)
857
merger.show_base = False
858
merger.reprocess = False
859
conflicts = merger.do_merge()
866
def merge_modified(self):
867
"""Return a dictionary of files modified by a merge.
869
The list is initialized by WorkingTree.set_merge_modified, which is
870
typically called after we make some automatic updates to the tree
873
This returns a map of file_id->sha1, containing only files which are
874
still in the working inventory and have that text hash.
877
hashfile = self._control_files.get('merge-hashes')
878
except errors.NoSuchFile:
882
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
883
raise errors.MergeModifiedFormatError()
884
except StopIteration:
885
raise errors.MergeModifiedFormatError()
886
for s in RioReader(hashfile):
887
# RioReader reads in Unicode, so convert file_ids back to utf8
888
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
889
if file_id not in self.inventory:
891
text_hash = s.get("hash")
892
if text_hash == self.get_file_sha1(file_id):
893
merge_hashes[file_id] = text_hash
897
def mkdir(self, path, file_id=None):
898
"""See MutableTree.mkdir()."""
900
file_id = generate_ids.gen_file_id(os.path.basename(path))
901
os.mkdir(self.abspath(path))
902
self.add(path, file_id, 'directory')
905
def get_symlink_target(self, file_id):
906
return os.readlink(self.id2abspath(file_id))
909
def subsume(self, other_tree):
910
def add_children(inventory, entry):
911
for child_entry in entry.children.values():
912
inventory._byid[child_entry.file_id] = child_entry
913
if child_entry.kind == 'directory':
914
add_children(inventory, child_entry)
915
if other_tree.get_root_id() == self.get_root_id():
916
raise errors.BadSubsumeSource(self, other_tree,
917
'Trees have the same root')
919
other_tree_path = self.relpath(other_tree.basedir)
920
except errors.PathNotChild:
921
raise errors.BadSubsumeSource(self, other_tree,
922
'Tree is not contained by the other')
923
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
924
if new_root_parent is None:
925
raise errors.BadSubsumeSource(self, other_tree,
926
'Parent directory is not versioned.')
927
# We need to ensure that the result of a fetch will have a
928
# versionedfile for the other_tree root, and only fetching into
929
# RepositoryKnit2 guarantees that.
930
if not self.branch.repository.supports_rich_root():
931
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
932
other_tree.lock_tree_write()
934
new_parents = other_tree.get_parent_ids()
935
other_root = other_tree.inventory.root
936
other_root.parent_id = new_root_parent
937
other_root.name = osutils.basename(other_tree_path)
938
self.inventory.add(other_root)
939
add_children(self.inventory, other_root)
940
self._write_inventory(self.inventory)
941
# normally we don't want to fetch whole repositories, but i think
942
# here we really do want to consolidate the whole thing.
943
for parent_id in other_tree.get_parent_ids():
944
self.branch.fetch(other_tree.branch, parent_id)
945
self.add_parent_tree_id(parent_id)
948
other_tree.bzrdir.retire_bzrdir()
950
def _setup_directory_is_tree_reference(self):
951
if self._branch.repository._format.supports_tree_reference:
952
self._directory_is_tree_reference = \
953
self._directory_may_be_tree_reference
955
self._directory_is_tree_reference = \
956
self._directory_is_never_tree_reference
958
def _directory_is_never_tree_reference(self, relpath):
961
def _directory_may_be_tree_reference(self, relpath):
962
# as a special case, if a directory contains control files then
963
# it's a tree reference, except that the root of the tree is not
964
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
965
# TODO: We could ask all the control formats whether they
966
# recognize this directory, but at the moment there's no cheap api
967
# to do that. Since we probably can only nest bzr checkouts and
968
# they always use this name it's ok for now. -- mbp 20060306
970
# FIXME: There is an unhandled case here of a subdirectory
971
# containing .bzr but not a branch; that will probably blow up
972
# when you try to commit it. It might happen if there is a
973
# checkout in a subdirectory. This can be avoided by not adding
976
@needs_tree_write_lock
977
def extract(self, file_id, format=None):
978
"""Extract a subtree from this tree.
980
A new branch will be created, relative to the path for this tree.
984
segments = osutils.splitpath(path)
985
transport = self.branch.bzrdir.root_transport
986
for name in segments:
987
transport = transport.clone(name)
988
transport.ensure_base()
991
sub_path = self.id2path(file_id)
992
branch_transport = mkdirs(sub_path)
994
format = self.bzrdir.cloning_metadir()
995
branch_transport.ensure_base()
996
branch_bzrdir = format.initialize_on_transport(branch_transport)
998
repo = branch_bzrdir.find_repository()
999
except errors.NoRepositoryPresent:
1000
repo = branch_bzrdir.create_repository()
1001
if not repo.supports_rich_root():
1002
raise errors.RootNotRich()
1003
new_branch = branch_bzrdir.create_branch()
1004
new_branch.pull(self.branch)
1005
for parent_id in self.get_parent_ids():
1006
new_branch.fetch(self.branch, parent_id)
1007
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1008
if tree_transport.base != branch_transport.base:
1009
tree_bzrdir = format.initialize_on_transport(tree_transport)
1010
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1012
tree_bzrdir = branch_bzrdir
1013
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1014
wt.set_parent_ids(self.get_parent_ids())
1015
my_inv = self.inventory
1016
child_inv = Inventory(root_id=None)
1017
new_root = my_inv[file_id]
1018
my_inv.remove_recursive_id(file_id)
1019
new_root.parent_id = None
1020
child_inv.add(new_root)
1021
self._write_inventory(my_inv)
1022
wt._write_inventory(child_inv)
1025
def _serialize(self, inventory, out_file):
1026
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1029
def _deserialize(selt, in_file):
1030
return xml5.serializer_v5.read_inventory(in_file)
1033
"""Write the in memory inventory to disk."""
1034
# TODO: Maybe this should only write on dirty ?
1035
if self._control_files._lock_mode != 'w':
1036
raise errors.NotWriteLocked(self)
1038
self._serialize(self._inventory, sio)
1040
self._control_files.put('inventory', sio)
1041
self._inventory_is_modified = False
1043
def _kind(self, relpath):
1044
return osutils.file_kind(self.abspath(relpath))
1046
def list_files(self, include_root=False):
1047
"""Recursively list all files as (path, class, kind, id, entry).
1049
Lists, but does not descend into unversioned directories.
1051
This does not include files that have been deleted in this
1054
Skips the control directory.
1056
# list_files is an iterator, so @needs_read_lock doesn't work properly
1057
# with it. So callers should be careful to always read_lock the tree.
1058
if not self.is_locked():
1059
raise errors.ObjectNotLocked(self)
1061
inv = self.inventory
1062
if include_root is True:
1063
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1064
# Convert these into local objects to save lookup times
1065
pathjoin = osutils.pathjoin
1066
file_kind = self._kind
1068
# transport.base ends in a slash, we want the piece
1069
# between the last two slashes
1070
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1072
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1074
# directory file_id, relative path, absolute path, reverse sorted children
1075
children = os.listdir(self.basedir)
1077
# jam 20060527 The kernel sized tree seems equivalent whether we
1078
# use a deque and popleft to keep them sorted, or if we use a plain
1079
# list and just reverse() them.
1080
children = collections.deque(children)
1081
stack = [(inv.root.file_id, u'', self.basedir, children)]
1083
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1086
f = children.popleft()
1087
## TODO: If we find a subdirectory with its own .bzr
1088
## directory, then that is a separate tree and we
1089
## should exclude it.
1091
# the bzrdir for this tree
1092
if transport_base_dir == f:
1095
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1096
# and 'f' doesn't begin with one, we can do a string op, rather
1097
# than the checks of pathjoin(), all relative paths will have an extra slash
1099
fp = from_dir_relpath + '/' + f
1102
fap = from_dir_abspath + '/' + f
1104
f_ie = inv.get_child(from_dir_id, f)
1107
elif self.is_ignored(fp[1:]):
1110
# we may not have found this file, because of a unicode issue
1111
f_norm, can_access = osutils.normalized_filename(f)
1112
if f == f_norm or not can_access:
1113
# No change, so treat this file normally
1116
# this file can be accessed by a normalized path
1117
# check again if it is versioned
1118
# these lines are repeated here for performance
1120
fp = from_dir_relpath + '/' + f
1121
fap = from_dir_abspath + '/' + f
1122
f_ie = inv.get_child(from_dir_id, f)
1125
elif self.is_ignored(fp[1:]):
1132
# make a last minute entry
1134
yield fp[1:], c, fk, f_ie.file_id, f_ie
1137
yield fp[1:], c, fk, None, fk_entries[fk]()
1139
yield fp[1:], c, fk, None, TreeEntry()
1142
if fk != 'directory':
1145
# But do this child first
1146
new_children = os.listdir(fap)
1148
new_children = collections.deque(new_children)
1149
stack.append((f_ie.file_id, fp, fap, new_children))
1150
# Break out of inner loop,
1151
# so that we start outer loop with child
1154
# if we finished all children, pop it off the stack
1157
@needs_tree_write_lock
1158
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1161
to_dir must exist in the inventory.
1163
If to_dir exists and is a directory, the files are moved into
1164
it, keeping their old names.
1166
Note that to_dir is only the last component of the new name;
1167
this doesn't change the directory.
1169
For each entry in from_paths the move mode will be determined
1172
The first mode moves the file in the filesystem and updates the
1173
inventory. The second mode only updates the inventory without
1174
touching the file on the filesystem. This is the new mode introduced
1177
move uses the second mode if 'after == True' and the target is not
1178
versioned but present in the working tree.
1180
move uses the second mode if 'after == False' and the source is
1181
versioned but no longer in the working tree, and the target is not
1182
versioned but present in the working tree.
1184
move uses the first mode if 'after == False' and the source is
1185
versioned and present in the working tree, and the target is not
1186
versioned and not present in the working tree.
1188
Everything else results in an error.
1190
This returns a list of (from_path, to_path) pairs for each
1191
entry that is moved.
1196
# check for deprecated use of signature
1198
to_dir = kwargs.get('to_name', None)
1200
raise TypeError('You must supply a target directory')
1202
symbol_versioning.warn('The parameter to_name was deprecated'
1203
' in version 0.13. Use to_dir instead',
1206
# check destination directory
1207
assert not isinstance(from_paths, basestring)
1208
inv = self.inventory
1209
to_abs = self.abspath(to_dir)
1210
if not isdir(to_abs):
1211
raise errors.BzrMoveFailedError('',to_dir,
1212
errors.NotADirectory(to_abs))
1213
if not self.has_filename(to_dir):
1214
raise errors.BzrMoveFailedError('',to_dir,
1215
errors.NotInWorkingDirectory(to_dir))
1216
to_dir_id = inv.path2id(to_dir)
1217
if to_dir_id is None:
1218
raise errors.BzrMoveFailedError('',to_dir,
1219
errors.NotVersionedError(path=str(to_dir)))
1221
to_dir_ie = inv[to_dir_id]
1222
if to_dir_ie.kind != 'directory':
1223
raise errors.BzrMoveFailedError('',to_dir,
1224
errors.NotADirectory(to_abs))
1226
# create rename entries and tuples
1227
for from_rel in from_paths:
1228
from_tail = splitpath(from_rel)[-1]
1229
from_id = inv.path2id(from_rel)
1231
raise errors.BzrMoveFailedError(from_rel,to_dir,
1232
errors.NotVersionedError(path=str(from_rel)))
1234
from_entry = inv[from_id]
1235
from_parent_id = from_entry.parent_id
1236
to_rel = pathjoin(to_dir, from_tail)
1237
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1239
from_tail=from_tail,
1240
from_parent_id=from_parent_id,
1241
to_rel=to_rel, to_tail=from_tail,
1242
to_parent_id=to_dir_id)
1243
rename_entries.append(rename_entry)
1244
rename_tuples.append((from_rel, to_rel))
1246
# determine which move mode to use. checks also for movability
1247
rename_entries = self._determine_mv_mode(rename_entries, after)
1249
original_modified = self._inventory_is_modified
1252
self._inventory_is_modified = True
1253
self._move(rename_entries)
1255
# restore the inventory on error
1256
self._inventory_is_modified = original_modified
1258
self._write_inventory(inv)
1259
return rename_tuples
1261
def _determine_mv_mode(self, rename_entries, after=False):
1262
"""Determines for each from-to pair if both inventory and working tree
1263
or only the inventory has to be changed.
1265
Also does basic plausability tests.
1267
inv = self.inventory
1269
for rename_entry in rename_entries:
1270
# store to local variables for easier reference
1271
from_rel = rename_entry.from_rel
1272
from_id = rename_entry.from_id
1273
to_rel = rename_entry.to_rel
1274
to_id = inv.path2id(to_rel)
1275
only_change_inv = False
1277
# check the inventory for source and destination
1279
raise errors.BzrMoveFailedError(from_rel,to_rel,
1280
errors.NotVersionedError(path=str(from_rel)))
1281
if to_id is not None:
1282
raise errors.BzrMoveFailedError(from_rel,to_rel,
1283
errors.AlreadyVersionedError(path=str(to_rel)))
1285
# try to determine the mode for rename (only change inv or change
1286
# inv and file system)
1288
if not self.has_filename(to_rel):
1289
raise errors.BzrMoveFailedError(from_id,to_rel,
1290
errors.NoSuchFile(path=str(to_rel),
1291
extra="New file has not been created yet"))
1292
only_change_inv = True
1293
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1294
only_change_inv = True
1295
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1296
only_change_inv = False
1297
elif (sys.platform == 'win32'
1298
and from_rel.lower() == to_rel.lower()
1299
and self.has_filename(from_rel)):
1300
only_change_inv = False
1302
# something is wrong, so lets determine what exactly
1303
if not self.has_filename(from_rel) and \
1304
not self.has_filename(to_rel):
1305
raise errors.BzrRenameFailedError(from_rel,to_rel,
1306
errors.PathsDoNotExist(paths=(str(from_rel),
1309
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1310
rename_entry.only_change_inv = only_change_inv
1311
return rename_entries
1313
def _move(self, rename_entries):
1314
"""Moves a list of files.
1316
Depending on the value of the flag 'only_change_inv', the
1317
file will be moved on the file system or not.
1319
inv = self.inventory
1322
for entry in rename_entries:
1324
self._move_entry(entry)
1326
self._rollback_move(moved)
1330
def _rollback_move(self, moved):
1331
"""Try to rollback a previous move in case of an filesystem error."""
1332
inv = self.inventory
1335
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1336
entry.to_tail, entry.to_parent_id, entry.from_rel,
1337
entry.from_tail, entry.from_parent_id,
1338
entry.only_change_inv))
1339
except errors.BzrMoveFailedError, e:
1340
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1341
" The working tree is in an inconsistent state."
1342
" Please consider doing a 'bzr revert'."
1343
" Error message is: %s" % e)
1345
def _move_entry(self, entry):
1346
inv = self.inventory
1347
from_rel_abs = self.abspath(entry.from_rel)
1348
to_rel_abs = self.abspath(entry.to_rel)
1349
if from_rel_abs == to_rel_abs:
1350
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1351
"Source and target are identical.")
1353
if not entry.only_change_inv:
1355
osutils.rename(from_rel_abs, to_rel_abs)
1357
raise errors.BzrMoveFailedError(entry.from_rel,
1359
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1361
@needs_tree_write_lock
1362
def rename_one(self, from_rel, to_rel, after=False):
1365
This can change the directory or the filename or both.
1367
rename_one has several 'modes' to work. First, it can rename a physical
1368
file and change the file_id. That is the normal mode. Second, it can
1369
only change the file_id without touching any physical file. This is
1370
the new mode introduced in version 0.15.
1372
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1373
versioned but present in the working tree.
1375
rename_one uses the second mode if 'after == False' and 'from_rel' is
1376
versioned but no longer in the working tree, and 'to_rel' is not
1377
versioned but present in the working tree.
1379
rename_one uses the first mode if 'after == False' and 'from_rel' is
1380
versioned and present in the working tree, and 'to_rel' is not
1381
versioned and not present in the working tree.
1383
Everything else results in an error.
1385
inv = self.inventory
1388
# create rename entries and tuples
1389
from_tail = splitpath(from_rel)[-1]
1390
from_id = inv.path2id(from_rel)
1392
raise errors.BzrRenameFailedError(from_rel,to_rel,
1393
errors.NotVersionedError(path=str(from_rel)))
1394
from_entry = inv[from_id]
1395
from_parent_id = from_entry.parent_id
1396
to_dir, to_tail = os.path.split(to_rel)
1397
to_dir_id = inv.path2id(to_dir)
1398
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1400
from_tail=from_tail,
1401
from_parent_id=from_parent_id,
1402
to_rel=to_rel, to_tail=to_tail,
1403
to_parent_id=to_dir_id)
1404
rename_entries.append(rename_entry)
1406
# determine which move mode to use. checks also for movability
1407
rename_entries = self._determine_mv_mode(rename_entries, after)
1409
# check if the target changed directory and if the target directory is
1411
if to_dir_id is None:
1412
raise errors.BzrMoveFailedError(from_rel,to_rel,
1413
errors.NotVersionedError(path=str(to_dir)))
1415
# all checks done. now we can continue with our actual work
1416
mutter('rename_one:\n'
1421
' to_dir_id {%s}\n',
1422
from_id, from_rel, to_rel, to_dir, to_dir_id)
1424
self._move(rename_entries)
1425
self._write_inventory(inv)
1427
class _RenameEntry(object):
1428
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1429
to_rel, to_tail, to_parent_id, only_change_inv=False):
1430
self.from_rel = from_rel
1431
self.from_id = from_id
1432
self.from_tail = from_tail
1433
self.from_parent_id = from_parent_id
1434
self.to_rel = to_rel
1435
self.to_tail = to_tail
1436
self.to_parent_id = to_parent_id
1437
self.only_change_inv = only_change_inv
1441
"""Return all unknown files.
1443
These are files in the working directory that are not versioned or
1444
control files or ignored.
1446
# force the extras method to be fully executed before returning, to
1447
# prevent race conditions with the lock
1449
[subp for subp in self.extras() if not self.is_ignored(subp)])
1451
@needs_tree_write_lock
1452
def unversion(self, file_ids):
1453
"""Remove the file ids in file_ids from the current versioned set.
1455
When a file_id is unversioned, all of its children are automatically
1458
:param file_ids: The file ids to stop versioning.
1459
:raises: NoSuchId if any fileid is not currently versioned.
1461
for file_id in file_ids:
1462
if self._inventory.has_id(file_id):
1463
self._inventory.remove_recursive_id(file_id)
1465
raise errors.NoSuchId(self, file_id)
1467
# in the future this should just set a dirty bit to wait for the
1468
# final unlock. However, until all methods of workingtree start
1469
# with the current in -memory inventory rather than triggering
1470
# a read, it is more complex - we need to teach read_inventory
1471
# to know when to read, and when to not read first... and possibly
1472
# to save first when the in memory one may be corrupted.
1473
# so for now, we just only write it if it is indeed dirty.
1475
self._write_inventory(self._inventory)
1477
def _iter_conflicts(self):
1479
for info in self.list_files():
1481
stem = get_conflicted_stem(path)
1484
if stem not in conflicted:
1485
conflicted.add(stem)
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
change_reporter=None, possible_transports=None):
1491
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1494
pp = ProgressPhase("Pull phase", 2, top_pb)
1496
old_revision_info = self.branch.last_revision_info()
1497
basis_tree = self.basis_tree()
1498
count = self.branch.pull(source, overwrite, stop_revision,
1499
possible_transports=possible_transports)
1500
new_revision_info = self.branch.last_revision_info()
1501
if new_revision_info != old_revision_info:
1503
repository = self.branch.repository
1504
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1505
basis_tree.lock_read()
1507
new_basis_tree = self.branch.basis_tree()
1514
change_reporter=change_reporter)
1515
if (basis_tree.inventory.root is None and
1516
new_basis_tree.inventory.root is not None):
1517
self.set_root_id(new_basis_tree.get_root_id())
1521
# TODO - dedup parents list with things merged by pull ?
1522
# reuse the revisiontree we merged against to set the new
1524
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1525
# we have to pull the merge trees out again, because
1526
# merge_inner has set the ids. - this corner is not yet
1527
# layered well enough to prevent double handling.
1528
# XXX TODO: Fix the double handling: telling the tree about
1529
# the already known parent data is wasteful.
1530
merges = self.get_parent_ids()[1:]
1531
parent_trees.extend([
1532
(parent, repository.revision_tree(parent)) for
1534
self.set_parent_trees(parent_trees)
1541
def put_file_bytes_non_atomic(self, file_id, bytes):
1542
"""See MutableTree.put_file_bytes_non_atomic."""
1543
stream = file(self.id2abspath(file_id), 'wb')
1548
# TODO: update the hashcache here ?
1551
"""Yield all unversioned files in this WorkingTree.
1553
If there are any unversioned directories then only the directory is
1554
returned, not all its children. But if there are unversioned files
1555
under a versioned subdirectory, they are returned.
1557
Currently returned depth-first, sorted by name within directories.
1558
This is the same order used by 'osutils.walkdirs'.
1560
## TODO: Work from given directory downwards
1561
for path, dir_entry in self.inventory.directories():
1562
# mutter("search for unknowns in %r", path)
1563
dirabs = self.abspath(path)
1564
if not isdir(dirabs):
1565
# e.g. directory deleted
1569
for subf in os.listdir(dirabs):
1572
if subf not in dir_entry.children:
1573
subf_norm, can_access = osutils.normalized_filename(subf)
1574
if subf_norm != subf and can_access:
1575
if subf_norm not in dir_entry.children:
1576
fl.append(subf_norm)
1582
subp = pathjoin(path, subf)
1585
def ignored_files(self):
1586
"""Yield list of PATH, IGNORE_PATTERN"""
1587
for subp in self.extras():
1588
pat = self.is_ignored(subp)
1592
def get_ignore_list(self):
1593
"""Return list of ignore patterns.
1595
Cached in the Tree object after the first call.
1597
ignoreset = getattr(self, '_ignoreset', None)
1598
if ignoreset is not None:
1601
ignore_globs = set()
1602
ignore_globs.update(ignores.get_runtime_ignores())
1603
ignore_globs.update(ignores.get_user_ignores())
1604
if self.has_filename(bzrlib.IGNORE_FILENAME):
1605
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1607
ignore_globs.update(ignores.parse_ignore_file(f))
1610
self._ignoreset = ignore_globs
1613
def _flush_ignore_list_cache(self):
1614
"""Resets the cached ignore list to force a cache rebuild."""
1615
self._ignoreset = None
1616
self._ignoreglobster = None
1618
def is_ignored(self, filename):
1619
r"""Check whether the filename matches an ignore pattern.
1621
Patterns containing '/' or '\' need to match the whole path;
1622
others match against only the last component.
1624
If the file is ignored, returns the pattern which caused it to
1625
be ignored, otherwise None. So this can simply be used as a
1626
boolean if desired."""
1627
if getattr(self, '_ignoreglobster', None) is None:
1628
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1629
return self._ignoreglobster.match(filename)
1631
def kind(self, file_id):
1632
return file_kind(self.id2abspath(file_id))
1634
def stored_kind(self, file_id):
1635
"""See Tree.stored_kind"""
1636
return self.inventory[file_id].kind
1638
def _comparison_data(self, entry, path):
1639
abspath = self.abspath(path)
1641
stat_value = os.lstat(abspath)
1643
if getattr(e, 'errno', None) == errno.ENOENT:
1650
mode = stat_value.st_mode
1651
kind = osutils.file_kind_from_stat_mode(mode)
1652
if not supports_executable():
1653
executable = entry is not None and entry.executable
1655
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1656
return kind, executable, stat_value
1658
def _file_size(self, entry, stat_value):
1659
return stat_value.st_size
1661
def last_revision(self):
1662
"""Return the last revision of the branch for this tree.
1664
This format tree does not support a separate marker for last-revision
1665
compared to the branch.
1667
See MutableTree.last_revision
1669
return self._last_revision()
1672
def _last_revision(self):
1673
"""helper for get_parent_ids."""
1674
return _mod_revision.ensure_null(self.branch.last_revision())
1676
def is_locked(self):
1677
return self._control_files.is_locked()
1679
def _must_be_locked(self):
1680
if not self.is_locked():
1681
raise errors.ObjectNotLocked(self)
1683
def lock_read(self):
1684
"""See Branch.lock_read, and WorkingTree.unlock."""
1685
if not self.is_locked():
1687
self.branch.lock_read()
1689
return self._control_files.lock_read()
1691
self.branch.unlock()
1694
def lock_tree_write(self):
1695
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1696
if not self.is_locked():
1698
self.branch.lock_read()
1700
return self._control_files.lock_write()
1702
self.branch.unlock()
1705
def lock_write(self):
1706
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1707
if not self.is_locked():
1709
self.branch.lock_write()
1711
return self._control_files.lock_write()
1713
self.branch.unlock()
1716
def get_physical_lock_status(self):
1717
return self._control_files.get_physical_lock_status()
1719
def _basis_inventory_name(self):
1720
return 'basis-inventory-cache'
1722
def _reset_data(self):
1723
"""Reset transient data that cannot be revalidated."""
1724
self._inventory_is_modified = False
1725
result = self._deserialize(self._control_files.get('inventory'))
1726
self._set_inventory(result, dirty=False)
1728
@needs_tree_write_lock
1729
def set_last_revision(self, new_revision):
1730
"""Change the last revision in the working tree."""
1731
if self._change_last_revision(new_revision):
1732
self._cache_basis_inventory(new_revision)
1734
def _change_last_revision(self, new_revision):
1735
"""Template method part of set_last_revision to perform the change.
1737
This is used to allow WorkingTree3 instances to not affect branch
1738
when their last revision is set.
1740
if _mod_revision.is_null(new_revision):
1741
self.branch.set_revision_history([])
1744
self.branch.generate_revision_history(new_revision)
1745
except errors.NoSuchRevision:
1746
# not present in the repo - dont try to set it deeper than the tip
1747
self.branch.set_revision_history([new_revision])
1750
def _write_basis_inventory(self, xml):
1751
"""Write the basis inventory XML to the basis-inventory file"""
1752
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1753
path = self._basis_inventory_name()
1755
self._control_files.put(path, sio)
1757
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1758
"""Create the text that will be saved in basis-inventory"""
1759
inventory.revision_id = revision_id
1760
return xml7.serializer_v7.write_inventory_to_string(inventory)
1762
def _cache_basis_inventory(self, new_revision):
1763
"""Cache new_revision as the basis inventory."""
1764
# TODO: this should allow the ready-to-use inventory to be passed in,
1765
# as commit already has that ready-to-use [while the format is the
1768
# this double handles the inventory - unpack and repack -
1769
# but is easier to understand. We can/should put a conditional
1770
# in here based on whether the inventory is in the latest format
1771
# - perhaps we should repack all inventories on a repository
1773
# the fast path is to copy the raw xml from the repository. If the
1774
# xml contains 'revision_id="', then we assume the right
1775
# revision_id is set. We must check for this full string, because a
1776
# root node id can legitimately look like 'revision_id' but cannot
1778
xml = self.branch.repository.get_inventory_xml(new_revision)
1779
firstline = xml.split('\n', 1)[0]
1780
if (not 'revision_id="' in firstline or
1781
'format="7"' not in firstline):
1782
inv = self.branch.repository.deserialise_inventory(
1784
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1785
self._write_basis_inventory(xml)
1786
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1789
def read_basis_inventory(self):
1790
"""Read the cached basis inventory."""
1791
path = self._basis_inventory_name()
1792
return self._control_files.get(path).read()
1795
def read_working_inventory(self):
1796
"""Read the working inventory.
1798
:raises errors.InventoryModified: read_working_inventory will fail
1799
when the current in memory inventory has been modified.
1801
# conceptually this should be an implementation detail of the tree.
1802
# XXX: Deprecate this.
1803
# ElementTree does its own conversion from UTF-8, so open in
1805
if self._inventory_is_modified:
1806
raise errors.InventoryModified(self)
1807
result = self._deserialize(self._control_files.get('inventory'))
1808
self._set_inventory(result, dirty=False)
1811
@needs_tree_write_lock
1812
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1814
"""Remove nominated files from the working inventory.
1816
:files: File paths relative to the basedir.
1817
:keep_files: If true, the files will also be kept.
1818
:force: Delete files and directories, even if they are changed and
1819
even if the directories are not empty.
1821
if isinstance(files, basestring):
1827
unknown_nested_files=set()
1829
def recurse_directory_to_add_files(directory):
1830
# Recurse directory and add all files
1831
# so we can check if they have changed.
1832
for parent_info, file_infos in\
1833
osutils.walkdirs(self.abspath(directory),
1835
for relpath, basename, kind, lstat, abspath in file_infos:
1836
# Is it versioned or ignored?
1837
if self.path2id(relpath) or self.is_ignored(relpath):
1838
# Add nested content for deletion.
1839
new_files.add(relpath)
1841
# Files which are not versioned and not ignored
1842
# should be treated as unknown.
1843
unknown_nested_files.add((relpath, None, kind))
1845
for filename in files:
1846
# Get file name into canonical form.
1847
abspath = self.abspath(filename)
1848
filename = self.relpath(abspath)
1849
if len(filename) > 0:
1850
new_files.add(filename)
1851
if osutils.isdir(abspath):
1852
recurse_directory_to_add_files(filename)
1854
files = list(new_files)
1857
return # nothing to do
1859
# Sort needed to first handle directory content before the directory
1860
files.sort(reverse=True)
1862
# Bail out if we are going to delete files we shouldn't
1863
if not keep_files and not force:
1864
has_changed_files = len(unknown_nested_files) > 0
1865
if not has_changed_files:
1866
for (file_id, path, content_change, versioned, parent_id, name,
1867
kind, executable) in self.iter_changes(self.basis_tree(),
1868
include_unchanged=True, require_versioned=False,
1869
want_unversioned=True, specific_files=files):
1870
if versioned == (False, False):
1871
# The record is unknown ...
1872
if not self.is_ignored(path[1]):
1873
# ... but not ignored
1874
has_changed_files = True
1876
elif content_change and (kind[1] != None):
1877
# Versioned and changed, but not deleted
1878
has_changed_files = True
1881
if has_changed_files:
1882
# Make delta show ALL applicable changes in error message.
1883
tree_delta = self.changes_from(self.basis_tree(),
1884
require_versioned=False, want_unversioned=True,
1885
specific_files=files)
1886
for unknown_file in unknown_nested_files:
1887
if unknown_file not in tree_delta.unversioned:
1888
tree_delta.unversioned.extend((unknown_file,))
1889
raise errors.BzrRemoveChangedFilesError(tree_delta)
1891
# Build inv_delta and delete files where applicaple,
1892
# do this before any modifications to inventory.
1894
fid = self.path2id(f)
1897
message = "%s is not versioned." % (f,)
1900
# having removed it, it must be either ignored or unknown
1901
if self.is_ignored(f):
1905
textui.show_status(new_status, self.kind(fid), f,
1908
inv_delta.append((f, None, fid, None))
1909
message = "removed %s" % (f,)
1912
abs_path = self.abspath(f)
1913
if osutils.lexists(abs_path):
1914
if (osutils.isdir(abs_path) and
1915
len(os.listdir(abs_path)) > 0):
1917
osutils.rmtree(abs_path)
1919
message = "%s is not an empty directory "\
1920
"and won't be deleted." % (f,)
1922
osutils.delete_any(abs_path)
1923
message = "deleted %s" % (f,)
1924
elif message is not None:
1925
# Only care if we haven't done anything yet.
1926
message = "%s does not exist." % (f,)
1928
# Print only one message (if any) per file.
1929
if message is not None:
1931
self.apply_inventory_delta(inv_delta)
1933
@needs_tree_write_lock
1934
def revert(self, filenames=None, old_tree=None, backups=True,
1935
pb=DummyProgress(), report_changes=False):
1936
from bzrlib.conflicts import resolve
1939
symbol_versioning.warn('Using [] to revert all files is deprecated'
1940
' as of bzr 0.91. Please use None (the default) instead.',
1941
DeprecationWarning, stacklevel=2)
1942
if old_tree is None:
1943
basis_tree = self.basis_tree()
1944
basis_tree.lock_read()
1945
old_tree = basis_tree
1949
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1951
if filenames is None and len(self.get_parent_ids()) > 1:
1953
last_revision = self.last_revision()
1954
if last_revision != NULL_REVISION:
1955
if basis_tree is None:
1956
basis_tree = self.basis_tree()
1957
basis_tree.lock_read()
1958
parent_trees.append((last_revision, basis_tree))
1959
self.set_parent_trees(parent_trees)
1962
resolve(self, filenames, ignore_misses=True, recursive=True)
1964
if basis_tree is not None:
1968
def revision_tree(self, revision_id):
1969
"""See Tree.revision_tree.
1971
WorkingTree can supply revision_trees for the basis revision only
1972
because there is only one cached inventory in the bzr directory.
1974
if revision_id == self.last_revision():
1976
xml = self.read_basis_inventory()
1977
except errors.NoSuchFile:
1981
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1982
# dont use the repository revision_tree api because we want
1983
# to supply the inventory.
1984
if inv.revision_id == revision_id:
1985
return revisiontree.RevisionTree(self.branch.repository,
1987
except errors.BadInventoryFormat:
1989
# raise if there was no inventory, or if we read the wrong inventory.
1990
raise errors.NoSuchRevisionInTree(self, revision_id)
1992
# XXX: This method should be deprecated in favour of taking in a proper
1993
# new Inventory object.
1994
@needs_tree_write_lock
1995
def set_inventory(self, new_inventory_list):
1996
from bzrlib.inventory import (Inventory,
2001
inv = Inventory(self.get_root_id())
2002
for path, file_id, parent, kind in new_inventory_list:
2003
name = os.path.basename(path)
2006
# fixme, there should be a factory function inv,add_??
2007
if kind == 'directory':
2008
inv.add(InventoryDirectory(file_id, name, parent))
2009
elif kind == 'file':
2010
inv.add(InventoryFile(file_id, name, parent))
2011
elif kind == 'symlink':
2012
inv.add(InventoryLink(file_id, name, parent))
2014
raise errors.BzrError("unknown kind %r" % kind)
2015
self._write_inventory(inv)
2017
@needs_tree_write_lock
2018
def set_root_id(self, file_id):
2019
"""Set the root id for this tree."""
2023
'WorkingTree.set_root_id with fileid=None')
2024
file_id = osutils.safe_file_id(file_id)
2025
self._set_root_id(file_id)
2027
def _set_root_id(self, file_id):
2028
"""Set the root id for this tree, in a format specific manner.
2030
:param file_id: The file id to assign to the root. It must not be
2031
present in the current inventory or an error will occur. It must
2032
not be None, but rather a valid file id.
2034
inv = self._inventory
2035
orig_root_id = inv.root.file_id
2036
# TODO: it might be nice to exit early if there was nothing
2037
# to do, saving us from trigger a sync on unlock.
2038
self._inventory_is_modified = True
2039
# we preserve the root inventory entry object, but
2040
# unlinkit from the byid index
2041
del inv._byid[inv.root.file_id]
2042
inv.root.file_id = file_id
2043
# and link it into the index with the new changed id.
2044
inv._byid[inv.root.file_id] = inv.root
2045
# and finally update all children to reference the new id.
2046
# XXX: this should be safe to just look at the root.children
2047
# list, not the WHOLE INVENTORY.
2050
if entry.parent_id == orig_root_id:
2051
entry.parent_id = inv.root.file_id
2054
"""See Branch.unlock.
2056
WorkingTree locking just uses the Branch locking facilities.
2057
This is current because all working trees have an embedded branch
2058
within them. IF in the future, we were to make branch data shareable
2059
between multiple working trees, i.e. via shared storage, then we
2060
would probably want to lock both the local tree, and the branch.
2062
raise NotImplementedError(self.unlock)
2064
def update(self, change_reporter=None, possible_transports=None):
2065
"""Update a working tree along its branch.
2067
This will update the branch if its bound too, which means we have
2068
multiple trees involved:
2070
- The new basis tree of the master.
2071
- The old basis tree of the branch.
2072
- The old basis tree of the working tree.
2073
- The current working tree state.
2075
Pathologically, all three may be different, and non-ancestors of each
2076
other. Conceptually we want to:
2078
- Preserve the wt.basis->wt.state changes
2079
- Transform the wt.basis to the new master basis.
2080
- Apply a merge of the old branch basis to get any 'local' changes from
2082
- Restore the wt.basis->wt.state changes.
2084
There isn't a single operation at the moment to do that, so we:
2085
- Merge current state -> basis tree of the master w.r.t. the old tree
2087
- Do a 'normal' merge of the old branch basis if it is relevant.
2089
if self.branch.get_bound_location() is not None:
2091
update_branch = True
2093
self.lock_tree_write()
2094
update_branch = False
2097
old_tip = self.branch.update(possible_transports)
2100
return self._update_tree(old_tip, change_reporter)
2104
@needs_tree_write_lock
2105
def _update_tree(self, old_tip=None, change_reporter=None):
2106
"""Update a tree to the master branch.
2108
:param old_tip: if supplied, the previous tip revision the branch,
2109
before it was changed to the master branch's tip.
2111
# here if old_tip is not None, it is the old tip of the branch before
2112
# it was updated from the master branch. This should become a pending
2113
# merge in the working tree to preserve the user existing work. we
2114
# cant set that until we update the working trees last revision to be
2115
# one from the new branch, because it will just get absorbed by the
2116
# parent de-duplication logic.
2118
# We MUST save it even if an error occurs, because otherwise the users
2119
# local work is unreferenced and will appear to have been lost.
2123
last_rev = self.get_parent_ids()[0]
2125
last_rev = _mod_revision.NULL_REVISION
2126
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2127
# merge tree state up to new branch tip.
2128
basis = self.basis_tree()
2131
to_tree = self.branch.basis_tree()
2132
if basis.inventory.root is None:
2133
self.set_root_id(to_tree.get_root_id())
2135
result += merge.merge_inner(
2140
change_reporter=change_reporter)
2143
# TODO - dedup parents list with things merged by pull ?
2144
# reuse the tree we've updated to to set the basis:
2145
parent_trees = [(self.branch.last_revision(), to_tree)]
2146
merges = self.get_parent_ids()[1:]
2147
# Ideally we ask the tree for the trees here, that way the working
2148
# tree can decide whether to give us teh entire tree or give us a
2149
# lazy initialised tree. dirstate for instance will have the trees
2150
# in ram already, whereas a last-revision + basis-inventory tree
2151
# will not, but also does not need them when setting parents.
2152
for parent in merges:
2153
parent_trees.append(
2154
(parent, self.branch.repository.revision_tree(parent)))
2155
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2156
parent_trees.append(
2157
(old_tip, self.branch.repository.revision_tree(old_tip)))
2158
self.set_parent_trees(parent_trees)
2159
last_rev = parent_trees[0][0]
2161
# the working tree had the same last-revision as the master
2162
# branch did. We may still have pivot local work from the local
2163
# branch into old_tip:
2164
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2165
self.add_parent_tree_id(old_tip)
2166
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2167
and old_tip != last_rev):
2168
# our last revision was not the prior branch last revision
2169
# and we have converted that last revision to a pending merge.
2170
# base is somewhere between the branch tip now
2171
# and the now pending merge
2173
# Since we just modified the working tree and inventory, flush out
2174
# the current state, before we modify it again.
2175
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2176
# requires it only because TreeTransform directly munges the
2177
# inventory and calls tree._write_inventory(). Ultimately we
2178
# should be able to remove this extra flush.
2180
graph = self.branch.repository.get_graph()
2181
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2183
base_tree = self.branch.repository.revision_tree(base_rev_id)
2184
other_tree = self.branch.repository.revision_tree(old_tip)
2185
result += merge.merge_inner(
2190
change_reporter=change_reporter)
2193
def _write_hashcache_if_dirty(self):
2194
"""Write out the hashcache if it is dirty."""
2195
if self._hashcache.needs_write:
2197
self._hashcache.write()
2199
if e.errno not in (errno.EPERM, errno.EACCES):
2201
# TODO: jam 20061219 Should this be a warning? A single line
2202
# warning might be sufficient to let the user know what
2204
mutter('Could not write hashcache for %s\nError: %s',
2205
self._hashcache.cache_file_name(), e)
2207
@needs_tree_write_lock
2208
def _write_inventory(self, inv):
2209
"""Write inventory as the current inventory."""
2210
self._set_inventory(inv, dirty=True)
2213
def set_conflicts(self, arg):
2214
raise errors.UnsupportedOperation(self.set_conflicts, self)
2216
def add_conflicts(self, arg):
2217
raise errors.UnsupportedOperation(self.add_conflicts, self)
2220
def conflicts(self):
2221
conflicts = _mod_conflicts.ConflictList()
2222
for conflicted in self._iter_conflicts():
2225
if file_kind(self.abspath(conflicted)) != "file":
2227
except errors.NoSuchFile:
2230
for suffix in ('.THIS', '.OTHER'):
2232
kind = file_kind(self.abspath(conflicted+suffix))
2235
except errors.NoSuchFile:
2239
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2240
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2242
file_id=self.path2id(conflicted)))
2245
def walkdirs(self, prefix=""):
2246
"""Walk the directories of this tree.
2248
returns a generator which yields items in the form:
2249
((curren_directory_path, fileid),
2250
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2253
This API returns a generator, which is only valid during the current
2254
tree transaction - within a single lock_read or lock_write duration.
2256
If the tree is not locked, it may cause an error to be raised,
2257
depending on the tree implementation.
2259
disk_top = self.abspath(prefix)
2260
if disk_top.endswith('/'):
2261
disk_top = disk_top[:-1]
2262
top_strip_len = len(disk_top) + 1
2263
inventory_iterator = self._walkdirs(prefix)
2264
disk_iterator = osutils.walkdirs(disk_top, prefix)
2266
current_disk = disk_iterator.next()
2267
disk_finished = False
2269
if not (e.errno == errno.ENOENT or
2270
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2273
disk_finished = True
2275
current_inv = inventory_iterator.next()
2276
inv_finished = False
2277
except StopIteration:
2280
while not inv_finished or not disk_finished:
2282
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2283
cur_disk_dir_content) = current_disk
2285
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2286
cur_disk_dir_content) = ((None, None), None)
2287
if not disk_finished:
2288
# strip out .bzr dirs
2289
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2290
len(cur_disk_dir_content) > 0):
2291
# osutils.walkdirs can be made nicer -
2292
# yield the path-from-prefix rather than the pathjoined
2294
bzrdir_loc = bisect_left(cur_disk_dir_content,
2296
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2297
# we dont yield the contents of, or, .bzr itself.
2298
del cur_disk_dir_content[bzrdir_loc]
2300
# everything is unknown
2303
# everything is missing
2306
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2308
# disk is before inventory - unknown
2309
dirblock = [(relpath, basename, kind, stat, None, None) for
2310
relpath, basename, kind, stat, top_path in
2311
cur_disk_dir_content]
2312
yield (cur_disk_dir_relpath, None), dirblock
2314
current_disk = disk_iterator.next()
2315
except StopIteration:
2316
disk_finished = True
2318
# inventory is before disk - missing.
2319
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2320
for relpath, basename, dkind, stat, fileid, kind in
2322
yield (current_inv[0][0], current_inv[0][1]), dirblock
2324
current_inv = inventory_iterator.next()
2325
except StopIteration:
2328
# versioned present directory
2329
# merge the inventory and disk data together
2331
for relpath, subiterator in itertools.groupby(sorted(
2332
current_inv[1] + cur_disk_dir_content,
2333
key=operator.itemgetter(0)), operator.itemgetter(1)):
2334
path_elements = list(subiterator)
2335
if len(path_elements) == 2:
2336
inv_row, disk_row = path_elements
2337
# versioned, present file
2338
dirblock.append((inv_row[0],
2339
inv_row[1], disk_row[2],
2340
disk_row[3], inv_row[4],
2342
elif len(path_elements[0]) == 5:
2344
dirblock.append((path_elements[0][0],
2345
path_elements[0][1], path_elements[0][2],
2346
path_elements[0][3], None, None))
2347
elif len(path_elements[0]) == 6:
2348
# versioned, absent file.
2349
dirblock.append((path_elements[0][0],
2350
path_elements[0][1], 'unknown', None,
2351
path_elements[0][4], path_elements[0][5]))
2353
raise NotImplementedError('unreachable code')
2354
yield current_inv[0], dirblock
2356
current_inv = inventory_iterator.next()
2357
except StopIteration:
2360
current_disk = disk_iterator.next()
2361
except StopIteration:
2362
disk_finished = True
2364
def _walkdirs(self, prefix=""):
2365
"""Walk the directories of this tree.
2367
:prefix: is used as the directrory to start with.
2368
returns a generator which yields items in the form:
2369
((curren_directory_path, fileid),
2370
[(file1_path, file1_name, file1_kind, None, file1_id,
2373
_directory = 'directory'
2374
# get the root in the inventory
2375
inv = self.inventory
2376
top_id = inv.path2id(prefix)
2380
pending = [(prefix, '', _directory, None, top_id, None)]
2383
currentdir = pending.pop()
2384
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2385
top_id = currentdir[4]
2387
relroot = currentdir[0] + '/'
2390
# FIXME: stash the node in pending
2392
for name, child in entry.sorted_children():
2393
dirblock.append((relroot + name, name, child.kind, None,
2394
child.file_id, child.kind
2396
yield (currentdir[0], entry.file_id), dirblock
2397
# push the user specified dirs from dirblock
2398
for dir in reversed(dirblock):
2399
if dir[2] == _directory:
2402
@needs_tree_write_lock
2403
def auto_resolve(self):
2404
"""Automatically resolve text conflicts according to contents.
2406
Only text conflicts are auto_resolvable. Files with no conflict markers
2407
are considered 'resolved', because bzr always puts conflict markers
2408
into files that have text conflicts. The corresponding .THIS .BASE and
2409
.OTHER files are deleted, as per 'resolve'.
2410
:return: a tuple of ConflictLists: (un_resolved, resolved).
2412
un_resolved = _mod_conflicts.ConflictList()
2413
resolved = _mod_conflicts.ConflictList()
2414
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2415
for conflict in self.conflicts():
2416
if (conflict.typestring != 'text conflict' or
2417
self.kind(conflict.file_id) != 'file'):
2418
un_resolved.append(conflict)
2420
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2422
for line in my_file:
2423
if conflict_re.search(line):
2424
un_resolved.append(conflict)
2427
resolved.append(conflict)
2430
resolved.remove_files(self)
2431
self.set_conflicts(un_resolved)
2432
return un_resolved, resolved
2434
def _validate(self):
2435
"""Validate internal structures.
2437
This is meant mostly for the test suite. To give it a chance to detect
2438
corruption after actions have occurred. The default implementation is a
2441
:return: None. An exception should be raised if there is an error.
2446
class WorkingTree2(WorkingTree):
2447
"""This is the Format 2 working tree.
2449
This was the first weave based working tree.
2450
- uses os locks for locking.
2451
- uses the branch last-revision.
2454
def __init__(self, *args, **kwargs):
2455
super(WorkingTree2, self).__init__(*args, **kwargs)
2456
# WorkingTree2 has more of a constraint that self._inventory must
2457
# exist. Because this is an older format, we don't mind the overhead
2458
# caused by the extra computation here.
2460
# Newer WorkingTree's should only have self._inventory set when they
2462
if self._inventory is None:
2463
self.read_working_inventory()
2465
def lock_tree_write(self):
2466
"""See WorkingTree.lock_tree_write().
2468
In Format2 WorkingTrees we have a single lock for the branch and tree
2469
so lock_tree_write() degrades to lock_write().
2471
self.branch.lock_write()
2473
return self._control_files.lock_write()
2475
self.branch.unlock()
2479
# do non-implementation specific cleanup
2482
# we share control files:
2483
if self._control_files._lock_count == 3:
2484
# _inventory_is_modified is always False during a read lock.
2485
if self._inventory_is_modified:
2487
self._write_hashcache_if_dirty()
2489
# reverse order of locking.
2491
return self._control_files.unlock()
2493
self.branch.unlock()
2496
class WorkingTree3(WorkingTree):
2497
"""This is the Format 3 working tree.
2499
This differs from the base WorkingTree by:
2500
- having its own file lock
2501
- having its own last-revision property.
2503
This is new in bzr 0.8
2507
def _last_revision(self):
2508
"""See Mutable.last_revision."""
2510
return self._control_files.get('last-revision').read()
2511
except errors.NoSuchFile:
2512
return _mod_revision.NULL_REVISION
2514
def _change_last_revision(self, revision_id):
2515
"""See WorkingTree._change_last_revision."""
2516
if revision_id is None or revision_id == NULL_REVISION:
2518
self._control_files._transport.delete('last-revision')
2519
except errors.NoSuchFile:
2523
self._control_files.put_bytes('last-revision', revision_id)
2526
@needs_tree_write_lock
2527
def set_conflicts(self, conflicts):
2528
self._put_rio('conflicts', conflicts.to_stanzas(),
2531
@needs_tree_write_lock
2532
def add_conflicts(self, new_conflicts):
2533
conflict_set = set(self.conflicts())
2534
conflict_set.update(set(list(new_conflicts)))
2535
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2536
key=_mod_conflicts.Conflict.sort_key)))
2539
def conflicts(self):
2541
confile = self._control_files.get('conflicts')
2542
except errors.NoSuchFile:
2543
return _mod_conflicts.ConflictList()
2545
if confile.next() != CONFLICT_HEADER_1 + '\n':
2546
raise errors.ConflictFormatError()
2547
except StopIteration:
2548
raise errors.ConflictFormatError()
2549
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2552
# do non-implementation specific cleanup
2554
if self._control_files._lock_count == 1:
2555
# _inventory_is_modified is always False during a read lock.
2556
if self._inventory_is_modified:
2558
self._write_hashcache_if_dirty()
2559
# reverse order of locking.
2561
return self._control_files.unlock()
2563
self.branch.unlock()
2566
def get_conflicted_stem(path):
2567
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2568
if path.endswith(suffix):
2569
return path[:-len(suffix)]
2572
class WorkingTreeFormat(object):
2573
"""An encapsulation of the initialization and open routines for a format.
2575
Formats provide three things:
2576
* An initialization routine,
2580
Formats are placed in an dict by their format string for reference
2581
during workingtree opening. Its not required that these be instances, they
2582
can be classes themselves with class methods - it simply depends on
2583
whether state is needed for a given format or not.
2585
Once a format is deprecated, just deprecate the initialize and open
2586
methods on the format class. Do not deprecate the object, as the
2587
object will be created every time regardless.
2590
_default_format = None
2591
"""The default format used for new trees."""
2594
"""The known formats."""
2596
requires_rich_root = False
2598
upgrade_recommended = False
2601
def find_format(klass, a_bzrdir):
2602
"""Return the format for the working tree object in a_bzrdir."""
2604
transport = a_bzrdir.get_workingtree_transport(None)
2605
format_string = transport.get("format").read()
2606
return klass._formats[format_string]
2607
except errors.NoSuchFile:
2608
raise errors.NoWorkingTree(base=transport.base)
2610
raise errors.UnknownFormatError(format=format_string,
2611
kind="working tree")
2613
def __eq__(self, other):
2614
return self.__class__ is other.__class__
2616
def __ne__(self, other):
2617
return not (self == other)
2620
def get_default_format(klass):
2621
"""Return the current default format."""
2622
return klass._default_format
2624
def get_format_string(self):
2625
"""Return the ASCII format string that identifies this format."""
2626
raise NotImplementedError(self.get_format_string)
2628
def get_format_description(self):
2629
"""Return the short description for this format."""
2630
raise NotImplementedError(self.get_format_description)
2632
def is_supported(self):
2633
"""Is this format supported?
2635
Supported formats can be initialized and opened.
2636
Unsupported formats may not support initialization or committing or
2637
some other features depending on the reason for not being supported.
2642
def register_format(klass, format):
2643
klass._formats[format.get_format_string()] = format
2646
def set_default_format(klass, format):
2647
klass._default_format = format
2650
def unregister_format(klass, format):
2651
assert klass._formats[format.get_format_string()] is format
2652
del klass._formats[format.get_format_string()]
2655
class WorkingTreeFormat2(WorkingTreeFormat):
2656
"""The second working tree format.
2658
This format modified the hash cache from the format 1 hash cache.
2661
upgrade_recommended = True
2663
def get_format_description(self):
2664
"""See WorkingTreeFormat.get_format_description()."""
2665
return "Working tree format 2"
2667
def stub_initialize_remote(self, control_files):
2668
"""As a special workaround create critical control files for a remote working tree
2670
This ensures that it can later be updated and dealt with locally,
2671
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2672
no working tree. (See bug #43064).
2676
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2678
control_files.put('inventory', sio)
2680
control_files.put_bytes('pending-merges', '')
2683
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2684
accelerator_tree=None, hardlink=False):
2685
"""See WorkingTreeFormat.initialize()."""
2686
if not isinstance(a_bzrdir.transport, LocalTransport):
2687
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2688
if from_branch is not None:
2689
branch = from_branch
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.get_root_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, from_branch=None,
2777
accelerator_tree=None, hardlink=False):
2778
"""See WorkingTreeFormat.initialize().
2780
:param revision_id: if supplied, create a working tree at a different
2781
revision than the branch is at.
2782
:param accelerator_tree: A tree which can be used for retrieving file
2783
contents more quickly than the revision tree, i.e. a workingtree.
2784
The revision tree will be used for cases where accelerator_tree's
2785
content is different.
2786
:param hardlink: If true, hard-link files from accelerator_tree,
2789
if not isinstance(a_bzrdir.transport, LocalTransport):
2790
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2791
transport = a_bzrdir.get_workingtree_transport(self)
2792
control_files = self._open_control_files(a_bzrdir)
2793
control_files.create_lock()
2794
control_files.lock_write()
2795
control_files.put_utf8('format', self.get_format_string())
2796
if from_branch is not None:
2797
branch = from_branch
2799
branch = a_bzrdir.open_branch()
2800
if revision_id is None:
2801
revision_id = _mod_revision.ensure_null(branch.last_revision())
2802
# WorkingTree3 can handle an inventory which has a unique root id.
2803
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2804
# those trees. And because there isn't a format bump inbetween, we
2805
# are maintaining compatibility with older clients.
2806
# inv = Inventory(root_id=gen_root_id())
2807
inv = self._initial_inventory()
2808
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2814
_control_files=control_files)
2815
wt.lock_tree_write()
2817
basis_tree = branch.repository.revision_tree(revision_id)
2818
# only set an explicit root id if there is one to set.
2819
if basis_tree.inventory.root is not None:
2820
wt.set_root_id(basis_tree.get_root_id())
2821
if revision_id == NULL_REVISION:
2822
wt.set_parent_trees([])
2824
wt.set_parent_trees([(revision_id, basis_tree)])
2825
transform.build_tree(basis_tree, wt)
2827
# Unlock in this order so that the unlock-triggers-flush in
2828
# WorkingTree is given a chance to fire.
2829
control_files.unlock()
2833
def _initial_inventory(self):
2837
super(WorkingTreeFormat3, self).__init__()
2839
def open(self, a_bzrdir, _found=False):
2840
"""Return the WorkingTree object for a_bzrdir
2842
_found is a private parameter, do not use it. It is used to indicate
2843
if format probing has already been done.
2846
# we are being called directly and must probe.
2847
raise NotImplementedError
2848
if not isinstance(a_bzrdir.transport, LocalTransport):
2849
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2850
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2853
def _open(self, a_bzrdir, control_files):
2854
"""Open the tree itself.
2856
:param a_bzrdir: the dir for the tree.
2857
:param control_files: the control files for the tree.
2859
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2863
_control_files=control_files)
2866
return self.get_format_string()
2869
__default_format = WorkingTreeFormat4()
2870
WorkingTreeFormat.register_format(__default_format)
2871
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2872
WorkingTreeFormat.set_default_format(__default_format)
2873
# formats which have no format string are not discoverable
2874
# and not independently creatable, so are not registered.
2875
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
