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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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,
749
os.readlink(abspath.encode(osutils._fs_enc)
750
).decode(osutils._fs_enc))
752
return (kind, None, None, None)
754
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
755
"""Common ghost checking functionality from set_parent_*.
757
This checks that the left hand-parent exists if there are any
760
if len(revision_ids) > 0:
761
leftmost_id = revision_ids[0]
762
if (not allow_leftmost_as_ghost and not
763
self.branch.repository.has_revision(leftmost_id)):
764
raise errors.GhostRevisionUnusableHere(leftmost_id)
766
def _set_merges_from_parent_ids(self, parent_ids):
767
merges = parent_ids[1:]
768
self._transport.put_bytes('pending-merges', '\n'.join(merges),
769
mode=self._control_files._file_mode)
771
def _filter_parent_ids_by_ancestry(self, revision_ids):
772
"""Check that all merged revisions are proper 'heads'.
774
This will always return the first revision_id, and any merged revisions
777
if len(revision_ids) == 0:
779
graph = self.branch.repository.get_graph()
780
heads = graph.heads(revision_ids)
781
new_revision_ids = revision_ids[:1]
782
for revision_id in revision_ids[1:]:
783
if revision_id in heads and revision_id not in new_revision_ids:
784
new_revision_ids.append(revision_id)
785
if new_revision_ids != revision_ids:
786
trace.mutter('requested to set revision_ids = %s,'
787
' but filtered to %s', revision_ids, new_revision_ids)
788
return new_revision_ids
790
@needs_tree_write_lock
791
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
792
"""Set the parent ids to revision_ids.
794
See also set_parent_trees. This api will try to retrieve the tree data
795
for each element of revision_ids from the trees repository. If you have
796
tree data already available, it is more efficient to use
797
set_parent_trees rather than set_parent_ids. set_parent_ids is however
798
an easier API to use.
800
:param revision_ids: The revision_ids to set as the parent ids of this
801
working tree. Any of these may be ghosts.
803
self._check_parents_for_ghosts(revision_ids,
804
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
805
for revision_id in revision_ids:
806
_mod_revision.check_not_reserved_id(revision_id)
808
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
810
if len(revision_ids) > 0:
811
self.set_last_revision(revision_ids[0])
813
self.set_last_revision(_mod_revision.NULL_REVISION)
815
self._set_merges_from_parent_ids(revision_ids)
817
@needs_tree_write_lock
818
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
819
"""See MutableTree.set_parent_trees."""
820
parent_ids = [rev for (rev, tree) in parents_list]
821
for revision_id in parent_ids:
822
_mod_revision.check_not_reserved_id(revision_id)
824
self._check_parents_for_ghosts(parent_ids,
825
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
827
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
829
if len(parent_ids) == 0:
830
leftmost_parent_id = _mod_revision.NULL_REVISION
831
leftmost_parent_tree = None
833
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
835
if self._change_last_revision(leftmost_parent_id):
836
if leftmost_parent_tree is None:
837
# If we don't have a tree, fall back to reading the
838
# parent tree from the repository.
839
self._cache_basis_inventory(leftmost_parent_id)
841
inv = leftmost_parent_tree.inventory
842
xml = self._create_basis_xml_from_inventory(
843
leftmost_parent_id, inv)
844
self._write_basis_inventory(xml)
845
self._set_merges_from_parent_ids(parent_ids)
847
@needs_tree_write_lock
848
def set_pending_merges(self, rev_list):
849
parents = self.get_parent_ids()
850
leftmost = parents[:1]
851
new_parents = leftmost + rev_list
852
self.set_parent_ids(new_parents)
854
@needs_tree_write_lock
855
def set_merge_modified(self, modified_hashes):
857
for file_id, hash in modified_hashes.iteritems():
858
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
859
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
861
def _sha_from_stat(self, path, stat_result):
862
"""Get a sha digest from the tree's stat cache.
864
The default implementation assumes no stat cache is present.
866
:param path: The path.
867
:param stat_result: The stat result being looked up.
871
def _put_rio(self, filename, stanzas, header):
872
self._must_be_locked()
873
my_file = rio_file(stanzas, header)
874
self._transport.put_file(filename, my_file,
875
mode=self._control_files._file_mode)
877
@needs_write_lock # because merge pulls data into the branch.
878
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
880
"""Merge from a branch into this working tree.
882
:param branch: The branch to merge from.
883
:param to_revision: If non-None, the merge will merge to to_revision,
884
but not beyond it. to_revision does not need to be in the history
885
of the branch when it is supplied. If None, to_revision defaults to
886
branch.last_revision().
888
from bzrlib.merge import Merger, Merge3Merger
889
pb = bzrlib.ui.ui_factory.nested_progress_bar()
891
merger = Merger(self.branch, this_tree=self, pb=pb)
892
merger.pp = ProgressPhase("Merge phase", 5, pb)
893
merger.pp.next_phase()
894
# check that there are no
896
merger.check_basis(check_clean=True, require_commits=False)
897
if to_revision is None:
898
to_revision = _mod_revision.ensure_null(branch.last_revision())
899
merger.other_rev_id = to_revision
900
if _mod_revision.is_null(merger.other_rev_id):
901
raise errors.NoCommits(branch)
902
self.branch.fetch(branch, last_revision=merger.other_rev_id)
903
merger.other_basis = merger.other_rev_id
904
merger.other_tree = self.branch.repository.revision_tree(
906
merger.other_branch = branch
907
merger.pp.next_phase()
908
if from_revision is None:
911
merger.set_base_revision(from_revision, branch)
912
if merger.base_rev_id == merger.other_rev_id:
913
raise errors.PointlessMerge
914
merger.backup_files = False
915
if merge_type is None:
916
merger.merge_type = Merge3Merger
918
merger.merge_type = merge_type
919
merger.set_interesting_files(None)
920
merger.show_base = False
921
merger.reprocess = False
922
conflicts = merger.do_merge()
929
def merge_modified(self):
930
"""Return a dictionary of files modified by a merge.
932
The list is initialized by WorkingTree.set_merge_modified, which is
933
typically called after we make some automatic updates to the tree
936
This returns a map of file_id->sha1, containing only files which are
937
still in the working inventory and have that text hash.
940
hashfile = self._transport.get('merge-hashes')
941
except errors.NoSuchFile:
946
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
947
raise errors.MergeModifiedFormatError()
948
except StopIteration:
949
raise errors.MergeModifiedFormatError()
950
for s in RioReader(hashfile):
951
# RioReader reads in Unicode, so convert file_ids back to utf8
952
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
953
if file_id not in self.inventory:
955
text_hash = s.get("hash")
956
if text_hash == self.get_file_sha1(file_id):
957
merge_hashes[file_id] = text_hash
963
def mkdir(self, path, file_id=None):
964
"""See MutableTree.mkdir()."""
966
file_id = generate_ids.gen_file_id(os.path.basename(path))
967
os.mkdir(self.abspath(path))
968
self.add(path, file_id, 'directory')
971
def get_symlink_target(self, file_id):
972
return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
975
def subsume(self, other_tree):
976
def add_children(inventory, entry):
977
for child_entry in entry.children.values():
978
inventory._byid[child_entry.file_id] = child_entry
979
if child_entry.kind == 'directory':
980
add_children(inventory, child_entry)
981
if other_tree.get_root_id() == self.get_root_id():
982
raise errors.BadSubsumeSource(self, other_tree,
983
'Trees have the same root')
985
other_tree_path = self.relpath(other_tree.basedir)
986
except errors.PathNotChild:
987
raise errors.BadSubsumeSource(self, other_tree,
988
'Tree is not contained by the other')
989
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
990
if new_root_parent is None:
991
raise errors.BadSubsumeSource(self, other_tree,
992
'Parent directory is not versioned.')
993
# We need to ensure that the result of a fetch will have a
994
# versionedfile for the other_tree root, and only fetching into
995
# RepositoryKnit2 guarantees that.
996
if not self.branch.repository.supports_rich_root():
997
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
998
other_tree.lock_tree_write()
1000
new_parents = other_tree.get_parent_ids()
1001
other_root = other_tree.inventory.root
1002
other_root.parent_id = new_root_parent
1003
other_root.name = osutils.basename(other_tree_path)
1004
self.inventory.add(other_root)
1005
add_children(self.inventory, other_root)
1006
self._write_inventory(self.inventory)
1007
# normally we don't want to fetch whole repositories, but i think
1008
# here we really do want to consolidate the whole thing.
1009
for parent_id in other_tree.get_parent_ids():
1010
self.branch.fetch(other_tree.branch, parent_id)
1011
self.add_parent_tree_id(parent_id)
1014
other_tree.bzrdir.retire_bzrdir()
1016
def _setup_directory_is_tree_reference(self):
1017
if self._branch.repository._format.supports_tree_reference:
1018
self._directory_is_tree_reference = \
1019
self._directory_may_be_tree_reference
1021
self._directory_is_tree_reference = \
1022
self._directory_is_never_tree_reference
1024
def _directory_is_never_tree_reference(self, relpath):
1027
def _directory_may_be_tree_reference(self, relpath):
1028
# as a special case, if a directory contains control files then
1029
# it's a tree reference, except that the root of the tree is not
1030
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1031
# TODO: We could ask all the control formats whether they
1032
# recognize this directory, but at the moment there's no cheap api
1033
# to do that. Since we probably can only nest bzr checkouts and
1034
# they always use this name it's ok for now. -- mbp 20060306
1036
# FIXME: There is an unhandled case here of a subdirectory
1037
# containing .bzr but not a branch; that will probably blow up
1038
# when you try to commit it. It might happen if there is a
1039
# checkout in a subdirectory. This can be avoided by not adding
1042
@needs_tree_write_lock
1043
def extract(self, file_id, format=None):
1044
"""Extract a subtree from this tree.
1046
A new branch will be created, relative to the path for this tree.
1050
segments = osutils.splitpath(path)
1051
transport = self.branch.bzrdir.root_transport
1052
for name in segments:
1053
transport = transport.clone(name)
1054
transport.ensure_base()
1057
sub_path = self.id2path(file_id)
1058
branch_transport = mkdirs(sub_path)
1060
format = self.bzrdir.cloning_metadir()
1061
branch_transport.ensure_base()
1062
branch_bzrdir = format.initialize_on_transport(branch_transport)
1064
repo = branch_bzrdir.find_repository()
1065
except errors.NoRepositoryPresent:
1066
repo = branch_bzrdir.create_repository()
1067
if not repo.supports_rich_root():
1068
raise errors.RootNotRich()
1069
new_branch = branch_bzrdir.create_branch()
1070
new_branch.pull(self.branch)
1071
for parent_id in self.get_parent_ids():
1072
new_branch.fetch(self.branch, parent_id)
1073
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1074
if tree_transport.base != branch_transport.base:
1075
tree_bzrdir = format.initialize_on_transport(tree_transport)
1076
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1078
tree_bzrdir = branch_bzrdir
1079
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1080
wt.set_parent_ids(self.get_parent_ids())
1081
my_inv = self.inventory
1082
child_inv = Inventory(root_id=None)
1083
new_root = my_inv[file_id]
1084
my_inv.remove_recursive_id(file_id)
1085
new_root.parent_id = None
1086
child_inv.add(new_root)
1087
self._write_inventory(my_inv)
1088
wt._write_inventory(child_inv)
1091
def _serialize(self, inventory, out_file):
1092
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1095
def _deserialize(selt, in_file):
1096
return xml5.serializer_v5.read_inventory(in_file)
1099
"""Write the in memory inventory to disk."""
1100
# TODO: Maybe this should only write on dirty ?
1101
if self._control_files._lock_mode != 'w':
1102
raise errors.NotWriteLocked(self)
1104
self._serialize(self._inventory, sio)
1106
self._transport.put_file('inventory', sio,
1107
mode=self._control_files._file_mode)
1108
self._inventory_is_modified = False
1110
def _kind(self, relpath):
1111
return osutils.file_kind(self.abspath(relpath))
1113
def list_files(self, include_root=False):
1114
"""Recursively list all files as (path, class, kind, id, entry).
1116
Lists, but does not descend into unversioned directories.
1118
This does not include files that have been deleted in this
1121
Skips the control directory.
1123
# list_files is an iterator, so @needs_read_lock doesn't work properly
1124
# with it. So callers should be careful to always read_lock the tree.
1125
if not self.is_locked():
1126
raise errors.ObjectNotLocked(self)
1128
inv = self.inventory
1129
if include_root is True:
1130
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1131
# Convert these into local objects to save lookup times
1132
pathjoin = osutils.pathjoin
1133
file_kind = self._kind
1135
# transport.base ends in a slash, we want the piece
1136
# between the last two slashes
1137
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1139
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1141
# directory file_id, relative path, absolute path, reverse sorted children
1142
children = os.listdir(self.basedir)
1144
# jam 20060527 The kernel sized tree seems equivalent whether we
1145
# use a deque and popleft to keep them sorted, or if we use a plain
1146
# list and just reverse() them.
1147
children = collections.deque(children)
1148
stack = [(inv.root.file_id, u'', self.basedir, children)]
1150
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1153
f = children.popleft()
1154
## TODO: If we find a subdirectory with its own .bzr
1155
## directory, then that is a separate tree and we
1156
## should exclude it.
1158
# the bzrdir for this tree
1159
if transport_base_dir == f:
1162
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1163
# and 'f' doesn't begin with one, we can do a string op, rather
1164
# than the checks of pathjoin(), all relative paths will have an extra slash
1166
fp = from_dir_relpath + '/' + f
1169
fap = from_dir_abspath + '/' + f
1171
f_ie = inv.get_child(from_dir_id, f)
1174
elif self.is_ignored(fp[1:]):
1177
# we may not have found this file, because of a unicode issue
1178
f_norm, can_access = osutils.normalized_filename(f)
1179
if f == f_norm or not can_access:
1180
# No change, so treat this file normally
1183
# this file can be accessed by a normalized path
1184
# check again if it is versioned
1185
# these lines are repeated here for performance
1187
fp = from_dir_relpath + '/' + f
1188
fap = from_dir_abspath + '/' + f
1189
f_ie = inv.get_child(from_dir_id, f)
1192
elif self.is_ignored(fp[1:]):
1199
# make a last minute entry
1201
yield fp[1:], c, fk, f_ie.file_id, f_ie
1204
yield fp[1:], c, fk, None, fk_entries[fk]()
1206
yield fp[1:], c, fk, None, TreeEntry()
1209
if fk != 'directory':
1212
# But do this child first
1213
new_children = os.listdir(fap)
1215
new_children = collections.deque(new_children)
1216
stack.append((f_ie.file_id, fp, fap, new_children))
1217
# Break out of inner loop,
1218
# so that we start outer loop with child
1221
# if we finished all children, pop it off the stack
1224
@needs_tree_write_lock
1225
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1228
to_dir must exist in the inventory.
1230
If to_dir exists and is a directory, the files are moved into
1231
it, keeping their old names.
1233
Note that to_dir is only the last component of the new name;
1234
this doesn't change the directory.
1236
For each entry in from_paths the move mode will be determined
1239
The first mode moves the file in the filesystem and updates the
1240
inventory. The second mode only updates the inventory without
1241
touching the file on the filesystem. This is the new mode introduced
1244
move uses the second mode if 'after == True' and the target is not
1245
versioned but present in the working tree.
1247
move uses the second mode if 'after == False' and the source is
1248
versioned but no longer in the working tree, and the target is not
1249
versioned but present in the working tree.
1251
move uses the first mode if 'after == False' and the source is
1252
versioned and present in the working tree, and the target is not
1253
versioned and not present in the working tree.
1255
Everything else results in an error.
1257
This returns a list of (from_path, to_path) pairs for each
1258
entry that is moved.
1263
# check for deprecated use of signature
1265
to_dir = kwargs.get('to_name', None)
1267
raise TypeError('You must supply a target directory')
1269
symbol_versioning.warn('The parameter to_name was deprecated'
1270
' in version 0.13. Use to_dir instead',
1273
# check destination directory
1274
if isinstance(from_paths, basestring):
1276
inv = self.inventory
1277
to_abs = self.abspath(to_dir)
1278
if not isdir(to_abs):
1279
raise errors.BzrMoveFailedError('',to_dir,
1280
errors.NotADirectory(to_abs))
1281
if not self.has_filename(to_dir):
1282
raise errors.BzrMoveFailedError('',to_dir,
1283
errors.NotInWorkingDirectory(to_dir))
1284
to_dir_id = inv.path2id(to_dir)
1285
if to_dir_id is None:
1286
raise errors.BzrMoveFailedError('',to_dir,
1287
errors.NotVersionedError(path=str(to_dir)))
1289
to_dir_ie = inv[to_dir_id]
1290
if to_dir_ie.kind != 'directory':
1291
raise errors.BzrMoveFailedError('',to_dir,
1292
errors.NotADirectory(to_abs))
1294
# create rename entries and tuples
1295
for from_rel in from_paths:
1296
from_tail = splitpath(from_rel)[-1]
1297
from_id = inv.path2id(from_rel)
1299
raise errors.BzrMoveFailedError(from_rel,to_dir,
1300
errors.NotVersionedError(path=str(from_rel)))
1302
from_entry = inv[from_id]
1303
from_parent_id = from_entry.parent_id
1304
to_rel = pathjoin(to_dir, from_tail)
1305
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1307
from_tail=from_tail,
1308
from_parent_id=from_parent_id,
1309
to_rel=to_rel, to_tail=from_tail,
1310
to_parent_id=to_dir_id)
1311
rename_entries.append(rename_entry)
1312
rename_tuples.append((from_rel, to_rel))
1314
# determine which move mode to use. checks also for movability
1315
rename_entries = self._determine_mv_mode(rename_entries, after)
1317
original_modified = self._inventory_is_modified
1320
self._inventory_is_modified = True
1321
self._move(rename_entries)
1323
# restore the inventory on error
1324
self._inventory_is_modified = original_modified
1326
self._write_inventory(inv)
1327
return rename_tuples
1329
def _determine_mv_mode(self, rename_entries, after=False):
1330
"""Determines for each from-to pair if both inventory and working tree
1331
or only the inventory has to be changed.
1333
Also does basic plausability tests.
1335
inv = self.inventory
1337
for rename_entry in rename_entries:
1338
# store to local variables for easier reference
1339
from_rel = rename_entry.from_rel
1340
from_id = rename_entry.from_id
1341
to_rel = rename_entry.to_rel
1342
to_id = inv.path2id(to_rel)
1343
only_change_inv = False
1345
# check the inventory for source and destination
1347
raise errors.BzrMoveFailedError(from_rel,to_rel,
1348
errors.NotVersionedError(path=str(from_rel)))
1349
if to_id is not None:
1350
raise errors.BzrMoveFailedError(from_rel,to_rel,
1351
errors.AlreadyVersionedError(path=str(to_rel)))
1353
# try to determine the mode for rename (only change inv or change
1354
# inv and file system)
1356
if not self.has_filename(to_rel):
1357
raise errors.BzrMoveFailedError(from_id,to_rel,
1358
errors.NoSuchFile(path=str(to_rel),
1359
extra="New file has not been created yet"))
1360
only_change_inv = True
1361
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1362
only_change_inv = True
1363
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1364
only_change_inv = False
1365
elif (not self.case_sensitive
1366
and from_rel.lower() == to_rel.lower()
1367
and self.has_filename(from_rel)):
1368
only_change_inv = False
1370
# something is wrong, so lets determine what exactly
1371
if not self.has_filename(from_rel) and \
1372
not self.has_filename(to_rel):
1373
raise errors.BzrRenameFailedError(from_rel,to_rel,
1374
errors.PathsDoNotExist(paths=(str(from_rel),
1377
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1378
rename_entry.only_change_inv = only_change_inv
1379
return rename_entries
1381
def _move(self, rename_entries):
1382
"""Moves a list of files.
1384
Depending on the value of the flag 'only_change_inv', the
1385
file will be moved on the file system or not.
1387
inv = self.inventory
1390
for entry in rename_entries:
1392
self._move_entry(entry)
1394
self._rollback_move(moved)
1398
def _rollback_move(self, moved):
1399
"""Try to rollback a previous move in case of an filesystem error."""
1400
inv = self.inventory
1403
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1404
entry.to_tail, entry.to_parent_id, entry.from_rel,
1405
entry.from_tail, entry.from_parent_id,
1406
entry.only_change_inv))
1407
except errors.BzrMoveFailedError, e:
1408
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1409
" The working tree is in an inconsistent state."
1410
" Please consider doing a 'bzr revert'."
1411
" Error message is: %s" % e)
1413
def _move_entry(self, entry):
1414
inv = self.inventory
1415
from_rel_abs = self.abspath(entry.from_rel)
1416
to_rel_abs = self.abspath(entry.to_rel)
1417
if from_rel_abs == to_rel_abs:
1418
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1419
"Source and target are identical.")
1421
if not entry.only_change_inv:
1423
osutils.rename(from_rel_abs, to_rel_abs)
1425
raise errors.BzrMoveFailedError(entry.from_rel,
1427
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1429
@needs_tree_write_lock
1430
def rename_one(self, from_rel, to_rel, after=False):
1433
This can change the directory or the filename or both.
1435
rename_one has several 'modes' to work. First, it can rename a physical
1436
file and change the file_id. That is the normal mode. Second, it can
1437
only change the file_id without touching any physical file. This is
1438
the new mode introduced in version 0.15.
1440
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1441
versioned but present in the working tree.
1443
rename_one uses the second mode if 'after == False' and 'from_rel' is
1444
versioned but no longer in the working tree, and 'to_rel' is not
1445
versioned but present in the working tree.
1447
rename_one uses the first mode if 'after == False' and 'from_rel' is
1448
versioned and present in the working tree, and 'to_rel' is not
1449
versioned and not present in the working tree.
1451
Everything else results in an error.
1453
inv = self.inventory
1456
# create rename entries and tuples
1457
from_tail = splitpath(from_rel)[-1]
1458
from_id = inv.path2id(from_rel)
1460
raise errors.BzrRenameFailedError(from_rel,to_rel,
1461
errors.NotVersionedError(path=str(from_rel)))
1462
from_entry = inv[from_id]
1463
from_parent_id = from_entry.parent_id
1464
to_dir, to_tail = os.path.split(to_rel)
1465
to_dir_id = inv.path2id(to_dir)
1466
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1468
from_tail=from_tail,
1469
from_parent_id=from_parent_id,
1470
to_rel=to_rel, to_tail=to_tail,
1471
to_parent_id=to_dir_id)
1472
rename_entries.append(rename_entry)
1474
# determine which move mode to use. checks also for movability
1475
rename_entries = self._determine_mv_mode(rename_entries, after)
1477
# check if the target changed directory and if the target directory is
1479
if to_dir_id is None:
1480
raise errors.BzrMoveFailedError(from_rel,to_rel,
1481
errors.NotVersionedError(path=str(to_dir)))
1483
# all checks done. now we can continue with our actual work
1484
mutter('rename_one:\n'
1489
' to_dir_id {%s}\n',
1490
from_id, from_rel, to_rel, to_dir, to_dir_id)
1492
self._move(rename_entries)
1493
self._write_inventory(inv)
1495
class _RenameEntry(object):
1496
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1497
to_rel, to_tail, to_parent_id, only_change_inv=False):
1498
self.from_rel = from_rel
1499
self.from_id = from_id
1500
self.from_tail = from_tail
1501
self.from_parent_id = from_parent_id
1502
self.to_rel = to_rel
1503
self.to_tail = to_tail
1504
self.to_parent_id = to_parent_id
1505
self.only_change_inv = only_change_inv
1509
"""Return all unknown files.
1511
These are files in the working directory that are not versioned or
1512
control files or ignored.
1514
# force the extras method to be fully executed before returning, to
1515
# prevent race conditions with the lock
1517
[subp for subp in self.extras() if not self.is_ignored(subp)])
1519
@needs_tree_write_lock
1520
def unversion(self, file_ids):
1521
"""Remove the file ids in file_ids from the current versioned set.
1523
When a file_id is unversioned, all of its children are automatically
1526
:param file_ids: The file ids to stop versioning.
1527
:raises: NoSuchId if any fileid is not currently versioned.
1529
for file_id in file_ids:
1530
if self._inventory.has_id(file_id):
1531
self._inventory.remove_recursive_id(file_id)
1533
raise errors.NoSuchId(self, file_id)
1535
# in the future this should just set a dirty bit to wait for the
1536
# final unlock. However, until all methods of workingtree start
1537
# with the current in -memory inventory rather than triggering
1538
# a read, it is more complex - we need to teach read_inventory
1539
# to know when to read, and when to not read first... and possibly
1540
# to save first when the in memory one may be corrupted.
1541
# so for now, we just only write it if it is indeed dirty.
1543
self._write_inventory(self._inventory)
1545
def _iter_conflicts(self):
1547
for info in self.list_files():
1549
stem = get_conflicted_stem(path)
1552
if stem not in conflicted:
1553
conflicted.add(stem)
1557
def pull(self, source, overwrite=False, stop_revision=None,
1558
change_reporter=None, possible_transports=None):
1559
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1562
pp = ProgressPhase("Pull phase", 2, top_pb)
1564
old_revision_info = self.branch.last_revision_info()
1565
basis_tree = self.basis_tree()
1566
count = self.branch.pull(source, overwrite, stop_revision,
1567
possible_transports=possible_transports)
1568
new_revision_info = self.branch.last_revision_info()
1569
if new_revision_info != old_revision_info:
1571
repository = self.branch.repository
1572
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1573
basis_tree.lock_read()
1575
new_basis_tree = self.branch.basis_tree()
1582
change_reporter=change_reporter)
1583
if (basis_tree.inventory.root is None and
1584
new_basis_tree.inventory.root is not None):
1585
self.set_root_id(new_basis_tree.get_root_id())
1589
# TODO - dedup parents list with things merged by pull ?
1590
# reuse the revisiontree we merged against to set the new
1592
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1593
# we have to pull the merge trees out again, because
1594
# merge_inner has set the ids. - this corner is not yet
1595
# layered well enough to prevent double handling.
1596
# XXX TODO: Fix the double handling: telling the tree about
1597
# the already known parent data is wasteful.
1598
merges = self.get_parent_ids()[1:]
1599
parent_trees.extend([
1600
(parent, repository.revision_tree(parent)) for
1602
self.set_parent_trees(parent_trees)
1609
def put_file_bytes_non_atomic(self, file_id, bytes):
1610
"""See MutableTree.put_file_bytes_non_atomic."""
1611
stream = file(self.id2abspath(file_id), 'wb')
1616
# TODO: update the hashcache here ?
1619
"""Yield all unversioned files in this WorkingTree.
1621
If there are any unversioned directories then only the directory is
1622
returned, not all its children. But if there are unversioned files
1623
under a versioned subdirectory, they are returned.
1625
Currently returned depth-first, sorted by name within directories.
1626
This is the same order used by 'osutils.walkdirs'.
1628
## TODO: Work from given directory downwards
1629
for path, dir_entry in self.inventory.directories():
1630
# mutter("search for unknowns in %r", path)
1631
dirabs = self.abspath(path)
1632
if not isdir(dirabs):
1633
# e.g. directory deleted
1637
for subf in os.listdir(dirabs):
1640
if subf not in dir_entry.children:
1643
can_access) = osutils.normalized_filename(subf)
1644
except UnicodeDecodeError:
1645
path_os_enc = path.encode(osutils._fs_enc)
1646
relpath = path_os_enc + '/' + subf
1647
raise errors.BadFilenameEncoding(relpath,
1649
if subf_norm != subf and can_access:
1650
if subf_norm not in dir_entry.children:
1651
fl.append(subf_norm)
1657
subp = pathjoin(path, subf)
1660
def ignored_files(self):
1661
"""Yield list of PATH, IGNORE_PATTERN"""
1662
for subp in self.extras():
1663
pat = self.is_ignored(subp)
1667
def get_ignore_list(self):
1668
"""Return list of ignore patterns.
1670
Cached in the Tree object after the first call.
1672
ignoreset = getattr(self, '_ignoreset', None)
1673
if ignoreset is not None:
1676
ignore_globs = set()
1677
ignore_globs.update(ignores.get_runtime_ignores())
1678
ignore_globs.update(ignores.get_user_ignores())
1679
if self.has_filename(bzrlib.IGNORE_FILENAME):
1680
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1682
ignore_globs.update(ignores.parse_ignore_file(f))
1685
self._ignoreset = ignore_globs
1688
def _flush_ignore_list_cache(self):
1689
"""Resets the cached ignore list to force a cache rebuild."""
1690
self._ignoreset = None
1691
self._ignoreglobster = None
1693
def is_ignored(self, filename):
1694
r"""Check whether the filename matches an ignore pattern.
1696
Patterns containing '/' or '\' need to match the whole path;
1697
others match against only the last component.
1699
If the file is ignored, returns the pattern which caused it to
1700
be ignored, otherwise None. So this can simply be used as a
1701
boolean if desired."""
1702
if getattr(self, '_ignoreglobster', None) is None:
1703
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1704
return self._ignoreglobster.match(filename)
1706
def kind(self, file_id):
1707
return file_kind(self.id2abspath(file_id))
1709
def stored_kind(self, file_id):
1710
"""See Tree.stored_kind"""
1711
return self.inventory[file_id].kind
1713
def _comparison_data(self, entry, path):
1714
abspath = self.abspath(path)
1716
stat_value = os.lstat(abspath)
1718
if getattr(e, 'errno', None) == errno.ENOENT:
1725
mode = stat_value.st_mode
1726
kind = osutils.file_kind_from_stat_mode(mode)
1727
if not supports_executable():
1728
executable = entry is not None and entry.executable
1730
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1731
return kind, executable, stat_value
1733
def _file_size(self, entry, stat_value):
1734
return stat_value.st_size
1736
def last_revision(self):
1737
"""Return the last revision of the branch for this tree.
1739
This format tree does not support a separate marker for last-revision
1740
compared to the branch.
1742
See MutableTree.last_revision
1744
return self._last_revision()
1747
def _last_revision(self):
1748
"""helper for get_parent_ids."""
1749
return _mod_revision.ensure_null(self.branch.last_revision())
1751
def is_locked(self):
1752
return self._control_files.is_locked()
1754
def _must_be_locked(self):
1755
if not self.is_locked():
1756
raise errors.ObjectNotLocked(self)
1758
def lock_read(self):
1759
"""See Branch.lock_read, and WorkingTree.unlock."""
1760
if not self.is_locked():
1762
self.branch.lock_read()
1764
return self._control_files.lock_read()
1766
self.branch.unlock()
1769
def lock_tree_write(self):
1770
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1771
if not self.is_locked():
1773
self.branch.lock_read()
1775
return self._control_files.lock_write()
1777
self.branch.unlock()
1780
def lock_write(self):
1781
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1782
if not self.is_locked():
1784
self.branch.lock_write()
1786
return self._control_files.lock_write()
1788
self.branch.unlock()
1791
def get_physical_lock_status(self):
1792
return self._control_files.get_physical_lock_status()
1794
def _basis_inventory_name(self):
1795
return 'basis-inventory-cache'
1797
def _reset_data(self):
1798
"""Reset transient data that cannot be revalidated."""
1799
self._inventory_is_modified = False
1800
result = self._deserialize(self._transport.get('inventory'))
1801
self._set_inventory(result, dirty=False)
1803
@needs_tree_write_lock
1804
def set_last_revision(self, new_revision):
1805
"""Change the last revision in the working tree."""
1806
if self._change_last_revision(new_revision):
1807
self._cache_basis_inventory(new_revision)
1809
def _change_last_revision(self, new_revision):
1810
"""Template method part of set_last_revision to perform the change.
1812
This is used to allow WorkingTree3 instances to not affect branch
1813
when their last revision is set.
1815
if _mod_revision.is_null(new_revision):
1816
self.branch.set_revision_history([])
1819
self.branch.generate_revision_history(new_revision)
1820
except errors.NoSuchRevision:
1821
# not present in the repo - dont try to set it deeper than the tip
1822
self.branch.set_revision_history([new_revision])
1825
def _write_basis_inventory(self, xml):
1826
"""Write the basis inventory XML to the basis-inventory file"""
1827
path = self._basis_inventory_name()
1829
self._transport.put_file(path, sio,
1830
mode=self._control_files._file_mode)
1832
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1833
"""Create the text that will be saved in basis-inventory"""
1834
inventory.revision_id = revision_id
1835
return xml7.serializer_v7.write_inventory_to_string(inventory)
1837
def _cache_basis_inventory(self, new_revision):
1838
"""Cache new_revision as the basis inventory."""
1839
# TODO: this should allow the ready-to-use inventory to be passed in,
1840
# as commit already has that ready-to-use [while the format is the
1843
# this double handles the inventory - unpack and repack -
1844
# but is easier to understand. We can/should put a conditional
1845
# in here based on whether the inventory is in the latest format
1846
# - perhaps we should repack all inventories on a repository
1848
# the fast path is to copy the raw xml from the repository. If the
1849
# xml contains 'revision_id="', then we assume the right
1850
# revision_id is set. We must check for this full string, because a
1851
# root node id can legitimately look like 'revision_id' but cannot
1853
xml = self.branch.repository.get_inventory_xml(new_revision)
1854
firstline = xml.split('\n', 1)[0]
1855
if (not 'revision_id="' in firstline or
1856
'format="7"' not in firstline):
1857
inv = self.branch.repository.deserialise_inventory(
1859
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1860
self._write_basis_inventory(xml)
1861
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1864
def read_basis_inventory(self):
1865
"""Read the cached basis inventory."""
1866
path = self._basis_inventory_name()
1867
return self._transport.get_bytes(path)
1870
def read_working_inventory(self):
1871
"""Read the working inventory.
1873
:raises errors.InventoryModified: read_working_inventory will fail
1874
when the current in memory inventory has been modified.
1876
# conceptually this should be an implementation detail of the tree.
1877
# XXX: Deprecate this.
1878
# ElementTree does its own conversion from UTF-8, so open in
1880
if self._inventory_is_modified:
1881
raise errors.InventoryModified(self)
1882
result = self._deserialize(self._transport.get('inventory'))
1883
self._set_inventory(result, dirty=False)
1886
@needs_tree_write_lock
1887
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1889
"""Remove nominated files from the working inventory.
1891
:files: File paths relative to the basedir.
1892
:keep_files: If true, the files will also be kept.
1893
:force: Delete files and directories, even if they are changed and
1894
even if the directories are not empty.
1896
if isinstance(files, basestring):
1902
unknown_nested_files=set()
1904
def recurse_directory_to_add_files(directory):
1905
# Recurse directory and add all files
1906
# so we can check if they have changed.
1907
for parent_info, file_infos in\
1908
self.walkdirs(directory):
1909
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1910
# Is it versioned or ignored?
1911
if self.path2id(relpath) or self.is_ignored(relpath):
1912
# Add nested content for deletion.
1913
new_files.add(relpath)
1915
# Files which are not versioned and not ignored
1916
# should be treated as unknown.
1917
unknown_nested_files.add((relpath, None, kind))
1919
for filename in files:
1920
# Get file name into canonical form.
1921
abspath = self.abspath(filename)
1922
filename = self.relpath(abspath)
1923
if len(filename) > 0:
1924
new_files.add(filename)
1925
recurse_directory_to_add_files(filename)
1927
files = list(new_files)
1930
return # nothing to do
1932
# Sort needed to first handle directory content before the directory
1933
files.sort(reverse=True)
1935
# Bail out if we are going to delete files we shouldn't
1936
if not keep_files and not force:
1937
has_changed_files = len(unknown_nested_files) > 0
1938
if not has_changed_files:
1939
for (file_id, path, content_change, versioned, parent_id, name,
1940
kind, executable) in self.iter_changes(self.basis_tree(),
1941
include_unchanged=True, require_versioned=False,
1942
want_unversioned=True, specific_files=files):
1943
if versioned == (False, False):
1944
# The record is unknown ...
1945
if not self.is_ignored(path[1]):
1946
# ... but not ignored
1947
has_changed_files = True
1949
elif content_change and (kind[1] is not None):
1950
# Versioned and changed, but not deleted
1951
has_changed_files = True
1954
if has_changed_files:
1955
# Make delta show ALL applicable changes in error message.
1956
tree_delta = self.changes_from(self.basis_tree(),
1957
require_versioned=False, want_unversioned=True,
1958
specific_files=files)
1959
for unknown_file in unknown_nested_files:
1960
if unknown_file not in tree_delta.unversioned:
1961
tree_delta.unversioned.extend((unknown_file,))
1962
raise errors.BzrRemoveChangedFilesError(tree_delta)
1964
# Build inv_delta and delete files where applicaple,
1965
# do this before any modifications to inventory.
1967
fid = self.path2id(f)
1970
message = "%s is not versioned." % (f,)
1973
# having removed it, it must be either ignored or unknown
1974
if self.is_ignored(f):
1978
textui.show_status(new_status, self.kind(fid), f,
1981
inv_delta.append((f, None, fid, None))
1982
message = "removed %s" % (f,)
1985
abs_path = self.abspath(f)
1986
if osutils.lexists(abs_path):
1987
if (osutils.isdir(abs_path) and
1988
len(os.listdir(abs_path)) > 0):
1990
osutils.rmtree(abs_path)
1992
message = "%s is not an empty directory "\
1993
"and won't be deleted." % (f,)
1995
osutils.delete_any(abs_path)
1996
message = "deleted %s" % (f,)
1997
elif message is not None:
1998
# Only care if we haven't done anything yet.
1999
message = "%s does not exist." % (f,)
2001
# Print only one message (if any) per file.
2002
if message is not None:
2004
self.apply_inventory_delta(inv_delta)
2006
@needs_tree_write_lock
2007
def revert(self, filenames=None, old_tree=None, backups=True,
2008
pb=DummyProgress(), report_changes=False):
2009
from bzrlib.conflicts import resolve
2012
symbol_versioning.warn('Using [] to revert all files is deprecated'
2013
' as of bzr 0.91. Please use None (the default) instead.',
2014
DeprecationWarning, stacklevel=2)
2015
if old_tree is None:
2016
basis_tree = self.basis_tree()
2017
basis_tree.lock_read()
2018
old_tree = basis_tree
2022
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2024
if filenames is None and len(self.get_parent_ids()) > 1:
2026
last_revision = self.last_revision()
2027
if last_revision != NULL_REVISION:
2028
if basis_tree is None:
2029
basis_tree = self.basis_tree()
2030
basis_tree.lock_read()
2031
parent_trees.append((last_revision, basis_tree))
2032
self.set_parent_trees(parent_trees)
2035
resolve(self, filenames, ignore_misses=True, recursive=True)
2037
if basis_tree is not None:
2041
def revision_tree(self, revision_id):
2042
"""See Tree.revision_tree.
2044
WorkingTree can supply revision_trees for the basis revision only
2045
because there is only one cached inventory in the bzr directory.
2047
if revision_id == self.last_revision():
2049
xml = self.read_basis_inventory()
2050
except errors.NoSuchFile:
2054
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2055
# dont use the repository revision_tree api because we want
2056
# to supply the inventory.
2057
if inv.revision_id == revision_id:
2058
return revisiontree.RevisionTree(self.branch.repository,
2060
except errors.BadInventoryFormat:
2062
# raise if there was no inventory, or if we read the wrong inventory.
2063
raise errors.NoSuchRevisionInTree(self, revision_id)
2065
# XXX: This method should be deprecated in favour of taking in a proper
2066
# new Inventory object.
2067
@needs_tree_write_lock
2068
def set_inventory(self, new_inventory_list):
2069
from bzrlib.inventory import (Inventory,
2074
inv = Inventory(self.get_root_id())
2075
for path, file_id, parent, kind in new_inventory_list:
2076
name = os.path.basename(path)
2079
# fixme, there should be a factory function inv,add_??
2080
if kind == 'directory':
2081
inv.add(InventoryDirectory(file_id, name, parent))
2082
elif kind == 'file':
2083
inv.add(InventoryFile(file_id, name, parent))
2084
elif kind == 'symlink':
2085
inv.add(InventoryLink(file_id, name, parent))
2087
raise errors.BzrError("unknown kind %r" % kind)
2088
self._write_inventory(inv)
2090
@needs_tree_write_lock
2091
def set_root_id(self, file_id):
2092
"""Set the root id for this tree."""
2096
'WorkingTree.set_root_id with fileid=None')
2097
file_id = osutils.safe_file_id(file_id)
2098
self._set_root_id(file_id)
2100
def _set_root_id(self, file_id):
2101
"""Set the root id for this tree, in a format specific manner.
2103
:param file_id: The file id to assign to the root. It must not be
2104
present in the current inventory or an error will occur. It must
2105
not be None, but rather a valid file id.
2107
inv = self._inventory
2108
orig_root_id = inv.root.file_id
2109
# TODO: it might be nice to exit early if there was nothing
2110
# to do, saving us from trigger a sync on unlock.
2111
self._inventory_is_modified = True
2112
# we preserve the root inventory entry object, but
2113
# unlinkit from the byid index
2114
del inv._byid[inv.root.file_id]
2115
inv.root.file_id = file_id
2116
# and link it into the index with the new changed id.
2117
inv._byid[inv.root.file_id] = inv.root
2118
# and finally update all children to reference the new id.
2119
# XXX: this should be safe to just look at the root.children
2120
# list, not the WHOLE INVENTORY.
2123
if entry.parent_id == orig_root_id:
2124
entry.parent_id = inv.root.file_id
2127
"""See Branch.unlock.
2129
WorkingTree locking just uses the Branch locking facilities.
2130
This is current because all working trees have an embedded branch
2131
within them. IF in the future, we were to make branch data shareable
2132
between multiple working trees, i.e. via shared storage, then we
2133
would probably want to lock both the local tree, and the branch.
2135
raise NotImplementedError(self.unlock)
2137
def update(self, change_reporter=None, possible_transports=None):
2138
"""Update a working tree along its branch.
2140
This will update the branch if its bound too, which means we have
2141
multiple trees involved:
2143
- The new basis tree of the master.
2144
- The old basis tree of the branch.
2145
- The old basis tree of the working tree.
2146
- The current working tree state.
2148
Pathologically, all three may be different, and non-ancestors of each
2149
other. Conceptually we want to:
2151
- Preserve the wt.basis->wt.state changes
2152
- Transform the wt.basis to the new master basis.
2153
- Apply a merge of the old branch basis to get any 'local' changes from
2155
- Restore the wt.basis->wt.state changes.
2157
There isn't a single operation at the moment to do that, so we:
2158
- Merge current state -> basis tree of the master w.r.t. the old tree
2160
- Do a 'normal' merge of the old branch basis if it is relevant.
2162
if self.branch.get_bound_location() is not None:
2164
update_branch = True
2166
self.lock_tree_write()
2167
update_branch = False
2170
old_tip = self.branch.update(possible_transports)
2173
return self._update_tree(old_tip, change_reporter)
2177
@needs_tree_write_lock
2178
def _update_tree(self, old_tip=None, change_reporter=None):
2179
"""Update a tree to the master branch.
2181
:param old_tip: if supplied, the previous tip revision the branch,
2182
before it was changed to the master branch's tip.
2184
# here if old_tip is not None, it is the old tip of the branch before
2185
# it was updated from the master branch. This should become a pending
2186
# merge in the working tree to preserve the user existing work. we
2187
# cant set that until we update the working trees last revision to be
2188
# one from the new branch, because it will just get absorbed by the
2189
# parent de-duplication logic.
2191
# We MUST save it even if an error occurs, because otherwise the users
2192
# local work is unreferenced and will appear to have been lost.
2196
last_rev = self.get_parent_ids()[0]
2198
last_rev = _mod_revision.NULL_REVISION
2199
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2200
# merge tree state up to new branch tip.
2201
basis = self.basis_tree()
2204
to_tree = self.branch.basis_tree()
2205
if basis.inventory.root is None:
2206
self.set_root_id(to_tree.get_root_id())
2208
result += merge.merge_inner(
2213
change_reporter=change_reporter)
2216
# TODO - dedup parents list with things merged by pull ?
2217
# reuse the tree we've updated to to set the basis:
2218
parent_trees = [(self.branch.last_revision(), to_tree)]
2219
merges = self.get_parent_ids()[1:]
2220
# Ideally we ask the tree for the trees here, that way the working
2221
# tree can decide whether to give us teh entire tree or give us a
2222
# lazy initialised tree. dirstate for instance will have the trees
2223
# in ram already, whereas a last-revision + basis-inventory tree
2224
# will not, but also does not need them when setting parents.
2225
for parent in merges:
2226
parent_trees.append(
2227
(parent, self.branch.repository.revision_tree(parent)))
2228
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2229
parent_trees.append(
2230
(old_tip, self.branch.repository.revision_tree(old_tip)))
2231
self.set_parent_trees(parent_trees)
2232
last_rev = parent_trees[0][0]
2234
# the working tree had the same last-revision as the master
2235
# branch did. We may still have pivot local work from the local
2236
# branch into old_tip:
2237
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2238
self.add_parent_tree_id(old_tip)
2239
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2240
and old_tip != last_rev):
2241
# our last revision was not the prior branch last revision
2242
# and we have converted that last revision to a pending merge.
2243
# base is somewhere between the branch tip now
2244
# and the now pending merge
2246
# Since we just modified the working tree and inventory, flush out
2247
# the current state, before we modify it again.
2248
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2249
# requires it only because TreeTransform directly munges the
2250
# inventory and calls tree._write_inventory(). Ultimately we
2251
# should be able to remove this extra flush.
2253
graph = self.branch.repository.get_graph()
2254
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2256
base_tree = self.branch.repository.revision_tree(base_rev_id)
2257
other_tree = self.branch.repository.revision_tree(old_tip)
2258
result += merge.merge_inner(
2263
change_reporter=change_reporter)
2266
def _write_hashcache_if_dirty(self):
2267
"""Write out the hashcache if it is dirty."""
2268
if self._hashcache.needs_write:
2270
self._hashcache.write()
2272
if e.errno not in (errno.EPERM, errno.EACCES):
2274
# TODO: jam 20061219 Should this be a warning? A single line
2275
# warning might be sufficient to let the user know what
2277
mutter('Could not write hashcache for %s\nError: %s',
2278
self._hashcache.cache_file_name(), e)
2280
@needs_tree_write_lock
2281
def _write_inventory(self, inv):
2282
"""Write inventory as the current inventory."""
2283
self._set_inventory(inv, dirty=True)
2286
def set_conflicts(self, arg):
2287
raise errors.UnsupportedOperation(self.set_conflicts, self)
2289
def add_conflicts(self, arg):
2290
raise errors.UnsupportedOperation(self.add_conflicts, self)
2293
def conflicts(self):
2294
conflicts = _mod_conflicts.ConflictList()
2295
for conflicted in self._iter_conflicts():
2298
if file_kind(self.abspath(conflicted)) != "file":
2300
except errors.NoSuchFile:
2303
for suffix in ('.THIS', '.OTHER'):
2305
kind = file_kind(self.abspath(conflicted+suffix))
2308
except errors.NoSuchFile:
2312
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2313
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2315
file_id=self.path2id(conflicted)))
2318
def walkdirs(self, prefix=""):
2319
"""Walk the directories of this tree.
2321
returns a generator which yields items in the form:
2322
((curren_directory_path, fileid),
2323
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2326
This API returns a generator, which is only valid during the current
2327
tree transaction - within a single lock_read or lock_write duration.
2329
If the tree is not locked, it may cause an error to be raised,
2330
depending on the tree implementation.
2332
disk_top = self.abspath(prefix)
2333
if disk_top.endswith('/'):
2334
disk_top = disk_top[:-1]
2335
top_strip_len = len(disk_top) + 1
2336
inventory_iterator = self._walkdirs(prefix)
2337
disk_iterator = osutils.walkdirs(disk_top, prefix)
2339
current_disk = disk_iterator.next()
2340
disk_finished = False
2342
if not (e.errno == errno.ENOENT or
2343
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2346
disk_finished = True
2348
current_inv = inventory_iterator.next()
2349
inv_finished = False
2350
except StopIteration:
2353
while not inv_finished or not disk_finished:
2355
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2356
cur_disk_dir_content) = current_disk
2358
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2359
cur_disk_dir_content) = ((None, None), None)
2360
if not disk_finished:
2361
# strip out .bzr dirs
2362
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2363
len(cur_disk_dir_content) > 0):
2364
# osutils.walkdirs can be made nicer -
2365
# yield the path-from-prefix rather than the pathjoined
2367
bzrdir_loc = bisect_left(cur_disk_dir_content,
2369
if (bzrdir_loc < len(cur_disk_dir_content)
2370
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2371
# we dont yield the contents of, or, .bzr itself.
2372
del cur_disk_dir_content[bzrdir_loc]
2374
# everything is unknown
2377
# everything is missing
2380
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2382
# disk is before inventory - unknown
2383
dirblock = [(relpath, basename, kind, stat, None, None) for
2384
relpath, basename, kind, stat, top_path in
2385
cur_disk_dir_content]
2386
yield (cur_disk_dir_relpath, None), dirblock
2388
current_disk = disk_iterator.next()
2389
except StopIteration:
2390
disk_finished = True
2392
# inventory is before disk - missing.
2393
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2394
for relpath, basename, dkind, stat, fileid, kind in
2396
yield (current_inv[0][0], current_inv[0][1]), dirblock
2398
current_inv = inventory_iterator.next()
2399
except StopIteration:
2402
# versioned present directory
2403
# merge the inventory and disk data together
2405
for relpath, subiterator in itertools.groupby(sorted(
2406
current_inv[1] + cur_disk_dir_content,
2407
key=operator.itemgetter(0)), operator.itemgetter(1)):
2408
path_elements = list(subiterator)
2409
if len(path_elements) == 2:
2410
inv_row, disk_row = path_elements
2411
# versioned, present file
2412
dirblock.append((inv_row[0],
2413
inv_row[1], disk_row[2],
2414
disk_row[3], inv_row[4],
2416
elif len(path_elements[0]) == 5:
2418
dirblock.append((path_elements[0][0],
2419
path_elements[0][1], path_elements[0][2],
2420
path_elements[0][3], None, None))
2421
elif len(path_elements[0]) == 6:
2422
# versioned, absent file.
2423
dirblock.append((path_elements[0][0],
2424
path_elements[0][1], 'unknown', None,
2425
path_elements[0][4], path_elements[0][5]))
2427
raise NotImplementedError('unreachable code')
2428
yield current_inv[0], dirblock
2430
current_inv = inventory_iterator.next()
2431
except StopIteration:
2434
current_disk = disk_iterator.next()
2435
except StopIteration:
2436
disk_finished = True
2438
def _walkdirs(self, prefix=""):
2439
"""Walk the directories of this tree.
2441
:prefix: is used as the directrory to start with.
2442
returns a generator which yields items in the form:
2443
((curren_directory_path, fileid),
2444
[(file1_path, file1_name, file1_kind, None, file1_id,
2447
_directory = 'directory'
2448
# get the root in the inventory
2449
inv = self.inventory
2450
top_id = inv.path2id(prefix)
2454
pending = [(prefix, '', _directory, None, top_id, None)]
2457
currentdir = pending.pop()
2458
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2459
top_id = currentdir[4]
2461
relroot = currentdir[0] + '/'
2464
# FIXME: stash the node in pending
2466
if entry.kind == 'directory':
2467
for name, child in entry.sorted_children():
2468
dirblock.append((relroot + name, name, child.kind, None,
2469
child.file_id, child.kind
2471
yield (currentdir[0], entry.file_id), dirblock
2472
# push the user specified dirs from dirblock
2473
for dir in reversed(dirblock):
2474
if dir[2] == _directory:
2477
@needs_tree_write_lock
2478
def auto_resolve(self):
2479
"""Automatically resolve text conflicts according to contents.
2481
Only text conflicts are auto_resolvable. Files with no conflict markers
2482
are considered 'resolved', because bzr always puts conflict markers
2483
into files that have text conflicts. The corresponding .THIS .BASE and
2484
.OTHER files are deleted, as per 'resolve'.
2485
:return: a tuple of ConflictLists: (un_resolved, resolved).
2487
un_resolved = _mod_conflicts.ConflictList()
2488
resolved = _mod_conflicts.ConflictList()
2489
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2490
for conflict in self.conflicts():
2491
if (conflict.typestring != 'text conflict' or
2492
self.kind(conflict.file_id) != 'file'):
2493
un_resolved.append(conflict)
2495
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2497
for line in my_file:
2498
if conflict_re.search(line):
2499
un_resolved.append(conflict)
2502
resolved.append(conflict)
2505
resolved.remove_files(self)
2506
self.set_conflicts(un_resolved)
2507
return un_resolved, resolved
2511
tree_basis = self.basis_tree()
2512
tree_basis.lock_read()
2514
repo_basis = self.branch.repository.revision_tree(
2515
self.last_revision())
2516
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2517
raise errors.BzrCheckError(
2518
"Mismatched basis inventory content.")
2523
def _validate(self):
2524
"""Validate internal structures.
2526
This is meant mostly for the test suite. To give it a chance to detect
2527
corruption after actions have occurred. The default implementation is a
2530
:return: None. An exception should be raised if there is an error.
2535
def _get_rules_searcher(self, default_searcher):
2536
"""See Tree._get_rules_searcher."""
2537
if self._rules_searcher is None:
2538
self._rules_searcher = super(WorkingTree,
2539
self)._get_rules_searcher(default_searcher)
2540
return self._rules_searcher
2542
def get_shelf_manager(self):
2543
"""Return the ShelfManager for this WorkingTree."""
2544
from bzrlib.shelf import ShelfManager
2545
return ShelfManager(self, self._transport)
2548
class WorkingTree2(WorkingTree):
2549
"""This is the Format 2 working tree.
2551
This was the first weave based working tree.
2552
- uses os locks for locking.
2553
- uses the branch last-revision.
2556
def __init__(self, *args, **kwargs):
2557
super(WorkingTree2, self).__init__(*args, **kwargs)
2558
# WorkingTree2 has more of a constraint that self._inventory must
2559
# exist. Because this is an older format, we don't mind the overhead
2560
# caused by the extra computation here.
2562
# Newer WorkingTree's should only have self._inventory set when they
2564
if self._inventory is None:
2565
self.read_working_inventory()
2567
def lock_tree_write(self):
2568
"""See WorkingTree.lock_tree_write().
2570
In Format2 WorkingTrees we have a single lock for the branch and tree
2571
so lock_tree_write() degrades to lock_write().
2573
self.branch.lock_write()
2575
return self._control_files.lock_write()
2577
self.branch.unlock()
2581
# do non-implementation specific cleanup
2584
# we share control files:
2585
if self._control_files._lock_count == 3:
2586
# _inventory_is_modified is always False during a read lock.
2587
if self._inventory_is_modified:
2589
self._write_hashcache_if_dirty()
2591
# reverse order of locking.
2593
return self._control_files.unlock()
2595
self.branch.unlock()
2598
class WorkingTree3(WorkingTree):
2599
"""This is the Format 3 working tree.
2601
This differs from the base WorkingTree by:
2602
- having its own file lock
2603
- having its own last-revision property.
2605
This is new in bzr 0.8
2609
def _last_revision(self):
2610
"""See Mutable.last_revision."""
2612
return self._transport.get_bytes('last-revision')
2613
except errors.NoSuchFile:
2614
return _mod_revision.NULL_REVISION
2616
def _change_last_revision(self, revision_id):
2617
"""See WorkingTree._change_last_revision."""
2618
if revision_id is None or revision_id == NULL_REVISION:
2620
self._transport.delete('last-revision')
2621
except errors.NoSuchFile:
2625
self._transport.put_bytes('last-revision', revision_id,
2626
mode=self._control_files._file_mode)
2629
@needs_tree_write_lock
2630
def set_conflicts(self, conflicts):
2631
self._put_rio('conflicts', conflicts.to_stanzas(),
2634
@needs_tree_write_lock
2635
def add_conflicts(self, new_conflicts):
2636
conflict_set = set(self.conflicts())
2637
conflict_set.update(set(list(new_conflicts)))
2638
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2639
key=_mod_conflicts.Conflict.sort_key)))
2642
def conflicts(self):
2644
confile = self._transport.get('conflicts')
2645
except errors.NoSuchFile:
2646
return _mod_conflicts.ConflictList()
2649
if confile.next() != CONFLICT_HEADER_1 + '\n':
2650
raise errors.ConflictFormatError()
2651
except StopIteration:
2652
raise errors.ConflictFormatError()
2653
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2658
# do non-implementation specific cleanup
2660
if self._control_files._lock_count == 1:
2661
# _inventory_is_modified is always False during a read lock.
2662
if self._inventory_is_modified:
2664
self._write_hashcache_if_dirty()
2665
# reverse order of locking.
2667
return self._control_files.unlock()
2669
self.branch.unlock()
2672
def get_conflicted_stem(path):
2673
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2674
if path.endswith(suffix):
2675
return path[:-len(suffix)]
2678
class WorkingTreeFormat(object):
2679
"""An encapsulation of the initialization and open routines for a format.
2681
Formats provide three things:
2682
* An initialization routine,
2686
Formats are placed in an dict by their format string for reference
2687
during workingtree opening. Its not required that these be instances, they
2688
can be classes themselves with class methods - it simply depends on
2689
whether state is needed for a given format or not.
2691
Once a format is deprecated, just deprecate the initialize and open
2692
methods on the format class. Do not deprecate the object, as the
2693
object will be created every time regardless.
2696
_default_format = None
2697
"""The default format used for new trees."""
2700
"""The known formats."""
2702
requires_rich_root = False
2704
upgrade_recommended = False
2707
def find_format(klass, a_bzrdir):
2708
"""Return the format for the working tree object in a_bzrdir."""
2710
transport = a_bzrdir.get_workingtree_transport(None)
2711
format_string = transport.get("format").read()
2712
return klass._formats[format_string]
2713
except errors.NoSuchFile:
2714
raise errors.NoWorkingTree(base=transport.base)
2716
raise errors.UnknownFormatError(format=format_string,
2717
kind="working tree")
2719
def __eq__(self, other):
2720
return self.__class__ is other.__class__
2722
def __ne__(self, other):
2723
return not (self == other)
2726
def get_default_format(klass):
2727
"""Return the current default format."""
2728
return klass._default_format
2730
def get_format_string(self):
2731
"""Return the ASCII format string that identifies this format."""
2732
raise NotImplementedError(self.get_format_string)
2734
def get_format_description(self):
2735
"""Return the short description for this format."""
2736
raise NotImplementedError(self.get_format_description)
2738
def is_supported(self):
2739
"""Is this format supported?
2741
Supported formats can be initialized and opened.
2742
Unsupported formats may not support initialization or committing or
2743
some other features depending on the reason for not being supported.
2747
def supports_content_filtering(self):
2748
"""True if this format supports content filtering."""
2751
def supports_views(self):
2752
"""True if this format supports stored views."""
2756
def register_format(klass, format):
2757
klass._formats[format.get_format_string()] = format
2760
def set_default_format(klass, format):
2761
klass._default_format = format
2764
def unregister_format(klass, format):
2765
del klass._formats[format.get_format_string()]
2768
class WorkingTreeFormat2(WorkingTreeFormat):
2769
"""The second working tree format.
2771
This format modified the hash cache from the format 1 hash cache.
2774
upgrade_recommended = True
2776
def get_format_description(self):
2777
"""See WorkingTreeFormat.get_format_description()."""
2778
return "Working tree format 2"
2780
def _stub_initialize_on_transport(self, transport, file_mode):
2781
"""Workaround: create control files for a remote working tree.
2783
This ensures that it can later be updated and dealt with locally,
2784
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2785
no working tree. (See bug #43064).
2789
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2791
transport.put_file('inventory', sio, file_mode)
2792
transport.put_bytes('pending-merges', '', file_mode)
2794
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2795
accelerator_tree=None, hardlink=False):
2796
"""See WorkingTreeFormat.initialize()."""
2797
if not isinstance(a_bzrdir.transport, LocalTransport):
2798
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2799
if from_branch is not None:
2800
branch = from_branch
2802
branch = a_bzrdir.open_branch()
2803
if revision_id is None:
2804
revision_id = _mod_revision.ensure_null(branch.last_revision())
2807
branch.generate_revision_history(revision_id)
2811
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2817
basis_tree = branch.repository.revision_tree(revision_id)
2818
if basis_tree.inventory.root is not None:
2819
wt.set_root_id(basis_tree.get_root_id())
2820
# set the parent list and cache the basis tree.
2821
if _mod_revision.is_null(revision_id):
2824
parent_trees = [(revision_id, basis_tree)]
2825
wt.set_parent_trees(parent_trees)
2826
transform.build_tree(basis_tree, wt)
2830
super(WorkingTreeFormat2, self).__init__()
2831
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2833
def open(self, a_bzrdir, _found=False):
2834
"""Return the WorkingTree object for a_bzrdir
2836
_found is a private parameter, do not use it. It is used to indicate
2837
if format probing has already been done.
2840
# we are being called directly and must probe.
2841
raise NotImplementedError
2842
if not isinstance(a_bzrdir.transport, LocalTransport):
2843
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2844
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2850
class WorkingTreeFormat3(WorkingTreeFormat):
2851
"""The second working tree format updated to record a format marker.
2854
- exists within a metadir controlling .bzr
2855
- includes an explicit version marker for the workingtree control
2856
files, separate from the BzrDir format
2857
- modifies the hash cache format
2859
- uses a LockDir to guard access for writes.
2862
upgrade_recommended = True
2864
def get_format_string(self):
2865
"""See WorkingTreeFormat.get_format_string()."""
2866
return "Bazaar-NG Working Tree format 3"
2868
def get_format_description(self):
2869
"""See WorkingTreeFormat.get_format_description()."""
2870
return "Working tree format 3"
2872
_lock_file_name = 'lock'
2873
_lock_class = LockDir
2875
_tree_class = WorkingTree3
2877
def __get_matchingbzrdir(self):
2878
return bzrdir.BzrDirMetaFormat1()
2880
_matchingbzrdir = property(__get_matchingbzrdir)
2882
def _open_control_files(self, a_bzrdir):
2883
transport = a_bzrdir.get_workingtree_transport(None)
2884
return LockableFiles(transport, self._lock_file_name,
2887
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2888
accelerator_tree=None, hardlink=False):
2889
"""See WorkingTreeFormat.initialize().
2891
:param revision_id: if supplied, create a working tree at a different
2892
revision than the branch is at.
2893
:param accelerator_tree: A tree which can be used for retrieving file
2894
contents more quickly than the revision tree, i.e. a workingtree.
2895
The revision tree will be used for cases where accelerator_tree's
2896
content is different.
2897
:param hardlink: If true, hard-link files from accelerator_tree,
2900
if not isinstance(a_bzrdir.transport, LocalTransport):
2901
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2902
transport = a_bzrdir.get_workingtree_transport(self)
2903
control_files = self._open_control_files(a_bzrdir)
2904
control_files.create_lock()
2905
control_files.lock_write()
2906
transport.put_bytes('format', self.get_format_string(),
2907
mode=control_files._file_mode)
2908
if from_branch is not None:
2909
branch = from_branch
2911
branch = a_bzrdir.open_branch()
2912
if revision_id is None:
2913
revision_id = _mod_revision.ensure_null(branch.last_revision())
2914
# WorkingTree3 can handle an inventory which has a unique root id.
2915
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2916
# those trees. And because there isn't a format bump inbetween, we
2917
# are maintaining compatibility with older clients.
2918
# inv = Inventory(root_id=gen_root_id())
2919
inv = self._initial_inventory()
2920
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2926
_control_files=control_files)
2927
wt.lock_tree_write()
2929
basis_tree = branch.repository.revision_tree(revision_id)
2930
# only set an explicit root id if there is one to set.
2931
if basis_tree.inventory.root is not None:
2932
wt.set_root_id(basis_tree.get_root_id())
2933
if revision_id == NULL_REVISION:
2934
wt.set_parent_trees([])
2936
wt.set_parent_trees([(revision_id, basis_tree)])
2937
transform.build_tree(basis_tree, wt)
2939
# Unlock in this order so that the unlock-triggers-flush in
2940
# WorkingTree is given a chance to fire.
2941
control_files.unlock()
2945
def _initial_inventory(self):
2949
super(WorkingTreeFormat3, self).__init__()
2951
def open(self, a_bzrdir, _found=False):
2952
"""Return the WorkingTree object for a_bzrdir
2954
_found is a private parameter, do not use it. It is used to indicate
2955
if format probing has already been done.
2958
# we are being called directly and must probe.
2959
raise NotImplementedError
2960
if not isinstance(a_bzrdir.transport, LocalTransport):
2961
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2962
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2965
def _open(self, a_bzrdir, control_files):
2966
"""Open the tree itself.
2968
:param a_bzrdir: the dir for the tree.
2969
:param control_files: the control files for the tree.
2971
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2975
_control_files=control_files)
2978
return self.get_format_string()
2981
__default_format = WorkingTreeFormat4()
2982
WorkingTreeFormat.register_format(__default_format)
2983
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2984
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2985
WorkingTreeFormat.set_default_format(__default_format)
2986
# formats which have no format string are not discoverable
2987
# and not independently creatable, so are not registered.
2988
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
