1
# Copyright (C) 2005, 2006, 2007, 2008 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,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
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
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib import osutils
94
from bzrlib.osutils import (
106
from bzrlib.filters import filtered_input_file
107
from bzrlib.trace import mutter, note
108
from bzrlib.transport.local import LocalTransport
109
from bzrlib.progress import DummyProgress, ProgressPhase
110
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
111
from bzrlib.rio import RioReader, rio_file, Stanza
112
from bzrlib.symbol_versioning import (deprecated_passed,
115
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
125
class TreeEntry(object):
126
"""An entry that implements the minimum interface used by commands.
128
This needs further inspection, it may be better to have
129
InventoryEntries without ids - though that seems wrong. For now,
130
this is a parallel hierarchy to InventoryEntry, and needs to become
131
one of several things: decorates to that hierarchy, children of, or
133
Another note is that these objects are currently only used when there is
134
no InventoryEntry available - i.e. for unversioned objects.
135
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
138
def __eq__(self, other):
139
# yes, this us ugly, TODO: best practice __eq__ style.
140
return (isinstance(other, TreeEntry)
141
and other.__class__ == self.__class__)
143
def kind_character(self):
147
class TreeDirectory(TreeEntry):
148
"""See TreeEntry. This is a directory in a working tree."""
150
def __eq__(self, other):
151
return (isinstance(other, TreeDirectory)
152
and other.__class__ == self.__class__)
154
def kind_character(self):
158
class TreeFile(TreeEntry):
159
"""See TreeEntry. This is a regular file in a working tree."""
161
def __eq__(self, other):
162
return (isinstance(other, TreeFile)
163
and other.__class__ == self.__class__)
165
def kind_character(self):
169
class TreeLink(TreeEntry):
170
"""See TreeEntry. This is a symlink in a working tree."""
172
def __eq__(self, other):
173
return (isinstance(other, TreeLink)
174
and other.__class__ == self.__class__)
176
def kind_character(self):
180
class WorkingTree(bzrlib.mutabletree.MutableTree):
181
"""Working copy tree.
183
The inventory is held in the `Branch` working-inventory, and the
184
files are in a directory on disk.
186
It is possible for a `WorkingTree` to have a filename which is
187
not listed in the Inventory and vice versa.
190
# override this to set the strategy for storing views
191
def _make_views(self):
192
return views.DisabledViews(self)
194
def __init__(self, basedir='.',
195
branch=DEPRECATED_PARAMETER,
201
"""Construct a WorkingTree instance. This is not a public API.
203
:param branch: A branch to override probing for the branch.
205
self._format = _format
206
self.bzrdir = _bzrdir
208
raise errors.BzrError("Please use bzrdir.open_workingtree or "
209
"WorkingTree.open() to obtain a WorkingTree.")
210
basedir = safe_unicode(basedir)
211
mutter("opening working tree %r", basedir)
212
if deprecated_passed(branch):
213
self._branch = branch
215
self._branch = self.bzrdir.open_branch()
216
self.basedir = realpath(basedir)
217
# if branch is at our basedir and is a format 6 or less
218
if isinstance(self._format, WorkingTreeFormat2):
219
# share control object
220
self._control_files = self.branch.control_files
222
# assume all other formats have their own control files.
223
self._control_files = _control_files
224
self._transport = self._control_files._transport
225
# update the whole cache up front and write to disk if anything changed;
226
# in the future we might want to do this more selectively
227
# two possible ways offer themselves : in self._unlock, write the cache
228
# if needed, or, when the cache sees a change, append it to the hash
229
# cache file, and have the parser take the most recent entry for a
231
wt_trans = self.bzrdir.get_workingtree_transport(None)
232
cache_filename = wt_trans.local_abspath('stat-cache')
233
self._hashcache = hashcache.HashCache(basedir, cache_filename,
234
self.bzrdir._get_file_mode(),
235
self._content_filter_stack_provider())
238
# is this scan needed ? it makes things kinda slow.
245
if _inventory is None:
246
# This will be acquired on lock_read() or lock_write()
247
self._inventory_is_modified = False
248
self._inventory = None
250
# the caller of __init__ has provided an inventory,
251
# we assume they know what they are doing - as its only
252
# the Format factory and creation methods that are
253
# permitted to do this.
254
self._set_inventory(_inventory, dirty=False)
255
self._detect_case_handling()
256
self._rules_searcher = None
257
self.views = self._make_views()
259
def _detect_case_handling(self):
260
wt_trans = self.bzrdir.get_workingtree_transport(None)
262
wt_trans.stat("FoRMaT")
263
except errors.NoSuchFile:
264
self.case_sensitive = True
266
self.case_sensitive = False
268
self._setup_directory_is_tree_reference()
271
fget=lambda self: self._branch,
272
doc="""The branch this WorkingTree is connected to.
274
This cannot be set - it is reflective of the actual disk structure
275
the working tree has been constructed from.
278
def break_lock(self):
279
"""Break a lock if one is present from another instance.
281
Uses the ui factory to ask for confirmation if the lock may be from
284
This will probe the repository for its lock as well.
286
self._control_files.break_lock()
287
self.branch.break_lock()
289
def requires_rich_root(self):
290
return self._format.requires_rich_root
292
def supports_tree_reference(self):
295
def supports_content_filtering(self):
296
return self._format.supports_content_filtering()
298
def supports_views(self):
299
return self.views.supports_views()
301
def _set_inventory(self, inv, dirty):
302
"""Set the internal cached inventory.
304
:param inv: The inventory to set.
305
:param dirty: A boolean indicating whether the inventory is the same
306
logical inventory as whats on disk. If True the inventory is not
307
the same and should be written to disk or data will be lost, if
308
False then the inventory is the same as that on disk and any
309
serialisation would be unneeded overhead.
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = osutils.getcwd()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
352
def find_trees(location):
353
def list_current(transport):
354
return [d for d in transport.list_dir('') if d != '.bzr']
355
def evaluate(bzrdir):
357
tree = bzrdir.open_workingtree()
358
except errors.NoWorkingTree:
362
transport = get_transport(location)
363
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
364
list_current=list_current)
365
return [t for t in iterator if t is not None]
367
# should be deprecated - this is slow and in any case treating them as a
368
# container is (we now know) bad style -- mbp 20070302
369
## @deprecated_method(zero_fifteen)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if osutils.lexists(self.abspath(path)):
381
def all_file_ids(self):
382
"""See Tree.iter_all_file_ids"""
383
return set(self.inventory)
386
return "<%s of %s>" % (self.__class__.__name__,
387
getattr(self, 'basedir', None))
389
def abspath(self, filename):
390
return pathjoin(self.basedir, filename)
392
def basis_tree(self):
393
"""Return RevisionTree for the current last revision.
395
If the left most parent is a ghost then the returned tree will be an
396
empty tree - one obtained by calling
397
repository.revision_tree(NULL_REVISION).
400
revision_id = self.get_parent_ids()[0]
402
# no parents, return an empty revision tree.
403
# in the future this should return the tree for
404
# 'empty:' - the implicit root empty tree.
405
return self.branch.repository.revision_tree(
406
_mod_revision.NULL_REVISION)
408
return self.revision_tree(revision_id)
409
except errors.NoSuchRevision:
411
# No cached copy available, retrieve from the repository.
412
# FIXME? RBC 20060403 should we cache the inventory locally
415
return self.branch.repository.revision_tree(revision_id)
416
except (errors.RevisionNotPresent, errors.NoSuchRevision):
417
# the basis tree *may* be a ghost or a low level error may have
418
# occured. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(
424
_mod_revision.NULL_REVISION)
427
self._flush_ignore_list_cache()
429
def relpath(self, path):
430
"""Return the local path portion from a given path.
432
The path may be absolute or relative. If its a relative path it is
433
interpreted relative to the python current working directory.
435
return osutils.relpath(self.basedir, path)
437
def has_filename(self, filename):
438
return osutils.lexists(self.abspath(filename))
440
def get_file(self, file_id, path=None, filtered=True):
441
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
443
def get_file_with_stat(self, file_id, path=None, filtered=True,
445
"""See MutableTree.get_file_with_stat."""
447
path = self.id2path(file_id)
448
file_obj = self.get_file_byname(path, filtered=False)
449
stat_value = _fstat(file_obj.fileno())
450
if self.supports_content_filtering() and filtered:
451
filters = self._content_filter_stack(path)
452
file_obj = filtered_input_file(file_obj, filters)
453
return (file_obj, stat_value)
455
def get_file_text(self, file_id, path=None, filtered=True):
456
return self.get_file(file_id, path=path, filtered=filtered).read()
458
def get_file_byname(self, filename, filtered=True):
459
path = self.abspath(filename)
461
if self.supports_content_filtering() and filtered:
462
filters = self._content_filter_stack(filename)
463
return filtered_input_file(f, filters)
467
def get_file_lines(self, file_id, path=None, filtered=True):
468
"""See Tree.get_file_lines()"""
469
file = self.get_file(file_id, path, filtered=filtered)
471
return file.readlines()
476
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
477
"""See Tree.annotate_iter
479
This implementation will use the basis tree implementation if possible.
480
Lines not in the basis are attributed to CURRENT_REVISION
482
If there are pending merges, lines added by those merges will be
483
incorrectly attributed to CURRENT_REVISION (but after committing, the
484
attribution will be correct).
486
basis = self.basis_tree()
489
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
512
def _get_ancestors(self, default_revision):
513
ancestors = set([default_revision])
514
for parent_id in self.get_parent_ids():
515
ancestors.update(self.branch.repository.get_ancestry(
516
parent_id, topo_sorted=False))
519
def get_parent_ids(self):
520
"""See Tree.get_parent_ids.
522
This implementation reads the pending merges list and last_revision
523
value and uses that to decide what the parents list should be.
525
last_rev = _mod_revision.ensure_null(self._last_revision())
526
if _mod_revision.NULL_REVISION == last_rev:
531
merges_file = self._transport.get('pending-merges')
532
except errors.NoSuchFile:
535
for l in merges_file.readlines():
536
revision_id = l.rstrip('\n')
537
parents.append(revision_id)
541
def get_root_id(self):
542
"""Return the id of this trees root"""
543
return self._inventory.root.file_id
545
def _get_store_filename(self, file_id):
546
## XXX: badly named; this is not in the store at all
547
return self.abspath(self.id2path(file_id))
550
def clone(self, to_bzrdir, revision_id=None):
551
"""Duplicate this working tree into to_bzr, including all state.
553
Specifically modified files are kept as modified, but
554
ignored and unknown files are discarded.
556
If you want to make a new line of development, see bzrdir.sprout()
559
If not None, the cloned tree will have its last revision set to
560
revision, and and difference between the source trees last revision
561
and this one merged in.
563
# assumes the target bzr dir format is compatible.
564
result = to_bzrdir.create_workingtree()
565
self.copy_content_into(result, revision_id)
569
def copy_content_into(self, tree, revision_id=None):
570
"""Copy the current content and user files of this tree into tree."""
571
tree.set_root_id(self.get_root_id())
572
if revision_id is None:
573
merge.transform_tree(tree, self)
575
# TODO now merge from tree.last_revision to revision (to preserve
576
# user local changes)
577
merge.transform_tree(tree, self)
578
tree.set_parent_ids([revision_id])
580
def id2abspath(self, file_id):
581
return self.abspath(self.id2path(file_id))
583
def has_id(self, file_id):
584
# files that have been deleted are excluded
586
if not inv.has_id(file_id):
588
path = inv.id2path(file_id)
589
return osutils.lexists(self.abspath(path))
591
def has_or_had_id(self, file_id):
592
if file_id == self.inventory.root.file_id:
594
return self.inventory.has_id(file_id)
596
__contains__ = has_id
598
def get_file_size(self, file_id):
599
"""See Tree.get_file_size"""
601
return os.path.getsize(self.id2abspath(file_id))
603
if e.errno != errno.ENOENT:
609
def get_file_sha1(self, file_id, path=None, stat_value=None):
611
path = self._inventory.id2path(file_id)
612
return self._hashcache.get_sha1(path, stat_value)
614
def get_file_mtime(self, file_id, path=None):
616
path = self.inventory.id2path(file_id)
617
return os.lstat(self.abspath(path)).st_mtime
619
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
620
file_id = self.path2id(path)
621
return self._inventory[file_id].executable
623
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
624
mode = stat_result.st_mode
625
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
627
if not supports_executable():
628
def is_executable(self, file_id, path=None):
629
return self._inventory[file_id].executable
631
_is_executable_from_path_and_stat = \
632
_is_executable_from_path_and_stat_from_basis
634
def is_executable(self, file_id, path=None):
636
path = self.id2path(file_id)
637
mode = os.lstat(self.abspath(path)).st_mode
638
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
640
_is_executable_from_path_and_stat = \
641
_is_executable_from_path_and_stat_from_stat
643
@needs_tree_write_lock
644
def _add(self, files, ids, kinds):
645
"""See MutableTree._add."""
646
# TODO: Re-adding a file that is removed in the working copy
647
# should probably put it back with the previous ID.
648
# the read and write working inventory should not occur in this
649
# function - they should be part of lock_write and unlock.
651
for f, file_id, kind in zip(files, ids, kinds):
653
inv.add_path(f, kind=kind)
655
inv.add_path(f, kind=kind, file_id=file_id)
656
self._inventory_is_modified = True
658
@needs_tree_write_lock
659
def _gather_kinds(self, files, kinds):
660
"""See MutableTree._gather_kinds."""
661
for pos, f in enumerate(files):
662
if kinds[pos] is None:
663
fullpath = normpath(self.abspath(f))
665
kinds[pos] = file_kind(fullpath)
667
if e.errno == errno.ENOENT:
668
raise errors.NoSuchFile(fullpath)
671
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
672
"""Add revision_id as a parent.
674
This is equivalent to retrieving the current list of parent ids
675
and setting the list to its value plus revision_id.
677
:param revision_id: The revision id to add to the parent list. It may
678
be a ghost revision as long as its not the first parent to be added,
679
or the allow_leftmost_as_ghost parameter is set True.
680
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
682
parents = self.get_parent_ids() + [revision_id]
683
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
684
or allow_leftmost_as_ghost)
686
@needs_tree_write_lock
687
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
688
"""Add revision_id, tree tuple as a parent.
690
This is equivalent to retrieving the current list of parent trees
691
and setting the list to its value plus parent_tuple. See also
692
add_parent_tree_id - if you only have a parent id available it will be
693
simpler to use that api. If you have the parent already available, using
694
this api is preferred.
696
:param parent_tuple: The (revision id, tree) to add to the parent list.
697
If the revision_id is a ghost, pass None for the tree.
698
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
700
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
701
if len(parent_ids) > 1:
702
# the leftmost may have already been a ghost, preserve that if it
704
allow_leftmost_as_ghost = True
705
self.set_parent_ids(parent_ids,
706
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
708
@needs_tree_write_lock
709
def add_pending_merge(self, *revision_ids):
710
# TODO: Perhaps should check at this point that the
711
# history of the revision is actually present?
712
parents = self.get_parent_ids()
714
for rev_id in revision_ids:
715
if rev_id in parents:
717
parents.append(rev_id)
720
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
722
def path_content_summary(self, path, _lstat=os.lstat,
723
_mapper=osutils.file_kind_from_stat_mode):
724
"""See Tree.path_content_summary."""
725
abspath = self.abspath(path)
727
stat_result = _lstat(abspath)
729
if getattr(e, 'errno', None) == errno.ENOENT:
731
return ('missing', None, None, None)
732
# propagate other errors
734
kind = _mapper(stat_result.st_mode)
736
size = stat_result.st_size
737
# try for a stat cache lookup
738
executable = self._is_executable_from_path_and_stat(path, stat_result)
739
return (kind, size, executable, self._sha_from_stat(
741
elif kind == 'directory':
742
# perhaps it looks like a plain directory, but it's really a
744
if self._directory_is_tree_reference(path):
745
kind = 'tree-reference'
746
return kind, None, None, None
747
elif kind == 'symlink':
748
return ('symlink', None, None, os.readlink(abspath.encode(osutils._fs_enc)))
750
return (kind, None, None, None)
752
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
753
"""Common ghost checking functionality from set_parent_*.
755
This checks that the left hand-parent exists if there are any
758
if len(revision_ids) > 0:
759
leftmost_id = revision_ids[0]
760
if (not allow_leftmost_as_ghost and not
761
self.branch.repository.has_revision(leftmost_id)):
762
raise errors.GhostRevisionUnusableHere(leftmost_id)
764
def _set_merges_from_parent_ids(self, parent_ids):
765
merges = parent_ids[1:]
766
self._transport.put_bytes('pending-merges', '\n'.join(merges),
767
mode=self._control_files._file_mode)
769
def _filter_parent_ids_by_ancestry(self, revision_ids):
770
"""Check that all merged revisions are proper 'heads'.
772
This will always return the first revision_id, and any merged revisions
775
if len(revision_ids) == 0:
777
graph = self.branch.repository.get_graph()
778
heads = graph.heads(revision_ids)
779
new_revision_ids = revision_ids[:1]
780
for revision_id in revision_ids[1:]:
781
if revision_id in heads and revision_id not in new_revision_ids:
782
new_revision_ids.append(revision_id)
783
if new_revision_ids != revision_ids:
784
trace.mutter('requested to set revision_ids = %s,'
785
' but filtered to %s', revision_ids, new_revision_ids)
786
return new_revision_ids
788
@needs_tree_write_lock
789
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
790
"""Set the parent ids to revision_ids.
792
See also set_parent_trees. This api will try to retrieve the tree data
793
for each element of revision_ids from the trees repository. If you have
794
tree data already available, it is more efficient to use
795
set_parent_trees rather than set_parent_ids. set_parent_ids is however
796
an easier API to use.
798
:param revision_ids: The revision_ids to set as the parent ids of this
799
working tree. Any of these may be ghosts.
801
self._check_parents_for_ghosts(revision_ids,
802
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
803
for revision_id in revision_ids:
804
_mod_revision.check_not_reserved_id(revision_id)
806
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
808
if len(revision_ids) > 0:
809
self.set_last_revision(revision_ids[0])
811
self.set_last_revision(_mod_revision.NULL_REVISION)
813
self._set_merges_from_parent_ids(revision_ids)
815
@needs_tree_write_lock
816
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
817
"""See MutableTree.set_parent_trees."""
818
parent_ids = [rev for (rev, tree) in parents_list]
819
for revision_id in parent_ids:
820
_mod_revision.check_not_reserved_id(revision_id)
822
self._check_parents_for_ghosts(parent_ids,
823
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
825
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
827
if len(parent_ids) == 0:
828
leftmost_parent_id = _mod_revision.NULL_REVISION
829
leftmost_parent_tree = None
831
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
833
if self._change_last_revision(leftmost_parent_id):
834
if leftmost_parent_tree is None:
835
# If we don't have a tree, fall back to reading the
836
# parent tree from the repository.
837
self._cache_basis_inventory(leftmost_parent_id)
839
inv = leftmost_parent_tree.inventory
840
xml = self._create_basis_xml_from_inventory(
841
leftmost_parent_id, inv)
842
self._write_basis_inventory(xml)
843
self._set_merges_from_parent_ids(parent_ids)
845
@needs_tree_write_lock
846
def set_pending_merges(self, rev_list):
847
parents = self.get_parent_ids()
848
leftmost = parents[:1]
849
new_parents = leftmost + rev_list
850
self.set_parent_ids(new_parents)
852
@needs_tree_write_lock
853
def set_merge_modified(self, modified_hashes):
855
for file_id, hash in modified_hashes.iteritems():
856
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
857
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
859
def _sha_from_stat(self, path, stat_result):
860
"""Get a sha digest from the tree's stat cache.
862
The default implementation assumes no stat cache is present.
864
:param path: The path.
865
:param stat_result: The stat result being looked up.
869
def _put_rio(self, filename, stanzas, header):
870
self._must_be_locked()
871
my_file = rio_file(stanzas, header)
872
self._transport.put_file(filename, my_file,
873
mode=self._control_files._file_mode)
875
@needs_write_lock # because merge pulls data into the branch.
876
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
878
"""Merge from a branch into this working tree.
880
:param branch: The branch to merge from.
881
:param to_revision: If non-None, the merge will merge to to_revision,
882
but not beyond it. to_revision does not need to be in the history
883
of the branch when it is supplied. If None, to_revision defaults to
884
branch.last_revision().
886
from bzrlib.merge import Merger, Merge3Merger
887
pb = bzrlib.ui.ui_factory.nested_progress_bar()
889
merger = Merger(self.branch, this_tree=self, pb=pb)
890
merger.pp = ProgressPhase("Merge phase", 5, pb)
891
merger.pp.next_phase()
892
# check that there are no
894
merger.check_basis(check_clean=True, require_commits=False)
895
if to_revision is None:
896
to_revision = _mod_revision.ensure_null(branch.last_revision())
897
merger.other_rev_id = to_revision
898
if _mod_revision.is_null(merger.other_rev_id):
899
raise errors.NoCommits(branch)
900
self.branch.fetch(branch, last_revision=merger.other_rev_id)
901
merger.other_basis = merger.other_rev_id
902
merger.other_tree = self.branch.repository.revision_tree(
904
merger.other_branch = branch
905
merger.pp.next_phase()
906
if from_revision is None:
909
merger.set_base_revision(from_revision, branch)
910
if merger.base_rev_id == merger.other_rev_id:
911
raise errors.PointlessMerge
912
merger.backup_files = False
913
if merge_type is None:
914
merger.merge_type = Merge3Merger
916
merger.merge_type = merge_type
917
merger.set_interesting_files(None)
918
merger.show_base = False
919
merger.reprocess = False
920
conflicts = merger.do_merge()
927
def merge_modified(self):
928
"""Return a dictionary of files modified by a merge.
930
The list is initialized by WorkingTree.set_merge_modified, which is
931
typically called after we make some automatic updates to the tree
934
This returns a map of file_id->sha1, containing only files which are
935
still in the working inventory and have that text hash.
938
hashfile = self._transport.get('merge-hashes')
939
except errors.NoSuchFile:
944
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
945
raise errors.MergeModifiedFormatError()
946
except StopIteration:
947
raise errors.MergeModifiedFormatError()
948
for s in RioReader(hashfile):
949
# RioReader reads in Unicode, so convert file_ids back to utf8
950
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
951
if file_id not in self.inventory:
953
text_hash = s.get("hash")
954
if text_hash == self.get_file_sha1(file_id):
955
merge_hashes[file_id] = text_hash
961
def mkdir(self, path, file_id=None):
962
"""See MutableTree.mkdir()."""
964
file_id = generate_ids.gen_file_id(os.path.basename(path))
965
os.mkdir(self.abspath(path))
966
self.add(path, file_id, 'directory')
969
def get_symlink_target(self, file_id):
970
return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
973
def subsume(self, other_tree):
974
def add_children(inventory, entry):
975
for child_entry in entry.children.values():
976
inventory._byid[child_entry.file_id] = child_entry
977
if child_entry.kind == 'directory':
978
add_children(inventory, child_entry)
979
if other_tree.get_root_id() == self.get_root_id():
980
raise errors.BadSubsumeSource(self, other_tree,
981
'Trees have the same root')
983
other_tree_path = self.relpath(other_tree.basedir)
984
except errors.PathNotChild:
985
raise errors.BadSubsumeSource(self, other_tree,
986
'Tree is not contained by the other')
987
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
988
if new_root_parent is None:
989
raise errors.BadSubsumeSource(self, other_tree,
990
'Parent directory is not versioned.')
991
# We need to ensure that the result of a fetch will have a
992
# versionedfile for the other_tree root, and only fetching into
993
# RepositoryKnit2 guarantees that.
994
if not self.branch.repository.supports_rich_root():
995
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
996
other_tree.lock_tree_write()
998
new_parents = other_tree.get_parent_ids()
999
other_root = other_tree.inventory.root
1000
other_root.parent_id = new_root_parent
1001
other_root.name = osutils.basename(other_tree_path)
1002
self.inventory.add(other_root)
1003
add_children(self.inventory, other_root)
1004
self._write_inventory(self.inventory)
1005
# normally we don't want to fetch whole repositories, but i think
1006
# here we really do want to consolidate the whole thing.
1007
for parent_id in other_tree.get_parent_ids():
1008
self.branch.fetch(other_tree.branch, parent_id)
1009
self.add_parent_tree_id(parent_id)
1012
other_tree.bzrdir.retire_bzrdir()
1014
def _setup_directory_is_tree_reference(self):
1015
if self._branch.repository._format.supports_tree_reference:
1016
self._directory_is_tree_reference = \
1017
self._directory_may_be_tree_reference
1019
self._directory_is_tree_reference = \
1020
self._directory_is_never_tree_reference
1022
def _directory_is_never_tree_reference(self, relpath):
1025
def _directory_may_be_tree_reference(self, relpath):
1026
# as a special case, if a directory contains control files then
1027
# it's a tree reference, except that the root of the tree is not
1028
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1029
# TODO: We could ask all the control formats whether they
1030
# recognize this directory, but at the moment there's no cheap api
1031
# to do that. Since we probably can only nest bzr checkouts and
1032
# they always use this name it's ok for now. -- mbp 20060306
1034
# FIXME: There is an unhandled case here of a subdirectory
1035
# containing .bzr but not a branch; that will probably blow up
1036
# when you try to commit it. It might happen if there is a
1037
# checkout in a subdirectory. This can be avoided by not adding
1040
@needs_tree_write_lock
1041
def extract(self, file_id, format=None):
1042
"""Extract a subtree from this tree.
1044
A new branch will be created, relative to the path for this tree.
1048
segments = osutils.splitpath(path)
1049
transport = self.branch.bzrdir.root_transport
1050
for name in segments:
1051
transport = transport.clone(name)
1052
transport.ensure_base()
1055
sub_path = self.id2path(file_id)
1056
branch_transport = mkdirs(sub_path)
1058
format = self.bzrdir.cloning_metadir()
1059
branch_transport.ensure_base()
1060
branch_bzrdir = format.initialize_on_transport(branch_transport)
1062
repo = branch_bzrdir.find_repository()
1063
except errors.NoRepositoryPresent:
1064
repo = branch_bzrdir.create_repository()
1065
if not repo.supports_rich_root():
1066
raise errors.RootNotRich()
1067
new_branch = branch_bzrdir.create_branch()
1068
new_branch.pull(self.branch)
1069
for parent_id in self.get_parent_ids():
1070
new_branch.fetch(self.branch, parent_id)
1071
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1072
if tree_transport.base != branch_transport.base:
1073
tree_bzrdir = format.initialize_on_transport(tree_transport)
1074
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1076
tree_bzrdir = branch_bzrdir
1077
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1078
wt.set_parent_ids(self.get_parent_ids())
1079
my_inv = self.inventory
1080
child_inv = Inventory(root_id=None)
1081
new_root = my_inv[file_id]
1082
my_inv.remove_recursive_id(file_id)
1083
new_root.parent_id = None
1084
child_inv.add(new_root)
1085
self._write_inventory(my_inv)
1086
wt._write_inventory(child_inv)
1089
def _serialize(self, inventory, out_file):
1090
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1093
def _deserialize(selt, in_file):
1094
return xml5.serializer_v5.read_inventory(in_file)
1097
"""Write the in memory inventory to disk."""
1098
# TODO: Maybe this should only write on dirty ?
1099
if self._control_files._lock_mode != 'w':
1100
raise errors.NotWriteLocked(self)
1102
self._serialize(self._inventory, sio)
1104
self._transport.put_file('inventory', sio,
1105
mode=self._control_files._file_mode)
1106
self._inventory_is_modified = False
1108
def _kind(self, relpath):
1109
return osutils.file_kind(self.abspath(relpath))
1111
def list_files(self, include_root=False):
1112
"""Recursively list all files as (path, class, kind, id, entry).
1114
Lists, but does not descend into unversioned directories.
1116
This does not include files that have been deleted in this
1119
Skips the control directory.
1121
# list_files is an iterator, so @needs_read_lock doesn't work properly
1122
# with it. So callers should be careful to always read_lock the tree.
1123
if not self.is_locked():
1124
raise errors.ObjectNotLocked(self)
1126
inv = self.inventory
1127
if include_root is True:
1128
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1129
# Convert these into local objects to save lookup times
1130
pathjoin = osutils.pathjoin
1131
file_kind = self._kind
1133
# transport.base ends in a slash, we want the piece
1134
# between the last two slashes
1135
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1137
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1139
# directory file_id, relative path, absolute path, reverse sorted children
1140
children = os.listdir(self.basedir)
1142
# jam 20060527 The kernel sized tree seems equivalent whether we
1143
# use a deque and popleft to keep them sorted, or if we use a plain
1144
# list and just reverse() them.
1145
children = collections.deque(children)
1146
stack = [(inv.root.file_id, u'', self.basedir, children)]
1148
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1151
f = children.popleft()
1152
## TODO: If we find a subdirectory with its own .bzr
1153
## directory, then that is a separate tree and we
1154
## should exclude it.
1156
# the bzrdir for this tree
1157
if transport_base_dir == f:
1160
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1161
# and 'f' doesn't begin with one, we can do a string op, rather
1162
# than the checks of pathjoin(), all relative paths will have an extra slash
1164
fp = from_dir_relpath + '/' + f
1167
fap = from_dir_abspath + '/' + f
1169
f_ie = inv.get_child(from_dir_id, f)
1172
elif self.is_ignored(fp[1:]):
1175
# we may not have found this file, because of a unicode issue
1176
f_norm, can_access = osutils.normalized_filename(f)
1177
if f == f_norm or not can_access:
1178
# No change, so treat this file normally
1181
# this file can be accessed by a normalized path
1182
# check again if it is versioned
1183
# these lines are repeated here for performance
1185
fp = from_dir_relpath + '/' + f
1186
fap = from_dir_abspath + '/' + f
1187
f_ie = inv.get_child(from_dir_id, f)
1190
elif self.is_ignored(fp[1:]):
1197
# make a last minute entry
1199
yield fp[1:], c, fk, f_ie.file_id, f_ie
1202
yield fp[1:], c, fk, None, fk_entries[fk]()
1204
yield fp[1:], c, fk, None, TreeEntry()
1207
if fk != 'directory':
1210
# But do this child first
1211
new_children = os.listdir(fap)
1213
new_children = collections.deque(new_children)
1214
stack.append((f_ie.file_id, fp, fap, new_children))
1215
# Break out of inner loop,
1216
# so that we start outer loop with child
1219
# if we finished all children, pop it off the stack
1222
@needs_tree_write_lock
1223
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1226
to_dir must exist in the inventory.
1228
If to_dir exists and is a directory, the files are moved into
1229
it, keeping their old names.
1231
Note that to_dir is only the last component of the new name;
1232
this doesn't change the directory.
1234
For each entry in from_paths the move mode will be determined
1237
The first mode moves the file in the filesystem and updates the
1238
inventory. The second mode only updates the inventory without
1239
touching the file on the filesystem. This is the new mode introduced
1242
move uses the second mode if 'after == True' and the target is not
1243
versioned but present in the working tree.
1245
move uses the second mode if 'after == False' and the source is
1246
versioned but no longer in the working tree, and the target is not
1247
versioned but present in the working tree.
1249
move uses the first mode if 'after == False' and the source is
1250
versioned and present in the working tree, and the target is not
1251
versioned and not present in the working tree.
1253
Everything else results in an error.
1255
This returns a list of (from_path, to_path) pairs for each
1256
entry that is moved.
1261
# check for deprecated use of signature
1263
to_dir = kwargs.get('to_name', None)
1265
raise TypeError('You must supply a target directory')
1267
symbol_versioning.warn('The parameter to_name was deprecated'
1268
' in version 0.13. Use to_dir instead',
1271
# check destination directory
1272
if isinstance(from_paths, basestring):
1274
inv = self.inventory
1275
to_abs = self.abspath(to_dir)
1276
if not isdir(to_abs):
1277
raise errors.BzrMoveFailedError('',to_dir,
1278
errors.NotADirectory(to_abs))
1279
if not self.has_filename(to_dir):
1280
raise errors.BzrMoveFailedError('',to_dir,
1281
errors.NotInWorkingDirectory(to_dir))
1282
to_dir_id = inv.path2id(to_dir)
1283
if to_dir_id is None:
1284
raise errors.BzrMoveFailedError('',to_dir,
1285
errors.NotVersionedError(path=str(to_dir)))
1287
to_dir_ie = inv[to_dir_id]
1288
if to_dir_ie.kind != 'directory':
1289
raise errors.BzrMoveFailedError('',to_dir,
1290
errors.NotADirectory(to_abs))
1292
# create rename entries and tuples
1293
for from_rel in from_paths:
1294
from_tail = splitpath(from_rel)[-1]
1295
from_id = inv.path2id(from_rel)
1297
raise errors.BzrMoveFailedError(from_rel,to_dir,
1298
errors.NotVersionedError(path=str(from_rel)))
1300
from_entry = inv[from_id]
1301
from_parent_id = from_entry.parent_id
1302
to_rel = pathjoin(to_dir, from_tail)
1303
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1305
from_tail=from_tail,
1306
from_parent_id=from_parent_id,
1307
to_rel=to_rel, to_tail=from_tail,
1308
to_parent_id=to_dir_id)
1309
rename_entries.append(rename_entry)
1310
rename_tuples.append((from_rel, to_rel))
1312
# determine which move mode to use. checks also for movability
1313
rename_entries = self._determine_mv_mode(rename_entries, after)
1315
original_modified = self._inventory_is_modified
1318
self._inventory_is_modified = True
1319
self._move(rename_entries)
1321
# restore the inventory on error
1322
self._inventory_is_modified = original_modified
1324
self._write_inventory(inv)
1325
return rename_tuples
1327
def _determine_mv_mode(self, rename_entries, after=False):
1328
"""Determines for each from-to pair if both inventory and working tree
1329
or only the inventory has to be changed.
1331
Also does basic plausability tests.
1333
inv = self.inventory
1335
for rename_entry in rename_entries:
1336
# store to local variables for easier reference
1337
from_rel = rename_entry.from_rel
1338
from_id = rename_entry.from_id
1339
to_rel = rename_entry.to_rel
1340
to_id = inv.path2id(to_rel)
1341
only_change_inv = False
1343
# check the inventory for source and destination
1345
raise errors.BzrMoveFailedError(from_rel,to_rel,
1346
errors.NotVersionedError(path=str(from_rel)))
1347
if to_id is not None:
1348
raise errors.BzrMoveFailedError(from_rel,to_rel,
1349
errors.AlreadyVersionedError(path=str(to_rel)))
1351
# try to determine the mode for rename (only change inv or change
1352
# inv and file system)
1354
if not self.has_filename(to_rel):
1355
raise errors.BzrMoveFailedError(from_id,to_rel,
1356
errors.NoSuchFile(path=str(to_rel),
1357
extra="New file has not been created yet"))
1358
only_change_inv = True
1359
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1360
only_change_inv = True
1361
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1362
only_change_inv = False
1363
elif (not self.case_sensitive
1364
and from_rel.lower() == to_rel.lower()
1365
and self.has_filename(from_rel)):
1366
only_change_inv = False
1368
# something is wrong, so lets determine what exactly
1369
if not self.has_filename(from_rel) and \
1370
not self.has_filename(to_rel):
1371
raise errors.BzrRenameFailedError(from_rel,to_rel,
1372
errors.PathsDoNotExist(paths=(str(from_rel),
1375
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1376
rename_entry.only_change_inv = only_change_inv
1377
return rename_entries
1379
def _move(self, rename_entries):
1380
"""Moves a list of files.
1382
Depending on the value of the flag 'only_change_inv', the
1383
file will be moved on the file system or not.
1385
inv = self.inventory
1388
for entry in rename_entries:
1390
self._move_entry(entry)
1392
self._rollback_move(moved)
1396
def _rollback_move(self, moved):
1397
"""Try to rollback a previous move in case of an filesystem error."""
1398
inv = self.inventory
1401
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1402
entry.to_tail, entry.to_parent_id, entry.from_rel,
1403
entry.from_tail, entry.from_parent_id,
1404
entry.only_change_inv))
1405
except errors.BzrMoveFailedError, e:
1406
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1407
" The working tree is in an inconsistent state."
1408
" Please consider doing a 'bzr revert'."
1409
" Error message is: %s" % e)
1411
def _move_entry(self, entry):
1412
inv = self.inventory
1413
from_rel_abs = self.abspath(entry.from_rel)
1414
to_rel_abs = self.abspath(entry.to_rel)
1415
if from_rel_abs == to_rel_abs:
1416
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1417
"Source and target are identical.")
1419
if not entry.only_change_inv:
1421
osutils.rename(from_rel_abs, to_rel_abs)
1423
raise errors.BzrMoveFailedError(entry.from_rel,
1425
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1427
@needs_tree_write_lock
1428
def rename_one(self, from_rel, to_rel, after=False):
1431
This can change the directory or the filename or both.
1433
rename_one has several 'modes' to work. First, it can rename a physical
1434
file and change the file_id. That is the normal mode. Second, it can
1435
only change the file_id without touching any physical file. This is
1436
the new mode introduced in version 0.15.
1438
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1439
versioned but present in the working tree.
1441
rename_one uses the second mode if 'after == False' and 'from_rel' is
1442
versioned but no longer in the working tree, and 'to_rel' is not
1443
versioned but present in the working tree.
1445
rename_one uses the first mode if 'after == False' and 'from_rel' is
1446
versioned and present in the working tree, and 'to_rel' is not
1447
versioned and not present in the working tree.
1449
Everything else results in an error.
1451
inv = self.inventory
1454
# create rename entries and tuples
1455
from_tail = splitpath(from_rel)[-1]
1456
from_id = inv.path2id(from_rel)
1458
raise errors.BzrRenameFailedError(from_rel,to_rel,
1459
errors.NotVersionedError(path=str(from_rel)))
1460
from_entry = inv[from_id]
1461
from_parent_id = from_entry.parent_id
1462
to_dir, to_tail = os.path.split(to_rel)
1463
to_dir_id = inv.path2id(to_dir)
1464
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1466
from_tail=from_tail,
1467
from_parent_id=from_parent_id,
1468
to_rel=to_rel, to_tail=to_tail,
1469
to_parent_id=to_dir_id)
1470
rename_entries.append(rename_entry)
1472
# determine which move mode to use. checks also for movability
1473
rename_entries = self._determine_mv_mode(rename_entries, after)
1475
# check if the target changed directory and if the target directory is
1477
if to_dir_id is None:
1478
raise errors.BzrMoveFailedError(from_rel,to_rel,
1479
errors.NotVersionedError(path=str(to_dir)))
1481
# all checks done. now we can continue with our actual work
1482
mutter('rename_one:\n'
1487
' to_dir_id {%s}\n',
1488
from_id, from_rel, to_rel, to_dir, to_dir_id)
1490
self._move(rename_entries)
1491
self._write_inventory(inv)
1493
class _RenameEntry(object):
1494
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1495
to_rel, to_tail, to_parent_id, only_change_inv=False):
1496
self.from_rel = from_rel
1497
self.from_id = from_id
1498
self.from_tail = from_tail
1499
self.from_parent_id = from_parent_id
1500
self.to_rel = to_rel
1501
self.to_tail = to_tail
1502
self.to_parent_id = to_parent_id
1503
self.only_change_inv = only_change_inv
1507
"""Return all unknown files.
1509
These are files in the working directory that are not versioned or
1510
control files or ignored.
1512
# force the extras method to be fully executed before returning, to
1513
# prevent race conditions with the lock
1515
[subp for subp in self.extras() if not self.is_ignored(subp)])
1517
@needs_tree_write_lock
1518
def unversion(self, file_ids):
1519
"""Remove the file ids in file_ids from the current versioned set.
1521
When a file_id is unversioned, all of its children are automatically
1524
:param file_ids: The file ids to stop versioning.
1525
:raises: NoSuchId if any fileid is not currently versioned.
1527
for file_id in file_ids:
1528
if self._inventory.has_id(file_id):
1529
self._inventory.remove_recursive_id(file_id)
1531
raise errors.NoSuchId(self, file_id)
1533
# in the future this should just set a dirty bit to wait for the
1534
# final unlock. However, until all methods of workingtree start
1535
# with the current in -memory inventory rather than triggering
1536
# a read, it is more complex - we need to teach read_inventory
1537
# to know when to read, and when to not read first... and possibly
1538
# to save first when the in memory one may be corrupted.
1539
# so for now, we just only write it if it is indeed dirty.
1541
self._write_inventory(self._inventory)
1543
def _iter_conflicts(self):
1545
for info in self.list_files():
1547
stem = get_conflicted_stem(path)
1550
if stem not in conflicted:
1551
conflicted.add(stem)
1555
def pull(self, source, overwrite=False, stop_revision=None,
1556
change_reporter=None, possible_transports=None):
1557
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1560
pp = ProgressPhase("Pull phase", 2, top_pb)
1562
old_revision_info = self.branch.last_revision_info()
1563
basis_tree = self.basis_tree()
1564
count = self.branch.pull(source, overwrite, stop_revision,
1565
possible_transports=possible_transports)
1566
new_revision_info = self.branch.last_revision_info()
1567
if new_revision_info != old_revision_info:
1569
repository = self.branch.repository
1570
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1571
basis_tree.lock_read()
1573
new_basis_tree = self.branch.basis_tree()
1580
change_reporter=change_reporter)
1581
if (basis_tree.inventory.root is None and
1582
new_basis_tree.inventory.root is not None):
1583
self.set_root_id(new_basis_tree.get_root_id())
1587
# TODO - dedup parents list with things merged by pull ?
1588
# reuse the revisiontree we merged against to set the new
1590
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1591
# we have to pull the merge trees out again, because
1592
# merge_inner has set the ids. - this corner is not yet
1593
# layered well enough to prevent double handling.
1594
# XXX TODO: Fix the double handling: telling the tree about
1595
# the already known parent data is wasteful.
1596
merges = self.get_parent_ids()[1:]
1597
parent_trees.extend([
1598
(parent, repository.revision_tree(parent)) for
1600
self.set_parent_trees(parent_trees)
1607
def put_file_bytes_non_atomic(self, file_id, bytes):
1608
"""See MutableTree.put_file_bytes_non_atomic."""
1609
stream = file(self.id2abspath(file_id), 'wb')
1614
# TODO: update the hashcache here ?
1617
"""Yield all unversioned files in this WorkingTree.
1619
If there are any unversioned directories then only the directory is
1620
returned, not all its children. But if there are unversioned files
1621
under a versioned subdirectory, they are returned.
1623
Currently returned depth-first, sorted by name within directories.
1624
This is the same order used by 'osutils.walkdirs'.
1626
## TODO: Work from given directory downwards
1627
for path, dir_entry in self.inventory.directories():
1628
# mutter("search for unknowns in %r", path)
1629
dirabs = self.abspath(path)
1630
if not isdir(dirabs):
1631
# e.g. directory deleted
1635
for subf in os.listdir(dirabs):
1638
if subf not in dir_entry.children:
1641
can_access) = osutils.normalized_filename(subf)
1642
except UnicodeDecodeError:
1643
path_os_enc = path.encode(osutils._fs_enc)
1644
relpath = path_os_enc + '/' + subf
1645
raise errors.BadFilenameEncoding(relpath,
1647
if subf_norm != subf and can_access:
1648
if subf_norm not in dir_entry.children:
1649
fl.append(subf_norm)
1655
subp = pathjoin(path, subf)
1658
def ignored_files(self):
1659
"""Yield list of PATH, IGNORE_PATTERN"""
1660
for subp in self.extras():
1661
pat = self.is_ignored(subp)
1665
def get_ignore_list(self):
1666
"""Return list of ignore patterns.
1668
Cached in the Tree object after the first call.
1670
ignoreset = getattr(self, '_ignoreset', None)
1671
if ignoreset is not None:
1674
ignore_globs = set()
1675
ignore_globs.update(ignores.get_runtime_ignores())
1676
ignore_globs.update(ignores.get_user_ignores())
1677
if self.has_filename(bzrlib.IGNORE_FILENAME):
1678
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1680
ignore_globs.update(ignores.parse_ignore_file(f))
1683
self._ignoreset = ignore_globs
1686
def _flush_ignore_list_cache(self):
1687
"""Resets the cached ignore list to force a cache rebuild."""
1688
self._ignoreset = None
1689
self._ignoreglobster = None
1691
def is_ignored(self, filename):
1692
r"""Check whether the filename matches an ignore pattern.
1694
Patterns containing '/' or '\' need to match the whole path;
1695
others match against only the last component.
1697
If the file is ignored, returns the pattern which caused it to
1698
be ignored, otherwise None. So this can simply be used as a
1699
boolean if desired."""
1700
if getattr(self, '_ignoreglobster', None) is None:
1701
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1702
return self._ignoreglobster.match(filename)
1704
def kind(self, file_id):
1705
return file_kind(self.id2abspath(file_id))
1707
def stored_kind(self, file_id):
1708
"""See Tree.stored_kind"""
1709
return self.inventory[file_id].kind
1711
def _comparison_data(self, entry, path):
1712
abspath = self.abspath(path)
1714
stat_value = os.lstat(abspath)
1716
if getattr(e, 'errno', None) == errno.ENOENT:
1723
mode = stat_value.st_mode
1724
kind = osutils.file_kind_from_stat_mode(mode)
1725
if not supports_executable():
1726
executable = entry is not None and entry.executable
1728
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1729
return kind, executable, stat_value
1731
def _file_size(self, entry, stat_value):
1732
return stat_value.st_size
1734
def last_revision(self):
1735
"""Return the last revision of the branch for this tree.
1737
This format tree does not support a separate marker for last-revision
1738
compared to the branch.
1740
See MutableTree.last_revision
1742
return self._last_revision()
1745
def _last_revision(self):
1746
"""helper for get_parent_ids."""
1747
return _mod_revision.ensure_null(self.branch.last_revision())
1749
def is_locked(self):
1750
return self._control_files.is_locked()
1752
def _must_be_locked(self):
1753
if not self.is_locked():
1754
raise errors.ObjectNotLocked(self)
1756
def lock_read(self):
1757
"""See Branch.lock_read, and WorkingTree.unlock."""
1758
if not self.is_locked():
1760
self.branch.lock_read()
1762
return self._control_files.lock_read()
1764
self.branch.unlock()
1767
def lock_tree_write(self):
1768
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1769
if not self.is_locked():
1771
self.branch.lock_read()
1773
return self._control_files.lock_write()
1775
self.branch.unlock()
1778
def lock_write(self):
1779
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1780
if not self.is_locked():
1782
self.branch.lock_write()
1784
return self._control_files.lock_write()
1786
self.branch.unlock()
1789
def get_physical_lock_status(self):
1790
return self._control_files.get_physical_lock_status()
1792
def _basis_inventory_name(self):
1793
return 'basis-inventory-cache'
1795
def _reset_data(self):
1796
"""Reset transient data that cannot be revalidated."""
1797
self._inventory_is_modified = False
1798
result = self._deserialize(self._transport.get('inventory'))
1799
self._set_inventory(result, dirty=False)
1801
@needs_tree_write_lock
1802
def set_last_revision(self, new_revision):
1803
"""Change the last revision in the working tree."""
1804
if self._change_last_revision(new_revision):
1805
self._cache_basis_inventory(new_revision)
1807
def _change_last_revision(self, new_revision):
1808
"""Template method part of set_last_revision to perform the change.
1810
This is used to allow WorkingTree3 instances to not affect branch
1811
when their last revision is set.
1813
if _mod_revision.is_null(new_revision):
1814
self.branch.set_revision_history([])
1817
self.branch.generate_revision_history(new_revision)
1818
except errors.NoSuchRevision:
1819
# not present in the repo - dont try to set it deeper than the tip
1820
self.branch.set_revision_history([new_revision])
1823
def _write_basis_inventory(self, xml):
1824
"""Write the basis inventory XML to the basis-inventory file"""
1825
path = self._basis_inventory_name()
1827
self._transport.put_file(path, sio,
1828
mode=self._control_files._file_mode)
1830
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1831
"""Create the text that will be saved in basis-inventory"""
1832
inventory.revision_id = revision_id
1833
return xml7.serializer_v7.write_inventory_to_string(inventory)
1835
def _cache_basis_inventory(self, new_revision):
1836
"""Cache new_revision as the basis inventory."""
1837
# TODO: this should allow the ready-to-use inventory to be passed in,
1838
# as commit already has that ready-to-use [while the format is the
1841
# this double handles the inventory - unpack and repack -
1842
# but is easier to understand. We can/should put a conditional
1843
# in here based on whether the inventory is in the latest format
1844
# - perhaps we should repack all inventories on a repository
1846
# the fast path is to copy the raw xml from the repository. If the
1847
# xml contains 'revision_id="', then we assume the right
1848
# revision_id is set. We must check for this full string, because a
1849
# root node id can legitimately look like 'revision_id' but cannot
1851
xml = self.branch.repository.get_inventory_xml(new_revision)
1852
firstline = xml.split('\n', 1)[0]
1853
if (not 'revision_id="' in firstline or
1854
'format="7"' not in firstline):
1855
inv = self.branch.repository.deserialise_inventory(
1857
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1858
self._write_basis_inventory(xml)
1859
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1862
def read_basis_inventory(self):
1863
"""Read the cached basis inventory."""
1864
path = self._basis_inventory_name()
1865
return self._transport.get_bytes(path)
1868
def read_working_inventory(self):
1869
"""Read the working inventory.
1871
:raises errors.InventoryModified: read_working_inventory will fail
1872
when the current in memory inventory has been modified.
1874
# conceptually this should be an implementation detail of the tree.
1875
# XXX: Deprecate this.
1876
# ElementTree does its own conversion from UTF-8, so open in
1878
if self._inventory_is_modified:
1879
raise errors.InventoryModified(self)
1880
result = self._deserialize(self._transport.get('inventory'))
1881
self._set_inventory(result, dirty=False)
1884
@needs_tree_write_lock
1885
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1887
"""Remove nominated files from the working inventory.
1889
:files: File paths relative to the basedir.
1890
:keep_files: If true, the files will also be kept.
1891
:force: Delete files and directories, even if they are changed and
1892
even if the directories are not empty.
1894
if isinstance(files, basestring):
1900
unknown_nested_files=set()
1902
def recurse_directory_to_add_files(directory):
1903
# Recurse directory and add all files
1904
# so we can check if they have changed.
1905
for parent_info, file_infos in\
1906
self.walkdirs(directory):
1907
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1908
# Is it versioned or ignored?
1909
if self.path2id(relpath) or self.is_ignored(relpath):
1910
# Add nested content for deletion.
1911
new_files.add(relpath)
1913
# Files which are not versioned and not ignored
1914
# should be treated as unknown.
1915
unknown_nested_files.add((relpath, None, kind))
1917
for filename in files:
1918
# Get file name into canonical form.
1919
abspath = self.abspath(filename)
1920
filename = self.relpath(abspath)
1921
if len(filename) > 0:
1922
new_files.add(filename)
1923
recurse_directory_to_add_files(filename)
1925
files = list(new_files)
1928
return # nothing to do
1930
# Sort needed to first handle directory content before the directory
1931
files.sort(reverse=True)
1933
# Bail out if we are going to delete files we shouldn't
1934
if not keep_files and not force:
1935
has_changed_files = len(unknown_nested_files) > 0
1936
if not has_changed_files:
1937
for (file_id, path, content_change, versioned, parent_id, name,
1938
kind, executable) in self.iter_changes(self.basis_tree(),
1939
include_unchanged=True, require_versioned=False,
1940
want_unversioned=True, specific_files=files):
1941
if versioned == (False, False):
1942
# The record is unknown ...
1943
if not self.is_ignored(path[1]):
1944
# ... but not ignored
1945
has_changed_files = True
1947
elif content_change and (kind[1] is not None):
1948
# Versioned and changed, but not deleted
1949
has_changed_files = True
1952
if has_changed_files:
1953
# Make delta show ALL applicable changes in error message.
1954
tree_delta = self.changes_from(self.basis_tree(),
1955
require_versioned=False, want_unversioned=True,
1956
specific_files=files)
1957
for unknown_file in unknown_nested_files:
1958
if unknown_file not in tree_delta.unversioned:
1959
tree_delta.unversioned.extend((unknown_file,))
1960
raise errors.BzrRemoveChangedFilesError(tree_delta)
1962
# Build inv_delta and delete files where applicaple,
1963
# do this before any modifications to inventory.
1965
fid = self.path2id(f)
1968
message = "%s is not versioned." % (f,)
1971
# having removed it, it must be either ignored or unknown
1972
if self.is_ignored(f):
1976
textui.show_status(new_status, self.kind(fid), f,
1979
inv_delta.append((f, None, fid, None))
1980
message = "removed %s" % (f,)
1983
abs_path = self.abspath(f)
1984
if osutils.lexists(abs_path):
1985
if (osutils.isdir(abs_path) and
1986
len(os.listdir(abs_path)) > 0):
1988
osutils.rmtree(abs_path)
1990
message = "%s is not an empty directory "\
1991
"and won't be deleted." % (f,)
1993
osutils.delete_any(abs_path)
1994
message = "deleted %s" % (f,)
1995
elif message is not None:
1996
# Only care if we haven't done anything yet.
1997
message = "%s does not exist." % (f,)
1999
# Print only one message (if any) per file.
2000
if message is not None:
2002
self.apply_inventory_delta(inv_delta)
2004
@needs_tree_write_lock
2005
def revert(self, filenames=None, old_tree=None, backups=True,
2006
pb=DummyProgress(), report_changes=False):
2007
from bzrlib.conflicts import resolve
2010
symbol_versioning.warn('Using [] to revert all files is deprecated'
2011
' as of bzr 0.91. Please use None (the default) instead.',
2012
DeprecationWarning, stacklevel=2)
2013
if old_tree is None:
2014
basis_tree = self.basis_tree()
2015
basis_tree.lock_read()
2016
old_tree = basis_tree
2020
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2022
if filenames is None and len(self.get_parent_ids()) > 1:
2024
last_revision = self.last_revision()
2025
if last_revision != NULL_REVISION:
2026
if basis_tree is None:
2027
basis_tree = self.basis_tree()
2028
basis_tree.lock_read()
2029
parent_trees.append((last_revision, basis_tree))
2030
self.set_parent_trees(parent_trees)
2033
resolve(self, filenames, ignore_misses=True, recursive=True)
2035
if basis_tree is not None:
2039
def revision_tree(self, revision_id):
2040
"""See Tree.revision_tree.
2042
WorkingTree can supply revision_trees for the basis revision only
2043
because there is only one cached inventory in the bzr directory.
2045
if revision_id == self.last_revision():
2047
xml = self.read_basis_inventory()
2048
except errors.NoSuchFile:
2052
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2053
# dont use the repository revision_tree api because we want
2054
# to supply the inventory.
2055
if inv.revision_id == revision_id:
2056
return revisiontree.RevisionTree(self.branch.repository,
2058
except errors.BadInventoryFormat:
2060
# raise if there was no inventory, or if we read the wrong inventory.
2061
raise errors.NoSuchRevisionInTree(self, revision_id)
2063
# XXX: This method should be deprecated in favour of taking in a proper
2064
# new Inventory object.
2065
@needs_tree_write_lock
2066
def set_inventory(self, new_inventory_list):
2067
from bzrlib.inventory import (Inventory,
2072
inv = Inventory(self.get_root_id())
2073
for path, file_id, parent, kind in new_inventory_list:
2074
name = os.path.basename(path)
2077
# fixme, there should be a factory function inv,add_??
2078
if kind == 'directory':
2079
inv.add(InventoryDirectory(file_id, name, parent))
2080
elif kind == 'file':
2081
inv.add(InventoryFile(file_id, name, parent))
2082
elif kind == 'symlink':
2083
inv.add(InventoryLink(file_id, name, parent))
2085
raise errors.BzrError("unknown kind %r" % kind)
2086
self._write_inventory(inv)
2088
@needs_tree_write_lock
2089
def set_root_id(self, file_id):
2090
"""Set the root id for this tree."""
2094
'WorkingTree.set_root_id with fileid=None')
2095
file_id = osutils.safe_file_id(file_id)
2096
self._set_root_id(file_id)
2098
def _set_root_id(self, file_id):
2099
"""Set the root id for this tree, in a format specific manner.
2101
:param file_id: The file id to assign to the root. It must not be
2102
present in the current inventory or an error will occur. It must
2103
not be None, but rather a valid file id.
2105
inv = self._inventory
2106
orig_root_id = inv.root.file_id
2107
# TODO: it might be nice to exit early if there was nothing
2108
# to do, saving us from trigger a sync on unlock.
2109
self._inventory_is_modified = True
2110
# we preserve the root inventory entry object, but
2111
# unlinkit from the byid index
2112
del inv._byid[inv.root.file_id]
2113
inv.root.file_id = file_id
2114
# and link it into the index with the new changed id.
2115
inv._byid[inv.root.file_id] = inv.root
2116
# and finally update all children to reference the new id.
2117
# XXX: this should be safe to just look at the root.children
2118
# list, not the WHOLE INVENTORY.
2121
if entry.parent_id == orig_root_id:
2122
entry.parent_id = inv.root.file_id
2125
"""See Branch.unlock.
2127
WorkingTree locking just uses the Branch locking facilities.
2128
This is current because all working trees have an embedded branch
2129
within them. IF in the future, we were to make branch data shareable
2130
between multiple working trees, i.e. via shared storage, then we
2131
would probably want to lock both the local tree, and the branch.
2133
raise NotImplementedError(self.unlock)
2135
def update(self, change_reporter=None, possible_transports=None):
2136
"""Update a working tree along its branch.
2138
This will update the branch if its bound too, which means we have
2139
multiple trees involved:
2141
- The new basis tree of the master.
2142
- The old basis tree of the branch.
2143
- The old basis tree of the working tree.
2144
- The current working tree state.
2146
Pathologically, all three may be different, and non-ancestors of each
2147
other. Conceptually we want to:
2149
- Preserve the wt.basis->wt.state changes
2150
- Transform the wt.basis to the new master basis.
2151
- Apply a merge of the old branch basis to get any 'local' changes from
2153
- Restore the wt.basis->wt.state changes.
2155
There isn't a single operation at the moment to do that, so we:
2156
- Merge current state -> basis tree of the master w.r.t. the old tree
2158
- Do a 'normal' merge of the old branch basis if it is relevant.
2160
if self.branch.get_bound_location() is not None:
2162
update_branch = True
2164
self.lock_tree_write()
2165
update_branch = False
2168
old_tip = self.branch.update(possible_transports)
2171
return self._update_tree(old_tip, change_reporter)
2175
@needs_tree_write_lock
2176
def _update_tree(self, old_tip=None, change_reporter=None):
2177
"""Update a tree to the master branch.
2179
:param old_tip: if supplied, the previous tip revision the branch,
2180
before it was changed to the master branch's tip.
2182
# here if old_tip is not None, it is the old tip of the branch before
2183
# it was updated from the master branch. This should become a pending
2184
# merge in the working tree to preserve the user existing work. we
2185
# cant set that until we update the working trees last revision to be
2186
# one from the new branch, because it will just get absorbed by the
2187
# parent de-duplication logic.
2189
# We MUST save it even if an error occurs, because otherwise the users
2190
# local work is unreferenced and will appear to have been lost.
2194
last_rev = self.get_parent_ids()[0]
2196
last_rev = _mod_revision.NULL_REVISION
2197
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2198
# merge tree state up to new branch tip.
2199
basis = self.basis_tree()
2202
to_tree = self.branch.basis_tree()
2203
if basis.inventory.root is None:
2204
self.set_root_id(to_tree.get_root_id())
2206
result += merge.merge_inner(
2211
change_reporter=change_reporter)
2214
# TODO - dedup parents list with things merged by pull ?
2215
# reuse the tree we've updated to to set the basis:
2216
parent_trees = [(self.branch.last_revision(), to_tree)]
2217
merges = self.get_parent_ids()[1:]
2218
# Ideally we ask the tree for the trees here, that way the working
2219
# tree can decide whether to give us teh entire tree or give us a
2220
# lazy initialised tree. dirstate for instance will have the trees
2221
# in ram already, whereas a last-revision + basis-inventory tree
2222
# will not, but also does not need them when setting parents.
2223
for parent in merges:
2224
parent_trees.append(
2225
(parent, self.branch.repository.revision_tree(parent)))
2226
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2227
parent_trees.append(
2228
(old_tip, self.branch.repository.revision_tree(old_tip)))
2229
self.set_parent_trees(parent_trees)
2230
last_rev = parent_trees[0][0]
2232
# the working tree had the same last-revision as the master
2233
# branch did. We may still have pivot local work from the local
2234
# branch into old_tip:
2235
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2236
self.add_parent_tree_id(old_tip)
2237
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2238
and old_tip != last_rev):
2239
# our last revision was not the prior branch last revision
2240
# and we have converted that last revision to a pending merge.
2241
# base is somewhere between the branch tip now
2242
# and the now pending merge
2244
# Since we just modified the working tree and inventory, flush out
2245
# the current state, before we modify it again.
2246
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2247
# requires it only because TreeTransform directly munges the
2248
# inventory and calls tree._write_inventory(). Ultimately we
2249
# should be able to remove this extra flush.
2251
graph = self.branch.repository.get_graph()
2252
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2254
base_tree = self.branch.repository.revision_tree(base_rev_id)
2255
other_tree = self.branch.repository.revision_tree(old_tip)
2256
result += merge.merge_inner(
2261
change_reporter=change_reporter)
2264
def _write_hashcache_if_dirty(self):
2265
"""Write out the hashcache if it is dirty."""
2266
if self._hashcache.needs_write:
2268
self._hashcache.write()
2270
if e.errno not in (errno.EPERM, errno.EACCES):
2272
# TODO: jam 20061219 Should this be a warning? A single line
2273
# warning might be sufficient to let the user know what
2275
mutter('Could not write hashcache for %s\nError: %s',
2276
self._hashcache.cache_file_name(), e)
2278
@needs_tree_write_lock
2279
def _write_inventory(self, inv):
2280
"""Write inventory as the current inventory."""
2281
self._set_inventory(inv, dirty=True)
2284
def set_conflicts(self, arg):
2285
raise errors.UnsupportedOperation(self.set_conflicts, self)
2287
def add_conflicts(self, arg):
2288
raise errors.UnsupportedOperation(self.add_conflicts, self)
2291
def conflicts(self):
2292
conflicts = _mod_conflicts.ConflictList()
2293
for conflicted in self._iter_conflicts():
2296
if file_kind(self.abspath(conflicted)) != "file":
2298
except errors.NoSuchFile:
2301
for suffix in ('.THIS', '.OTHER'):
2303
kind = file_kind(self.abspath(conflicted+suffix))
2306
except errors.NoSuchFile:
2310
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2311
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2313
file_id=self.path2id(conflicted)))
2316
def walkdirs(self, prefix=""):
2317
"""Walk the directories of this tree.
2319
returns a generator which yields items in the form:
2320
((curren_directory_path, fileid),
2321
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2324
This API returns a generator, which is only valid during the current
2325
tree transaction - within a single lock_read or lock_write duration.
2327
If the tree is not locked, it may cause an error to be raised,
2328
depending on the tree implementation.
2330
disk_top = self.abspath(prefix)
2331
if disk_top.endswith('/'):
2332
disk_top = disk_top[:-1]
2333
top_strip_len = len(disk_top) + 1
2334
inventory_iterator = self._walkdirs(prefix)
2335
disk_iterator = osutils.walkdirs(disk_top, prefix)
2337
current_disk = disk_iterator.next()
2338
disk_finished = False
2340
if not (e.errno == errno.ENOENT or
2341
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2344
disk_finished = True
2346
current_inv = inventory_iterator.next()
2347
inv_finished = False
2348
except StopIteration:
2351
while not inv_finished or not disk_finished:
2353
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2354
cur_disk_dir_content) = current_disk
2356
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2357
cur_disk_dir_content) = ((None, None), None)
2358
if not disk_finished:
2359
# strip out .bzr dirs
2360
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2361
len(cur_disk_dir_content) > 0):
2362
# osutils.walkdirs can be made nicer -
2363
# yield the path-from-prefix rather than the pathjoined
2365
bzrdir_loc = bisect_left(cur_disk_dir_content,
2367
if (bzrdir_loc < len(cur_disk_dir_content)
2368
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2369
# we dont yield the contents of, or, .bzr itself.
2370
del cur_disk_dir_content[bzrdir_loc]
2372
# everything is unknown
2375
# everything is missing
2378
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2380
# disk is before inventory - unknown
2381
dirblock = [(relpath, basename, kind, stat, None, None) for
2382
relpath, basename, kind, stat, top_path in
2383
cur_disk_dir_content]
2384
yield (cur_disk_dir_relpath, None), dirblock
2386
current_disk = disk_iterator.next()
2387
except StopIteration:
2388
disk_finished = True
2390
# inventory is before disk - missing.
2391
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2392
for relpath, basename, dkind, stat, fileid, kind in
2394
yield (current_inv[0][0], current_inv[0][1]), dirblock
2396
current_inv = inventory_iterator.next()
2397
except StopIteration:
2400
# versioned present directory
2401
# merge the inventory and disk data together
2403
for relpath, subiterator in itertools.groupby(sorted(
2404
current_inv[1] + cur_disk_dir_content,
2405
key=operator.itemgetter(0)), operator.itemgetter(1)):
2406
path_elements = list(subiterator)
2407
if len(path_elements) == 2:
2408
inv_row, disk_row = path_elements
2409
# versioned, present file
2410
dirblock.append((inv_row[0],
2411
inv_row[1], disk_row[2],
2412
disk_row[3], inv_row[4],
2414
elif len(path_elements[0]) == 5:
2416
dirblock.append((path_elements[0][0],
2417
path_elements[0][1], path_elements[0][2],
2418
path_elements[0][3], None, None))
2419
elif len(path_elements[0]) == 6:
2420
# versioned, absent file.
2421
dirblock.append((path_elements[0][0],
2422
path_elements[0][1], 'unknown', None,
2423
path_elements[0][4], path_elements[0][5]))
2425
raise NotImplementedError('unreachable code')
2426
yield current_inv[0], dirblock
2428
current_inv = inventory_iterator.next()
2429
except StopIteration:
2432
current_disk = disk_iterator.next()
2433
except StopIteration:
2434
disk_finished = True
2436
def _walkdirs(self, prefix=""):
2437
"""Walk the directories of this tree.
2439
:prefix: is used as the directrory to start with.
2440
returns a generator which yields items in the form:
2441
((curren_directory_path, fileid),
2442
[(file1_path, file1_name, file1_kind, None, file1_id,
2445
_directory = 'directory'
2446
# get the root in the inventory
2447
inv = self.inventory
2448
top_id = inv.path2id(prefix)
2452
pending = [(prefix, '', _directory, None, top_id, None)]
2455
currentdir = pending.pop()
2456
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2457
top_id = currentdir[4]
2459
relroot = currentdir[0] + '/'
2462
# FIXME: stash the node in pending
2464
if entry.kind == 'directory':
2465
for name, child in entry.sorted_children():
2466
dirblock.append((relroot + name, name, child.kind, None,
2467
child.file_id, child.kind
2469
yield (currentdir[0], entry.file_id), dirblock
2470
# push the user specified dirs from dirblock
2471
for dir in reversed(dirblock):
2472
if dir[2] == _directory:
2475
@needs_tree_write_lock
2476
def auto_resolve(self):
2477
"""Automatically resolve text conflicts according to contents.
2479
Only text conflicts are auto_resolvable. Files with no conflict markers
2480
are considered 'resolved', because bzr always puts conflict markers
2481
into files that have text conflicts. The corresponding .THIS .BASE and
2482
.OTHER files are deleted, as per 'resolve'.
2483
:return: a tuple of ConflictLists: (un_resolved, resolved).
2485
un_resolved = _mod_conflicts.ConflictList()
2486
resolved = _mod_conflicts.ConflictList()
2487
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2488
for conflict in self.conflicts():
2489
if (conflict.typestring != 'text conflict' or
2490
self.kind(conflict.file_id) != 'file'):
2491
un_resolved.append(conflict)
2493
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2495
for line in my_file:
2496
if conflict_re.search(line):
2497
un_resolved.append(conflict)
2500
resolved.append(conflict)
2503
resolved.remove_files(self)
2504
self.set_conflicts(un_resolved)
2505
return un_resolved, resolved
2509
tree_basis = self.basis_tree()
2510
tree_basis.lock_read()
2512
repo_basis = self.branch.repository.revision_tree(
2513
self.last_revision())
2514
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2515
raise errors.BzrCheckError(
2516
"Mismatched basis inventory content.")
2521
def _validate(self):
2522
"""Validate internal structures.
2524
This is meant mostly for the test suite. To give it a chance to detect
2525
corruption after actions have occurred. The default implementation is a
2528
:return: None. An exception should be raised if there is an error.
2533
def _get_rules_searcher(self, default_searcher):
2534
"""See Tree._get_rules_searcher."""
2535
if self._rules_searcher is None:
2536
self._rules_searcher = super(WorkingTree,
2537
self)._get_rules_searcher(default_searcher)
2538
return self._rules_searcher
2540
def get_shelf_manager(self):
2541
"""Return the ShelfManager for this WorkingTree."""
2542
from bzrlib.shelf import ShelfManager
2543
return ShelfManager(self, self._transport)
2546
class WorkingTree2(WorkingTree):
2547
"""This is the Format 2 working tree.
2549
This was the first weave based working tree.
2550
- uses os locks for locking.
2551
- uses the branch last-revision.
2554
def __init__(self, *args, **kwargs):
2555
super(WorkingTree2, self).__init__(*args, **kwargs)
2556
# WorkingTree2 has more of a constraint that self._inventory must
2557
# exist. Because this is an older format, we don't mind the overhead
2558
# caused by the extra computation here.
2560
# Newer WorkingTree's should only have self._inventory set when they
2562
if self._inventory is None:
2563
self.read_working_inventory()
2565
def lock_tree_write(self):
2566
"""See WorkingTree.lock_tree_write().
2568
In Format2 WorkingTrees we have a single lock for the branch and tree
2569
so lock_tree_write() degrades to lock_write().
2571
self.branch.lock_write()
2573
return self._control_files.lock_write()
2575
self.branch.unlock()
2579
# do non-implementation specific cleanup
2582
# we share control files:
2583
if self._control_files._lock_count == 3:
2584
# _inventory_is_modified is always False during a read lock.
2585
if self._inventory_is_modified:
2587
self._write_hashcache_if_dirty()
2589
# reverse order of locking.
2591
return self._control_files.unlock()
2593
self.branch.unlock()
2596
class WorkingTree3(WorkingTree):
2597
"""This is the Format 3 working tree.
2599
This differs from the base WorkingTree by:
2600
- having its own file lock
2601
- having its own last-revision property.
2603
This is new in bzr 0.8
2607
def _last_revision(self):
2608
"""See Mutable.last_revision."""
2610
return self._transport.get_bytes('last-revision')
2611
except errors.NoSuchFile:
2612
return _mod_revision.NULL_REVISION
2614
def _change_last_revision(self, revision_id):
2615
"""See WorkingTree._change_last_revision."""
2616
if revision_id is None or revision_id == NULL_REVISION:
2618
self._transport.delete('last-revision')
2619
except errors.NoSuchFile:
2623
self._transport.put_bytes('last-revision', revision_id,
2624
mode=self._control_files._file_mode)
2627
@needs_tree_write_lock
2628
def set_conflicts(self, conflicts):
2629
self._put_rio('conflicts', conflicts.to_stanzas(),
2632
@needs_tree_write_lock
2633
def add_conflicts(self, new_conflicts):
2634
conflict_set = set(self.conflicts())
2635
conflict_set.update(set(list(new_conflicts)))
2636
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2637
key=_mod_conflicts.Conflict.sort_key)))
2640
def conflicts(self):
2642
confile = self._transport.get('conflicts')
2643
except errors.NoSuchFile:
2644
return _mod_conflicts.ConflictList()
2647
if confile.next() != CONFLICT_HEADER_1 + '\n':
2648
raise errors.ConflictFormatError()
2649
except StopIteration:
2650
raise errors.ConflictFormatError()
2651
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2656
# do non-implementation specific cleanup
2658
if self._control_files._lock_count == 1:
2659
# _inventory_is_modified is always False during a read lock.
2660
if self._inventory_is_modified:
2662
self._write_hashcache_if_dirty()
2663
# reverse order of locking.
2665
return self._control_files.unlock()
2667
self.branch.unlock()
2670
def get_conflicted_stem(path):
2671
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2672
if path.endswith(suffix):
2673
return path[:-len(suffix)]
2676
class WorkingTreeFormat(object):
2677
"""An encapsulation of the initialization and open routines for a format.
2679
Formats provide three things:
2680
* An initialization routine,
2684
Formats are placed in an dict by their format string for reference
2685
during workingtree opening. Its not required that these be instances, they
2686
can be classes themselves with class methods - it simply depends on
2687
whether state is needed for a given format or not.
2689
Once a format is deprecated, just deprecate the initialize and open
2690
methods on the format class. Do not deprecate the object, as the
2691
object will be created every time regardless.
2694
_default_format = None
2695
"""The default format used for new trees."""
2698
"""The known formats."""
2700
requires_rich_root = False
2702
upgrade_recommended = False
2705
def find_format(klass, a_bzrdir):
2706
"""Return the format for the working tree object in a_bzrdir."""
2708
transport = a_bzrdir.get_workingtree_transport(None)
2709
format_string = transport.get("format").read()
2710
return klass._formats[format_string]
2711
except errors.NoSuchFile:
2712
raise errors.NoWorkingTree(base=transport.base)
2714
raise errors.UnknownFormatError(format=format_string,
2715
kind="working tree")
2717
def __eq__(self, other):
2718
return self.__class__ is other.__class__
2720
def __ne__(self, other):
2721
return not (self == other)
2724
def get_default_format(klass):
2725
"""Return the current default format."""
2726
return klass._default_format
2728
def get_format_string(self):
2729
"""Return the ASCII format string that identifies this format."""
2730
raise NotImplementedError(self.get_format_string)
2732
def get_format_description(self):
2733
"""Return the short description for this format."""
2734
raise NotImplementedError(self.get_format_description)
2736
def is_supported(self):
2737
"""Is this format supported?
2739
Supported formats can be initialized and opened.
2740
Unsupported formats may not support initialization or committing or
2741
some other features depending on the reason for not being supported.
2745
def supports_content_filtering(self):
2746
"""True if this format supports content filtering."""
2749
def supports_views(self):
2750
"""True if this format supports stored views."""
2754
def register_format(klass, format):
2755
klass._formats[format.get_format_string()] = format
2758
def set_default_format(klass, format):
2759
klass._default_format = format
2762
def unregister_format(klass, format):
2763
del klass._formats[format.get_format_string()]
2766
class WorkingTreeFormat2(WorkingTreeFormat):
2767
"""The second working tree format.
2769
This format modified the hash cache from the format 1 hash cache.
2772
upgrade_recommended = True
2774
def get_format_description(self):
2775
"""See WorkingTreeFormat.get_format_description()."""
2776
return "Working tree format 2"
2778
def _stub_initialize_on_transport(self, transport, file_mode):
2779
"""Workaround: create control files for a remote working tree.
2781
This ensures that it can later be updated and dealt with locally,
2782
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2783
no working tree. (See bug #43064).
2787
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2789
transport.put_file('inventory', sio, file_mode)
2790
transport.put_bytes('pending-merges', '', file_mode)
2792
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2793
accelerator_tree=None, hardlink=False):
2794
"""See WorkingTreeFormat.initialize()."""
2795
if not isinstance(a_bzrdir.transport, LocalTransport):
2796
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2797
if from_branch is not None:
2798
branch = from_branch
2800
branch = a_bzrdir.open_branch()
2801
if revision_id is None:
2802
revision_id = _mod_revision.ensure_null(branch.last_revision())
2805
branch.generate_revision_history(revision_id)
2809
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2815
basis_tree = branch.repository.revision_tree(revision_id)
2816
if basis_tree.inventory.root is not None:
2817
wt.set_root_id(basis_tree.get_root_id())
2818
# set the parent list and cache the basis tree.
2819
if _mod_revision.is_null(revision_id):
2822
parent_trees = [(revision_id, basis_tree)]
2823
wt.set_parent_trees(parent_trees)
2824
transform.build_tree(basis_tree, wt)
2828
super(WorkingTreeFormat2, self).__init__()
2829
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2831
def open(self, a_bzrdir, _found=False):
2832
"""Return the WorkingTree object for a_bzrdir
2834
_found is a private parameter, do not use it. It is used to indicate
2835
if format probing has already been done.
2838
# we are being called directly and must probe.
2839
raise NotImplementedError
2840
if not isinstance(a_bzrdir.transport, LocalTransport):
2841
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2842
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2848
class WorkingTreeFormat3(WorkingTreeFormat):
2849
"""The second working tree format updated to record a format marker.
2852
- exists within a metadir controlling .bzr
2853
- includes an explicit version marker for the workingtree control
2854
files, separate from the BzrDir format
2855
- modifies the hash cache format
2857
- uses a LockDir to guard access for writes.
2860
upgrade_recommended = True
2862
def get_format_string(self):
2863
"""See WorkingTreeFormat.get_format_string()."""
2864
return "Bazaar-NG Working Tree format 3"
2866
def get_format_description(self):
2867
"""See WorkingTreeFormat.get_format_description()."""
2868
return "Working tree format 3"
2870
_lock_file_name = 'lock'
2871
_lock_class = LockDir
2873
_tree_class = WorkingTree3
2875
def __get_matchingbzrdir(self):
2876
return bzrdir.BzrDirMetaFormat1()
2878
_matchingbzrdir = property(__get_matchingbzrdir)
2880
def _open_control_files(self, a_bzrdir):
2881
transport = a_bzrdir.get_workingtree_transport(None)
2882
return LockableFiles(transport, self._lock_file_name,
2885
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
accelerator_tree=None, hardlink=False):
2887
"""See WorkingTreeFormat.initialize().
2889
:param revision_id: if supplied, create a working tree at a different
2890
revision than the branch is at.
2891
:param accelerator_tree: A tree which can be used for retrieving file
2892
contents more quickly than the revision tree, i.e. a workingtree.
2893
The revision tree will be used for cases where accelerator_tree's
2894
content is different.
2895
:param hardlink: If true, hard-link files from accelerator_tree,
2898
if not isinstance(a_bzrdir.transport, LocalTransport):
2899
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2900
transport = a_bzrdir.get_workingtree_transport(self)
2901
control_files = self._open_control_files(a_bzrdir)
2902
control_files.create_lock()
2903
control_files.lock_write()
2904
transport.put_bytes('format', self.get_format_string(),
2905
mode=control_files._file_mode)
2906
if from_branch is not None:
2907
branch = from_branch
2909
branch = a_bzrdir.open_branch()
2910
if revision_id is None:
2911
revision_id = _mod_revision.ensure_null(branch.last_revision())
2912
# WorkingTree3 can handle an inventory which has a unique root id.
2913
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2914
# those trees. And because there isn't a format bump inbetween, we
2915
# are maintaining compatibility with older clients.
2916
# inv = Inventory(root_id=gen_root_id())
2917
inv = self._initial_inventory()
2918
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2924
_control_files=control_files)
2925
wt.lock_tree_write()
2927
basis_tree = branch.repository.revision_tree(revision_id)
2928
# only set an explicit root id if there is one to set.
2929
if basis_tree.inventory.root is not None:
2930
wt.set_root_id(basis_tree.get_root_id())
2931
if revision_id == NULL_REVISION:
2932
wt.set_parent_trees([])
2934
wt.set_parent_trees([(revision_id, basis_tree)])
2935
transform.build_tree(basis_tree, wt)
2937
# Unlock in this order so that the unlock-triggers-flush in
2938
# WorkingTree is given a chance to fire.
2939
control_files.unlock()
2943
def _initial_inventory(self):
2947
super(WorkingTreeFormat3, self).__init__()
2949
def open(self, a_bzrdir, _found=False):
2950
"""Return the WorkingTree object for a_bzrdir
2952
_found is a private parameter, do not use it. It is used to indicate
2953
if format probing has already been done.
2956
# we are being called directly and must probe.
2957
raise NotImplementedError
2958
if not isinstance(a_bzrdir.transport, LocalTransport):
2959
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2960
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2963
def _open(self, a_bzrdir, control_files):
2964
"""Open the tree itself.
2966
:param a_bzrdir: the dir for the tree.
2967
:param control_files: the control files for the tree.
2969
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2973
_control_files=control_files)
2976
return self.get_format_string()
2979
__default_format = WorkingTreeFormat4()
2980
WorkingTreeFormat.register_format(__default_format)
2981
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2982
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2983
WorkingTreeFormat.set_default_format(__default_format)
2984
# formats which have no format string are not discoverable
2985
# and not independently creatable, so are not registered.
2986
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
