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,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.filters import filtered_input_file
106
from bzrlib.trace import mutter, note
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
110
from bzrlib.rio import RioReader, rio_file, Stanza
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
124
class TreeEntry(object):
125
"""An entry that implements the minimum interface used by commands.
127
This needs further inspection, it may be better to have
128
InventoryEntries without ids - though that seems wrong. For now,
129
this is a parallel hierarchy to InventoryEntry, and needs to become
130
one of several things: decorates to that hierarchy, children of, or
132
Another note is that these objects are currently only used when there is
133
no InventoryEntry available - i.e. for unversioned objects.
134
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
137
def __eq__(self, other):
138
# yes, this us ugly, TODO: best practice __eq__ style.
139
return (isinstance(other, TreeEntry)
140
and other.__class__ == self.__class__)
142
def kind_character(self):
146
class TreeDirectory(TreeEntry):
147
"""See TreeEntry. This is a directory in a working tree."""
149
def __eq__(self, other):
150
return (isinstance(other, TreeDirectory)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeFile(TreeEntry):
158
"""See TreeEntry. This is a regular file in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeFile)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeLink(TreeEntry):
169
"""See TreeEntry. This is a symlink in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeLink)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class WorkingTree(bzrlib.mutabletree.MutableTree):
180
"""Working copy tree.
182
The inventory is held in the `Branch` working-inventory, and the
183
files are in a directory on disk.
185
It is possible for a `WorkingTree` to have a filename which is
186
not listed in the Inventory and vice versa.
189
def __init__(self, basedir='.',
190
branch=DEPRECATED_PARAMETER,
196
"""Construct a WorkingTree instance. This is not a public API.
198
:param branch: A branch to override probing for the branch.
200
self._format = _format
201
self.bzrdir = _bzrdir
203
raise errors.BzrError("Please use bzrdir.open_workingtree or "
204
"WorkingTree.open() to obtain a WorkingTree.")
205
basedir = safe_unicode(basedir)
206
mutter("opening working tree %r", basedir)
207
if deprecated_passed(branch):
208
self._branch = branch
210
self._branch = self.bzrdir.open_branch()
211
self.basedir = realpath(basedir)
212
# if branch is at our basedir and is a format 6 or less
213
if isinstance(self._format, WorkingTreeFormat2):
214
# share control object
215
self._control_files = self.branch.control_files
217
# assume all other formats have their own control files.
218
self._control_files = _control_files
219
self._transport = self._control_files._transport
220
# update the whole cache up front and write to disk if anything changed;
221
# in the future we might want to do this more selectively
222
# two possible ways offer themselves : in self._unlock, write the cache
223
# if needed, or, when the cache sees a change, append it to the hash
224
# cache file, and have the parser take the most recent entry for a
226
wt_trans = self.bzrdir.get_workingtree_transport(None)
227
cache_filename = wt_trans.local_abspath('stat-cache')
228
self._hashcache = hashcache.HashCache(basedir, cache_filename,
229
self.bzrdir._get_file_mode(),
230
lambda path, file_id: self._content_filter_stack(path, file_id))
233
# is this scan needed ? it makes things kinda slow.
240
if _inventory is None:
241
# This will be acquired on lock_read() or lock_write()
242
self._inventory_is_modified = False
243
self._inventory = None
245
# the caller of __init__ has provided an inventory,
246
# we assume they know what they are doing - as its only
247
# the Format factory and creation methods that are
248
# permitted to do this.
249
self._set_inventory(_inventory, dirty=False)
250
self._detect_case_handling()
251
self._rules_searcher = None
253
def _detect_case_handling(self):
254
wt_trans = self.bzrdir.get_workingtree_transport(None)
256
wt_trans.stat("FoRMaT")
257
except errors.NoSuchFile:
258
self.case_sensitive = True
260
self.case_sensitive = False
262
self._setup_directory_is_tree_reference()
265
fget=lambda self: self._branch,
266
doc="""The branch this WorkingTree is connected to.
268
This cannot be set - it is reflective of the actual disk structure
269
the working tree has been constructed from.
272
def break_lock(self):
273
"""Break a lock if one is present from another instance.
275
Uses the ui factory to ask for confirmation if the lock may be from
278
This will probe the repository for its lock as well.
280
self._control_files.break_lock()
281
self.branch.break_lock()
283
def requires_rich_root(self):
284
return self._format.requires_rich_root
286
def supports_tree_reference(self):
289
def _set_inventory(self, inv, dirty):
290
"""Set the internal cached inventory.
292
:param inv: The inventory to set.
293
:param dirty: A boolean indicating whether the inventory is the same
294
logical inventory as whats on disk. If True the inventory is not
295
the same and should be written to disk or data will be lost, if
296
False then the inventory is the same as that on disk and any
297
serialisation would be unneeded overhead.
299
self._inventory = inv
300
self._inventory_is_modified = dirty
303
def open(path=None, _unsupported=False):
304
"""Open an existing working tree at path.
308
path = osutils.getcwd()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
313
def open_containing(path=None):
314
"""Open an existing working tree which has its root about path.
316
This probes for a working tree at path and searches upwards from there.
318
Basically we keep looking up until we find the control directory or
319
run into /. If there isn't one, raises NotBranchError.
320
TODO: give this a new exception.
321
If there is one, it is returned, along with the unused portion of path.
323
:return: The WorkingTree that contains 'path', and the rest of path
326
path = osutils.getcwd()
327
control, relpath = bzrdir.BzrDir.open_containing(path)
329
return control.open_workingtree(), relpath
332
def open_downlevel(path=None):
333
"""Open an unsupported working tree.
335
Only intended for advanced situations like upgrading part of a bzrdir.
337
return WorkingTree.open(path, _unsupported=True)
340
def find_trees(location):
341
def list_current(transport):
342
return [d for d in transport.list_dir('') if d != '.bzr']
343
def evaluate(bzrdir):
345
tree = bzrdir.open_workingtree()
346
except errors.NoWorkingTree:
350
transport = get_transport(location)
351
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
352
list_current=list_current)
353
return [t for t in iterator if t is not None]
355
# should be deprecated - this is slow and in any case treating them as a
356
# container is (we now know) bad style -- mbp 20070302
357
## @deprecated_method(zero_fifteen)
359
"""Iterate through file_ids for this tree.
361
file_ids are in a WorkingTree if they are in the working inventory
362
and the working file exists.
364
inv = self._inventory
365
for path, ie in inv.iter_entries():
366
if osutils.lexists(self.abspath(path)):
369
def all_file_ids(self):
370
"""See Tree.iter_all_file_ids"""
371
return set(self.inventory)
374
return "<%s of %s>" % (self.__class__.__name__,
375
getattr(self, 'basedir', None))
377
def abspath(self, filename):
378
return pathjoin(self.basedir, filename)
380
def basis_tree(self):
381
"""Return RevisionTree for the current last revision.
383
If the left most parent is a ghost then the returned tree will be an
384
empty tree - one obtained by calling
385
repository.revision_tree(NULL_REVISION).
388
revision_id = self.get_parent_ids()[0]
390
# no parents, return an empty revision tree.
391
# in the future this should return the tree for
392
# 'empty:' - the implicit root empty tree.
393
return self.branch.repository.revision_tree(
394
_mod_revision.NULL_REVISION)
396
return self.revision_tree(revision_id)
397
except errors.NoSuchRevision:
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except (errors.RevisionNotPresent, errors.NoSuchRevision):
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(
412
_mod_revision.NULL_REVISION)
415
self._flush_ignore_list_cache()
417
def relpath(self, path):
418
"""Return the local path portion from a given path.
420
The path may be absolute or relative. If its a relative path it is
421
interpreted relative to the python current working directory.
423
return osutils.relpath(self.basedir, path)
425
def has_filename(self, filename):
426
return osutils.lexists(self.abspath(filename))
428
def get_file(self, file_id, path=None, filtered=True):
430
path = self.id2path(file_id)
431
return self.get_file_byname(path, filtered=filtered)
433
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
434
"""See MutableTree.get_file_with_stat."""
436
path = self.id2path(file_id)
437
file_obj = self.get_file_byname(path, filtered=False)
438
return (file_obj, _fstat(file_obj.fileno()))
440
def get_file_text(self, file_id, path=None, filtered=True):
441
return self.get_file(file_id, path=path, filtered=filtered).read()
443
def get_file_byname(self, filename, filtered=True):
444
path = self.abspath(filename)
447
filters = self._content_filter_stack(filename)
448
return filtered_input_file(f, filters)
452
def get_special_file(self, type):
453
"""Get a file special to Bazaar.
455
:type: a type of XXX maps to a file path .bzrXXX
456
:return: a file-like object or None if the file does not exist
458
path = self.abspath(".bzr" + type)
460
return open(path, 'rb')
464
def get_file_lines(self, file_id, path=None):
465
"""See Tree.get_file_lines()"""
466
file = self.get_file(file_id, path)
468
return file.readlines()
473
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
474
"""See Tree.annotate_iter
476
This implementation will use the basis tree implementation if possible.
477
Lines not in the basis are attributed to CURRENT_REVISION
479
If there are pending merges, lines added by those merges will be
480
incorrectly attributed to CURRENT_REVISION (but after committing, the
481
attribution will be correct).
483
basis = self.basis_tree()
486
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
487
require_versioned=True).next()
488
changed_content, kind = changes[2], changes[6]
489
if not changed_content:
490
return basis.annotate_iter(file_id)
494
if kind[0] != 'file':
497
old_lines = list(basis.annotate_iter(file_id))
499
for tree in self.branch.repository.revision_trees(
500
self.get_parent_ids()[1:]):
501
if file_id not in tree:
503
old.append(list(tree.annotate_iter(file_id)))
504
return annotate.reannotate(old, self.get_file(file_id).readlines(),
509
def _get_ancestors(self, default_revision):
510
ancestors = set([default_revision])
511
for parent_id in self.get_parent_ids():
512
ancestors.update(self.branch.repository.get_ancestry(
513
parent_id, topo_sorted=False))
516
def get_parent_ids(self):
517
"""See Tree.get_parent_ids.
519
This implementation reads the pending merges list and last_revision
520
value and uses that to decide what the parents list should be.
522
last_rev = _mod_revision.ensure_null(self._last_revision())
523
if _mod_revision.NULL_REVISION == last_rev:
528
merges_file = self._transport.get('pending-merges')
529
except errors.NoSuchFile:
532
for l in merges_file.readlines():
533
revision_id = l.rstrip('\n')
534
parents.append(revision_id)
538
def get_root_id(self):
539
"""Return the id of this trees root"""
540
return self._inventory.root.file_id
542
def _get_store_filename(self, file_id):
543
## XXX: badly named; this is not in the store at all
544
return self.abspath(self.id2path(file_id))
547
def clone(self, to_bzrdir, revision_id=None):
548
"""Duplicate this working tree into to_bzr, including all state.
550
Specifically modified files are kept as modified, but
551
ignored and unknown files are discarded.
553
If you want to make a new line of development, see bzrdir.sprout()
556
If not None, the cloned tree will have its last revision set to
557
revision, and and difference between the source trees last revision
558
and this one merged in.
560
# assumes the target bzr dir format is compatible.
561
result = to_bzrdir.create_workingtree()
562
self.copy_content_into(result, revision_id)
566
def copy_content_into(self, tree, revision_id=None):
567
"""Copy the current content and user files of this tree into tree."""
568
tree.set_root_id(self.get_root_id())
569
if revision_id is None:
570
merge.transform_tree(tree, self)
572
# TODO now merge from tree.last_revision to revision (to preserve
573
# user local changes)
574
merge.transform_tree(tree, self)
575
tree.set_parent_ids([revision_id])
577
def id2abspath(self, file_id):
578
return self.abspath(self.id2path(file_id))
580
def has_id(self, file_id):
581
# files that have been deleted are excluded
583
if not inv.has_id(file_id):
585
path = inv.id2path(file_id)
586
return osutils.lexists(self.abspath(path))
588
def has_or_had_id(self, file_id):
589
if file_id == self.inventory.root.file_id:
591
return self.inventory.has_id(file_id)
593
__contains__ = has_id
595
def get_file_size(self, file_id):
596
"""See Tree.get_file_size"""
598
return os.path.getsize(self.id2abspath(file_id))
600
if e.errno != errno.ENOENT:
606
def get_file_sha1(self, file_id, path=None, stat_value=None):
608
path = self._inventory.id2path(file_id)
609
return self._hashcache.get_sha1(path, stat_value)
611
def get_file_mtime(self, file_id, path=None):
613
path = self.inventory.id2path(file_id)
614
return os.lstat(self.abspath(path)).st_mtime
616
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
617
file_id = self.path2id(path)
618
return self._inventory[file_id].executable
620
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
621
mode = stat_result.st_mode
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
if not supports_executable():
625
def is_executable(self, file_id, path=None):
626
return self._inventory[file_id].executable
628
_is_executable_from_path_and_stat = \
629
_is_executable_from_path_and_stat_from_basis
631
def is_executable(self, file_id, path=None):
633
path = self.id2path(file_id)
634
mode = os.lstat(self.abspath(path)).st_mode
635
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
637
_is_executable_from_path_and_stat = \
638
_is_executable_from_path_and_stat_from_stat
640
@needs_tree_write_lock
641
def _add(self, files, ids, kinds):
642
"""See MutableTree._add."""
643
# TODO: Re-adding a file that is removed in the working copy
644
# should probably put it back with the previous ID.
645
# the read and write working inventory should not occur in this
646
# function - they should be part of lock_write and unlock.
648
for f, file_id, kind in zip(files, ids, kinds):
650
inv.add_path(f, kind=kind)
652
inv.add_path(f, kind=kind, file_id=file_id)
653
self._inventory_is_modified = True
655
@needs_tree_write_lock
656
def _gather_kinds(self, files, kinds):
657
"""See MutableTree._gather_kinds."""
658
for pos, f in enumerate(files):
659
if kinds[pos] is None:
660
fullpath = normpath(self.abspath(f))
662
kinds[pos] = file_kind(fullpath)
664
if e.errno == errno.ENOENT:
665
raise errors.NoSuchFile(fullpath)
668
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
669
"""Add revision_id as a parent.
671
This is equivalent to retrieving the current list of parent ids
672
and setting the list to its value plus revision_id.
674
:param revision_id: The revision id to add to the parent list. It may
675
be a ghost revision as long as its not the first parent to be added,
676
or the allow_leftmost_as_ghost parameter is set True.
677
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
679
parents = self.get_parent_ids() + [revision_id]
680
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
681
or allow_leftmost_as_ghost)
683
@needs_tree_write_lock
684
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
685
"""Add revision_id, tree tuple as a parent.
687
This is equivalent to retrieving the current list of parent trees
688
and setting the list to its value plus parent_tuple. See also
689
add_parent_tree_id - if you only have a parent id available it will be
690
simpler to use that api. If you have the parent already available, using
691
this api is preferred.
693
:param parent_tuple: The (revision id, tree) to add to the parent list.
694
If the revision_id is a ghost, pass None for the tree.
695
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
697
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
698
if len(parent_ids) > 1:
699
# the leftmost may have already been a ghost, preserve that if it
701
allow_leftmost_as_ghost = True
702
self.set_parent_ids(parent_ids,
703
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
705
@needs_tree_write_lock
706
def add_pending_merge(self, *revision_ids):
707
# TODO: Perhaps should check at this point that the
708
# history of the revision is actually present?
709
parents = self.get_parent_ids()
711
for rev_id in revision_ids:
712
if rev_id in parents:
714
parents.append(rev_id)
717
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
719
def path_content_summary(self, path, _lstat=os.lstat,
720
_mapper=osutils.file_kind_from_stat_mode):
721
"""See Tree.path_content_summary."""
722
abspath = self.abspath(path)
724
stat_result = _lstat(abspath)
726
if getattr(e, 'errno', None) == errno.ENOENT:
728
return ('missing', None, None, None)
729
# propagate other errors
731
kind = _mapper(stat_result.st_mode)
733
size = stat_result.st_size
734
# try for a stat cache lookup
735
executable = self._is_executable_from_path_and_stat(path, stat_result)
736
return (kind, size, executable, self._sha_from_stat(
738
elif kind == 'directory':
739
# perhaps it looks like a plain directory, but it's really a
741
if self._directory_is_tree_reference(path):
742
kind = 'tree-reference'
743
return kind, None, None, None
744
elif kind == 'symlink':
745
return ('symlink', None, None, os.readlink(abspath))
747
return (kind, None, None, None)
749
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
750
"""Common ghost checking functionality from set_parent_*.
752
This checks that the left hand-parent exists if there are any
755
if len(revision_ids) > 0:
756
leftmost_id = revision_ids[0]
757
if (not allow_leftmost_as_ghost and not
758
self.branch.repository.has_revision(leftmost_id)):
759
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
def _set_merges_from_parent_ids(self, parent_ids):
762
merges = parent_ids[1:]
763
self._transport.put_bytes('pending-merges', '\n'.join(merges),
764
mode=self._control_files._file_mode)
766
def _filter_parent_ids_by_ancestry(self, revision_ids):
767
"""Check that all merged revisions are proper 'heads'.
769
This will always return the first revision_id, and any merged revisions
772
if len(revision_ids) == 0:
774
graph = self.branch.repository.get_graph()
775
heads = graph.heads(revision_ids)
776
new_revision_ids = revision_ids[:1]
777
for revision_id in revision_ids[1:]:
778
if revision_id in heads and revision_id not in new_revision_ids:
779
new_revision_ids.append(revision_id)
780
if new_revision_ids != revision_ids:
781
trace.mutter('requested to set revision_ids = %s,'
782
' but filtered to %s', revision_ids, new_revision_ids)
783
return new_revision_ids
785
@needs_tree_write_lock
786
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
787
"""Set the parent ids to revision_ids.
789
See also set_parent_trees. This api will try to retrieve the tree data
790
for each element of revision_ids from the trees repository. If you have
791
tree data already available, it is more efficient to use
792
set_parent_trees rather than set_parent_ids. set_parent_ids is however
793
an easier API to use.
795
:param revision_ids: The revision_ids to set as the parent ids of this
796
working tree. Any of these may be ghosts.
798
self._check_parents_for_ghosts(revision_ids,
799
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
800
for revision_id in revision_ids:
801
_mod_revision.check_not_reserved_id(revision_id)
803
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
805
if len(revision_ids) > 0:
806
self.set_last_revision(revision_ids[0])
808
self.set_last_revision(_mod_revision.NULL_REVISION)
810
self._set_merges_from_parent_ids(revision_ids)
812
@needs_tree_write_lock
813
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
814
"""See MutableTree.set_parent_trees."""
815
parent_ids = [rev for (rev, tree) in parents_list]
816
for revision_id in parent_ids:
817
_mod_revision.check_not_reserved_id(revision_id)
819
self._check_parents_for_ghosts(parent_ids,
820
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
822
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
824
if len(parent_ids) == 0:
825
leftmost_parent_id = _mod_revision.NULL_REVISION
826
leftmost_parent_tree = None
828
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
830
if self._change_last_revision(leftmost_parent_id):
831
if leftmost_parent_tree is None:
832
# If we don't have a tree, fall back to reading the
833
# parent tree from the repository.
834
self._cache_basis_inventory(leftmost_parent_id)
836
inv = leftmost_parent_tree.inventory
837
xml = self._create_basis_xml_from_inventory(
838
leftmost_parent_id, inv)
839
self._write_basis_inventory(xml)
840
self._set_merges_from_parent_ids(parent_ids)
842
@needs_tree_write_lock
843
def set_pending_merges(self, rev_list):
844
parents = self.get_parent_ids()
845
leftmost = parents[:1]
846
new_parents = leftmost + rev_list
847
self.set_parent_ids(new_parents)
849
@needs_tree_write_lock
850
def set_merge_modified(self, modified_hashes):
852
for file_id, hash in modified_hashes.iteritems():
853
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
854
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
856
def _sha_from_stat(self, path, stat_result):
857
"""Get a sha digest from the tree's stat cache.
859
The default implementation assumes no stat cache is present.
861
:param path: The path.
862
:param stat_result: The stat result being looked up.
866
def _put_rio(self, filename, stanzas, header):
867
self._must_be_locked()
868
my_file = rio_file(stanzas, header)
869
self._transport.put_file(filename, my_file,
870
mode=self._control_files._file_mode)
872
@needs_write_lock # because merge pulls data into the branch.
873
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
875
"""Merge from a branch into this working tree.
877
:param branch: The branch to merge from.
878
:param to_revision: If non-None, the merge will merge to to_revision,
879
but not beyond it. to_revision does not need to be in the history
880
of the branch when it is supplied. If None, to_revision defaults to
881
branch.last_revision().
883
from bzrlib.merge import Merger, Merge3Merger
884
pb = bzrlib.ui.ui_factory.nested_progress_bar()
886
merger = Merger(self.branch, this_tree=self, pb=pb)
887
merger.pp = ProgressPhase("Merge phase", 5, pb)
888
merger.pp.next_phase()
889
# check that there are no
891
merger.check_basis(check_clean=True, require_commits=False)
892
if to_revision is None:
893
to_revision = _mod_revision.ensure_null(branch.last_revision())
894
merger.other_rev_id = to_revision
895
if _mod_revision.is_null(merger.other_rev_id):
896
raise errors.NoCommits(branch)
897
self.branch.fetch(branch, last_revision=merger.other_rev_id)
898
merger.other_basis = merger.other_rev_id
899
merger.other_tree = self.branch.repository.revision_tree(
901
merger.other_branch = branch
902
merger.pp.next_phase()
903
if from_revision is None:
906
merger.set_base_revision(from_revision, branch)
907
if merger.base_rev_id == merger.other_rev_id:
908
raise errors.PointlessMerge
909
merger.backup_files = False
910
if merge_type is None:
911
merger.merge_type = Merge3Merger
913
merger.merge_type = merge_type
914
merger.set_interesting_files(None)
915
merger.show_base = False
916
merger.reprocess = False
917
conflicts = merger.do_merge()
924
def merge_modified(self):
925
"""Return a dictionary of files modified by a merge.
927
The list is initialized by WorkingTree.set_merge_modified, which is
928
typically called after we make some automatic updates to the tree
931
This returns a map of file_id->sha1, containing only files which are
932
still in the working inventory and have that text hash.
935
hashfile = self._transport.get('merge-hashes')
936
except errors.NoSuchFile:
941
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
942
raise errors.MergeModifiedFormatError()
943
except StopIteration:
944
raise errors.MergeModifiedFormatError()
945
for s in RioReader(hashfile):
946
# RioReader reads in Unicode, so convert file_ids back to utf8
947
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
948
if file_id not in self.inventory:
950
text_hash = s.get("hash")
951
if text_hash == self.get_file_sha1(file_id):
952
merge_hashes[file_id] = text_hash
958
def mkdir(self, path, file_id=None):
959
"""See MutableTree.mkdir()."""
961
file_id = generate_ids.gen_file_id(os.path.basename(path))
962
os.mkdir(self.abspath(path))
963
self.add(path, file_id, 'directory')
966
def get_symlink_target(self, file_id):
967
return os.readlink(self.id2abspath(file_id))
970
def subsume(self, other_tree):
971
def add_children(inventory, entry):
972
for child_entry in entry.children.values():
973
inventory._byid[child_entry.file_id] = child_entry
974
if child_entry.kind == 'directory':
975
add_children(inventory, child_entry)
976
if other_tree.get_root_id() == self.get_root_id():
977
raise errors.BadSubsumeSource(self, other_tree,
978
'Trees have the same root')
980
other_tree_path = self.relpath(other_tree.basedir)
981
except errors.PathNotChild:
982
raise errors.BadSubsumeSource(self, other_tree,
983
'Tree is not contained by the other')
984
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
985
if new_root_parent is None:
986
raise errors.BadSubsumeSource(self, other_tree,
987
'Parent directory is not versioned.')
988
# We need to ensure that the result of a fetch will have a
989
# versionedfile for the other_tree root, and only fetching into
990
# RepositoryKnit2 guarantees that.
991
if not self.branch.repository.supports_rich_root():
992
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
993
other_tree.lock_tree_write()
995
new_parents = other_tree.get_parent_ids()
996
other_root = other_tree.inventory.root
997
other_root.parent_id = new_root_parent
998
other_root.name = osutils.basename(other_tree_path)
999
self.inventory.add(other_root)
1000
add_children(self.inventory, other_root)
1001
self._write_inventory(self.inventory)
1002
# normally we don't want to fetch whole repositories, but i think
1003
# here we really do want to consolidate the whole thing.
1004
for parent_id in other_tree.get_parent_ids():
1005
self.branch.fetch(other_tree.branch, parent_id)
1006
self.add_parent_tree_id(parent_id)
1009
other_tree.bzrdir.retire_bzrdir()
1011
def _setup_directory_is_tree_reference(self):
1012
if self._branch.repository._format.supports_tree_reference:
1013
self._directory_is_tree_reference = \
1014
self._directory_may_be_tree_reference
1016
self._directory_is_tree_reference = \
1017
self._directory_is_never_tree_reference
1019
def _directory_is_never_tree_reference(self, relpath):
1022
def _directory_may_be_tree_reference(self, relpath):
1023
# as a special case, if a directory contains control files then
1024
# it's a tree reference, except that the root of the tree is not
1025
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1026
# TODO: We could ask all the control formats whether they
1027
# recognize this directory, but at the moment there's no cheap api
1028
# to do that. Since we probably can only nest bzr checkouts and
1029
# they always use this name it's ok for now. -- mbp 20060306
1031
# FIXME: There is an unhandled case here of a subdirectory
1032
# containing .bzr but not a branch; that will probably blow up
1033
# when you try to commit it. It might happen if there is a
1034
# checkout in a subdirectory. This can be avoided by not adding
1037
@needs_tree_write_lock
1038
def extract(self, file_id, format=None):
1039
"""Extract a subtree from this tree.
1041
A new branch will be created, relative to the path for this tree.
1045
segments = osutils.splitpath(path)
1046
transport = self.branch.bzrdir.root_transport
1047
for name in segments:
1048
transport = transport.clone(name)
1049
transport.ensure_base()
1052
sub_path = self.id2path(file_id)
1053
branch_transport = mkdirs(sub_path)
1055
format = self.bzrdir.cloning_metadir()
1056
branch_transport.ensure_base()
1057
branch_bzrdir = format.initialize_on_transport(branch_transport)
1059
repo = branch_bzrdir.find_repository()
1060
except errors.NoRepositoryPresent:
1061
repo = branch_bzrdir.create_repository()
1062
if not repo.supports_rich_root():
1063
raise errors.RootNotRich()
1064
new_branch = branch_bzrdir.create_branch()
1065
new_branch.pull(self.branch)
1066
for parent_id in self.get_parent_ids():
1067
new_branch.fetch(self.branch, parent_id)
1068
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1069
if tree_transport.base != branch_transport.base:
1070
tree_bzrdir = format.initialize_on_transport(tree_transport)
1071
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1073
tree_bzrdir = branch_bzrdir
1074
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1075
wt.set_parent_ids(self.get_parent_ids())
1076
my_inv = self.inventory
1077
child_inv = Inventory(root_id=None)
1078
new_root = my_inv[file_id]
1079
my_inv.remove_recursive_id(file_id)
1080
new_root.parent_id = None
1081
child_inv.add(new_root)
1082
self._write_inventory(my_inv)
1083
wt._write_inventory(child_inv)
1086
def _serialize(self, inventory, out_file):
1087
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1090
def _deserialize(selt, in_file):
1091
return xml5.serializer_v5.read_inventory(in_file)
1094
"""Write the in memory inventory to disk."""
1095
# TODO: Maybe this should only write on dirty ?
1096
if self._control_files._lock_mode != 'w':
1097
raise errors.NotWriteLocked(self)
1099
self._serialize(self._inventory, sio)
1101
self._transport.put_file('inventory', sio,
1102
mode=self._control_files._file_mode)
1103
self._inventory_is_modified = False
1105
def _kind(self, relpath):
1106
return osutils.file_kind(self.abspath(relpath))
1108
def list_files(self, include_root=False):
1109
"""Recursively list all files as (path, class, kind, id, entry).
1111
Lists, but does not descend into unversioned directories.
1113
This does not include files that have been deleted in this
1116
Skips the control directory.
1118
# list_files is an iterator, so @needs_read_lock doesn't work properly
1119
# with it. So callers should be careful to always read_lock the tree.
1120
if not self.is_locked():
1121
raise errors.ObjectNotLocked(self)
1123
inv = self.inventory
1124
if include_root is True:
1125
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1126
# Convert these into local objects to save lookup times
1127
pathjoin = osutils.pathjoin
1128
file_kind = self._kind
1130
# transport.base ends in a slash, we want the piece
1131
# between the last two slashes
1132
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1134
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1136
# directory file_id, relative path, absolute path, reverse sorted children
1137
children = os.listdir(self.basedir)
1139
# jam 20060527 The kernel sized tree seems equivalent whether we
1140
# use a deque and popleft to keep them sorted, or if we use a plain
1141
# list and just reverse() them.
1142
children = collections.deque(children)
1143
stack = [(inv.root.file_id, u'', self.basedir, children)]
1145
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1148
f = children.popleft()
1149
## TODO: If we find a subdirectory with its own .bzr
1150
## directory, then that is a separate tree and we
1151
## should exclude it.
1153
# the bzrdir for this tree
1154
if transport_base_dir == f:
1157
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1158
# and 'f' doesn't begin with one, we can do a string op, rather
1159
# than the checks of pathjoin(), all relative paths will have an extra slash
1161
fp = from_dir_relpath + '/' + f
1164
fap = from_dir_abspath + '/' + f
1166
f_ie = inv.get_child(from_dir_id, f)
1169
elif self.is_ignored(fp[1:]):
1172
# we may not have found this file, because of a unicode issue
1173
f_norm, can_access = osutils.normalized_filename(f)
1174
if f == f_norm or not can_access:
1175
# No change, so treat this file normally
1178
# this file can be accessed by a normalized path
1179
# check again if it is versioned
1180
# these lines are repeated here for performance
1182
fp = from_dir_relpath + '/' + f
1183
fap = from_dir_abspath + '/' + f
1184
f_ie = inv.get_child(from_dir_id, f)
1187
elif self.is_ignored(fp[1:]):
1194
# make a last minute entry
1196
yield fp[1:], c, fk, f_ie.file_id, f_ie
1199
yield fp[1:], c, fk, None, fk_entries[fk]()
1201
yield fp[1:], c, fk, None, TreeEntry()
1204
if fk != 'directory':
1207
# But do this child first
1208
new_children = os.listdir(fap)
1210
new_children = collections.deque(new_children)
1211
stack.append((f_ie.file_id, fp, fap, new_children))
1212
# Break out of inner loop,
1213
# so that we start outer loop with child
1216
# if we finished all children, pop it off the stack
1219
@needs_tree_write_lock
1220
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1223
to_dir must exist in the inventory.
1225
If to_dir exists and is a directory, the files are moved into
1226
it, keeping their old names.
1228
Note that to_dir is only the last component of the new name;
1229
this doesn't change the directory.
1231
For each entry in from_paths the move mode will be determined
1234
The first mode moves the file in the filesystem and updates the
1235
inventory. The second mode only updates the inventory without
1236
touching the file on the filesystem. This is the new mode introduced
1239
move uses the second mode if 'after == True' and the target is not
1240
versioned but present in the working tree.
1242
move uses the second mode if 'after == False' and the source is
1243
versioned but no longer in the working tree, and the target is not
1244
versioned but present in the working tree.
1246
move uses the first mode if 'after == False' and the source is
1247
versioned and present in the working tree, and the target is not
1248
versioned and not present in the working tree.
1250
Everything else results in an error.
1252
This returns a list of (from_path, to_path) pairs for each
1253
entry that is moved.
1258
# check for deprecated use of signature
1260
to_dir = kwargs.get('to_name', None)
1262
raise TypeError('You must supply a target directory')
1264
symbol_versioning.warn('The parameter to_name was deprecated'
1265
' in version 0.13. Use to_dir instead',
1268
# check destination directory
1269
if isinstance(from_paths, basestring):
1271
inv = self.inventory
1272
to_abs = self.abspath(to_dir)
1273
if not isdir(to_abs):
1274
raise errors.BzrMoveFailedError('',to_dir,
1275
errors.NotADirectory(to_abs))
1276
if not self.has_filename(to_dir):
1277
raise errors.BzrMoveFailedError('',to_dir,
1278
errors.NotInWorkingDirectory(to_dir))
1279
to_dir_id = inv.path2id(to_dir)
1280
if to_dir_id is None:
1281
raise errors.BzrMoveFailedError('',to_dir,
1282
errors.NotVersionedError(path=str(to_dir)))
1284
to_dir_ie = inv[to_dir_id]
1285
if to_dir_ie.kind != 'directory':
1286
raise errors.BzrMoveFailedError('',to_dir,
1287
errors.NotADirectory(to_abs))
1289
# create rename entries and tuples
1290
for from_rel in from_paths:
1291
from_tail = splitpath(from_rel)[-1]
1292
from_id = inv.path2id(from_rel)
1294
raise errors.BzrMoveFailedError(from_rel,to_dir,
1295
errors.NotVersionedError(path=str(from_rel)))
1297
from_entry = inv[from_id]
1298
from_parent_id = from_entry.parent_id
1299
to_rel = pathjoin(to_dir, from_tail)
1300
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1302
from_tail=from_tail,
1303
from_parent_id=from_parent_id,
1304
to_rel=to_rel, to_tail=from_tail,
1305
to_parent_id=to_dir_id)
1306
rename_entries.append(rename_entry)
1307
rename_tuples.append((from_rel, to_rel))
1309
# determine which move mode to use. checks also for movability
1310
rename_entries = self._determine_mv_mode(rename_entries, after)
1312
original_modified = self._inventory_is_modified
1315
self._inventory_is_modified = True
1316
self._move(rename_entries)
1318
# restore the inventory on error
1319
self._inventory_is_modified = original_modified
1321
self._write_inventory(inv)
1322
return rename_tuples
1324
def _determine_mv_mode(self, rename_entries, after=False):
1325
"""Determines for each from-to pair if both inventory and working tree
1326
or only the inventory has to be changed.
1328
Also does basic plausability tests.
1330
inv = self.inventory
1332
for rename_entry in rename_entries:
1333
# store to local variables for easier reference
1334
from_rel = rename_entry.from_rel
1335
from_id = rename_entry.from_id
1336
to_rel = rename_entry.to_rel
1337
to_id = inv.path2id(to_rel)
1338
only_change_inv = False
1340
# check the inventory for source and destination
1342
raise errors.BzrMoveFailedError(from_rel,to_rel,
1343
errors.NotVersionedError(path=str(from_rel)))
1344
if to_id is not None:
1345
raise errors.BzrMoveFailedError(from_rel,to_rel,
1346
errors.AlreadyVersionedError(path=str(to_rel)))
1348
# try to determine the mode for rename (only change inv or change
1349
# inv and file system)
1351
if not self.has_filename(to_rel):
1352
raise errors.BzrMoveFailedError(from_id,to_rel,
1353
errors.NoSuchFile(path=str(to_rel),
1354
extra="New file has not been created yet"))
1355
only_change_inv = True
1356
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1357
only_change_inv = True
1358
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1359
only_change_inv = False
1360
elif (not self.case_sensitive
1361
and from_rel.lower() == to_rel.lower()
1362
and self.has_filename(from_rel)):
1363
only_change_inv = False
1365
# something is wrong, so lets determine what exactly
1366
if not self.has_filename(from_rel) and \
1367
not self.has_filename(to_rel):
1368
raise errors.BzrRenameFailedError(from_rel,to_rel,
1369
errors.PathsDoNotExist(paths=(str(from_rel),
1372
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1373
rename_entry.only_change_inv = only_change_inv
1374
return rename_entries
1376
def _move(self, rename_entries):
1377
"""Moves a list of files.
1379
Depending on the value of the flag 'only_change_inv', the
1380
file will be moved on the file system or not.
1382
inv = self.inventory
1385
for entry in rename_entries:
1387
self._move_entry(entry)
1389
self._rollback_move(moved)
1393
def _rollback_move(self, moved):
1394
"""Try to rollback a previous move in case of an filesystem error."""
1395
inv = self.inventory
1398
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1399
entry.to_tail, entry.to_parent_id, entry.from_rel,
1400
entry.from_tail, entry.from_parent_id,
1401
entry.only_change_inv))
1402
except errors.BzrMoveFailedError, e:
1403
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1404
" The working tree is in an inconsistent state."
1405
" Please consider doing a 'bzr revert'."
1406
" Error message is: %s" % e)
1408
def _move_entry(self, entry):
1409
inv = self.inventory
1410
from_rel_abs = self.abspath(entry.from_rel)
1411
to_rel_abs = self.abspath(entry.to_rel)
1412
if from_rel_abs == to_rel_abs:
1413
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1414
"Source and target are identical.")
1416
if not entry.only_change_inv:
1418
osutils.rename(from_rel_abs, to_rel_abs)
1420
raise errors.BzrMoveFailedError(entry.from_rel,
1422
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1424
@needs_tree_write_lock
1425
def rename_one(self, from_rel, to_rel, after=False):
1428
This can change the directory or the filename or both.
1430
rename_one has several 'modes' to work. First, it can rename a physical
1431
file and change the file_id. That is the normal mode. Second, it can
1432
only change the file_id without touching any physical file. This is
1433
the new mode introduced in version 0.15.
1435
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1436
versioned but present in the working tree.
1438
rename_one uses the second mode if 'after == False' and 'from_rel' is
1439
versioned but no longer in the working tree, and 'to_rel' is not
1440
versioned but present in the working tree.
1442
rename_one uses the first mode if 'after == False' and 'from_rel' is
1443
versioned and present in the working tree, and 'to_rel' is not
1444
versioned and not present in the working tree.
1446
Everything else results in an error.
1448
inv = self.inventory
1451
# create rename entries and tuples
1452
from_tail = splitpath(from_rel)[-1]
1453
from_id = inv.path2id(from_rel)
1455
raise errors.BzrRenameFailedError(from_rel,to_rel,
1456
errors.NotVersionedError(path=str(from_rel)))
1457
from_entry = inv[from_id]
1458
from_parent_id = from_entry.parent_id
1459
to_dir, to_tail = os.path.split(to_rel)
1460
to_dir_id = inv.path2id(to_dir)
1461
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1463
from_tail=from_tail,
1464
from_parent_id=from_parent_id,
1465
to_rel=to_rel, to_tail=to_tail,
1466
to_parent_id=to_dir_id)
1467
rename_entries.append(rename_entry)
1469
# determine which move mode to use. checks also for movability
1470
rename_entries = self._determine_mv_mode(rename_entries, after)
1472
# check if the target changed directory and if the target directory is
1474
if to_dir_id is None:
1475
raise errors.BzrMoveFailedError(from_rel,to_rel,
1476
errors.NotVersionedError(path=str(to_dir)))
1478
# all checks done. now we can continue with our actual work
1479
mutter('rename_one:\n'
1484
' to_dir_id {%s}\n',
1485
from_id, from_rel, to_rel, to_dir, to_dir_id)
1487
self._move(rename_entries)
1488
self._write_inventory(inv)
1490
class _RenameEntry(object):
1491
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1492
to_rel, to_tail, to_parent_id, only_change_inv=False):
1493
self.from_rel = from_rel
1494
self.from_id = from_id
1495
self.from_tail = from_tail
1496
self.from_parent_id = from_parent_id
1497
self.to_rel = to_rel
1498
self.to_tail = to_tail
1499
self.to_parent_id = to_parent_id
1500
self.only_change_inv = only_change_inv
1504
"""Return all unknown files.
1506
These are files in the working directory that are not versioned or
1507
control files or ignored.
1509
# force the extras method to be fully executed before returning, to
1510
# prevent race conditions with the lock
1512
[subp for subp in self.extras() if not self.is_ignored(subp)])
1514
@needs_tree_write_lock
1515
def unversion(self, file_ids):
1516
"""Remove the file ids in file_ids from the current versioned set.
1518
When a file_id is unversioned, all of its children are automatically
1521
:param file_ids: The file ids to stop versioning.
1522
:raises: NoSuchId if any fileid is not currently versioned.
1524
for file_id in file_ids:
1525
if self._inventory.has_id(file_id):
1526
self._inventory.remove_recursive_id(file_id)
1528
raise errors.NoSuchId(self, file_id)
1530
# in the future this should just set a dirty bit to wait for the
1531
# final unlock. However, until all methods of workingtree start
1532
# with the current in -memory inventory rather than triggering
1533
# a read, it is more complex - we need to teach read_inventory
1534
# to know when to read, and when to not read first... and possibly
1535
# to save first when the in memory one may be corrupted.
1536
# so for now, we just only write it if it is indeed dirty.
1538
self._write_inventory(self._inventory)
1540
def _iter_conflicts(self):
1542
for info in self.list_files():
1544
stem = get_conflicted_stem(path)
1547
if stem not in conflicted:
1548
conflicted.add(stem)
1552
def pull(self, source, overwrite=False, stop_revision=None,
1553
change_reporter=None, possible_transports=None):
1554
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1557
pp = ProgressPhase("Pull phase", 2, top_pb)
1559
old_revision_info = self.branch.last_revision_info()
1560
basis_tree = self.basis_tree()
1561
count = self.branch.pull(source, overwrite, stop_revision,
1562
possible_transports=possible_transports)
1563
new_revision_info = self.branch.last_revision_info()
1564
if new_revision_info != old_revision_info:
1566
repository = self.branch.repository
1567
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1568
basis_tree.lock_read()
1570
new_basis_tree = self.branch.basis_tree()
1577
change_reporter=change_reporter)
1578
if (basis_tree.inventory.root is None and
1579
new_basis_tree.inventory.root is not None):
1580
self.set_root_id(new_basis_tree.get_root_id())
1584
# TODO - dedup parents list with things merged by pull ?
1585
# reuse the revisiontree we merged against to set the new
1587
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1588
# we have to pull the merge trees out again, because
1589
# merge_inner has set the ids. - this corner is not yet
1590
# layered well enough to prevent double handling.
1591
# XXX TODO: Fix the double handling: telling the tree about
1592
# the already known parent data is wasteful.
1593
merges = self.get_parent_ids()[1:]
1594
parent_trees.extend([
1595
(parent, repository.revision_tree(parent)) for
1597
self.set_parent_trees(parent_trees)
1604
def put_file_bytes_non_atomic(self, file_id, bytes):
1605
"""See MutableTree.put_file_bytes_non_atomic."""
1606
stream = file(self.id2abspath(file_id), 'wb')
1611
# TODO: update the hashcache here ?
1614
"""Yield all unversioned files in this WorkingTree.
1616
If there are any unversioned directories then only the directory is
1617
returned, not all its children. But if there are unversioned files
1618
under a versioned subdirectory, they are returned.
1620
Currently returned depth-first, sorted by name within directories.
1621
This is the same order used by 'osutils.walkdirs'.
1623
## TODO: Work from given directory downwards
1624
for path, dir_entry in self.inventory.directories():
1625
# mutter("search for unknowns in %r", path)
1626
dirabs = self.abspath(path)
1627
if not isdir(dirabs):
1628
# e.g. directory deleted
1632
for subf in os.listdir(dirabs):
1635
if subf not in dir_entry.children:
1638
can_access) = osutils.normalized_filename(subf)
1639
except UnicodeDecodeError:
1640
path_os_enc = path.encode(osutils._fs_enc)
1641
relpath = path_os_enc + '/' + subf
1642
raise errors.BadFilenameEncoding(relpath,
1644
if subf_norm != subf and can_access:
1645
if subf_norm not in dir_entry.children:
1646
fl.append(subf_norm)
1652
subp = pathjoin(path, subf)
1655
def ignored_files(self):
1656
"""Yield list of PATH, IGNORE_PATTERN"""
1657
for subp in self.extras():
1658
pat = self.is_ignored(subp)
1662
def get_ignore_list(self):
1663
"""Return list of ignore patterns.
1665
Cached in the Tree object after the first call.
1667
ignoreset = getattr(self, '_ignoreset', None)
1668
if ignoreset is not None:
1671
ignore_globs = set()
1672
ignore_globs.update(ignores.get_runtime_ignores())
1673
ignore_globs.update(ignores.get_user_ignores())
1674
if self.has_filename(bzrlib.IGNORE_FILENAME):
1675
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1677
ignore_globs.update(ignores.parse_ignore_file(f))
1680
self._ignoreset = ignore_globs
1683
def _flush_ignore_list_cache(self):
1684
"""Resets the cached ignore list to force a cache rebuild."""
1685
self._ignoreset = None
1686
self._ignoreglobster = None
1688
def is_ignored(self, filename):
1689
r"""Check whether the filename matches an ignore pattern.
1691
Patterns containing '/' or '\' need to match the whole path;
1692
others match against only the last component.
1694
If the file is ignored, returns the pattern which caused it to
1695
be ignored, otherwise None. So this can simply be used as a
1696
boolean if desired."""
1697
if getattr(self, '_ignoreglobster', None) is None:
1698
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1699
return self._ignoreglobster.match(filename)
1701
def kind(self, file_id):
1702
return file_kind(self.id2abspath(file_id))
1704
def stored_kind(self, file_id):
1705
"""See Tree.stored_kind"""
1706
return self.inventory[file_id].kind
1708
def _comparison_data(self, entry, path):
1709
abspath = self.abspath(path)
1711
stat_value = os.lstat(abspath)
1713
if getattr(e, 'errno', None) == errno.ENOENT:
1720
mode = stat_value.st_mode
1721
kind = osutils.file_kind_from_stat_mode(mode)
1722
if not supports_executable():
1723
executable = entry is not None and entry.executable
1725
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1726
return kind, executable, stat_value
1728
def _file_size(self, entry, stat_value):
1729
return stat_value.st_size
1731
def last_revision(self):
1732
"""Return the last revision of the branch for this tree.
1734
This format tree does not support a separate marker for last-revision
1735
compared to the branch.
1737
See MutableTree.last_revision
1739
return self._last_revision()
1742
def _last_revision(self):
1743
"""helper for get_parent_ids."""
1744
return _mod_revision.ensure_null(self.branch.last_revision())
1746
def is_locked(self):
1747
return self._control_files.is_locked()
1749
def _must_be_locked(self):
1750
if not self.is_locked():
1751
raise errors.ObjectNotLocked(self)
1753
def lock_read(self):
1754
"""See Branch.lock_read, and WorkingTree.unlock."""
1755
if not self.is_locked():
1757
self.branch.lock_read()
1759
return self._control_files.lock_read()
1761
self.branch.unlock()
1764
def lock_tree_write(self):
1765
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1766
if not self.is_locked():
1768
self.branch.lock_read()
1770
return self._control_files.lock_write()
1772
self.branch.unlock()
1775
def lock_write(self):
1776
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1777
if not self.is_locked():
1779
self.branch.lock_write()
1781
return self._control_files.lock_write()
1783
self.branch.unlock()
1786
def get_physical_lock_status(self):
1787
return self._control_files.get_physical_lock_status()
1789
def _basis_inventory_name(self):
1790
return 'basis-inventory-cache'
1792
def _reset_data(self):
1793
"""Reset transient data that cannot be revalidated."""
1794
self._inventory_is_modified = False
1795
result = self._deserialize(self._transport.get('inventory'))
1796
self._set_inventory(result, dirty=False)
1798
@needs_tree_write_lock
1799
def set_last_revision(self, new_revision):
1800
"""Change the last revision in the working tree."""
1801
if self._change_last_revision(new_revision):
1802
self._cache_basis_inventory(new_revision)
1804
def _change_last_revision(self, new_revision):
1805
"""Template method part of set_last_revision to perform the change.
1807
This is used to allow WorkingTree3 instances to not affect branch
1808
when their last revision is set.
1810
if _mod_revision.is_null(new_revision):
1811
self.branch.set_revision_history([])
1814
self.branch.generate_revision_history(new_revision)
1815
except errors.NoSuchRevision:
1816
# not present in the repo - dont try to set it deeper than the tip
1817
self.branch.set_revision_history([new_revision])
1820
def _write_basis_inventory(self, xml):
1821
"""Write the basis inventory XML to the basis-inventory file"""
1822
path = self._basis_inventory_name()
1824
self._transport.put_file(path, sio,
1825
mode=self._control_files._file_mode)
1827
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1828
"""Create the text that will be saved in basis-inventory"""
1829
inventory.revision_id = revision_id
1830
return xml7.serializer_v7.write_inventory_to_string(inventory)
1832
def _cache_basis_inventory(self, new_revision):
1833
"""Cache new_revision as the basis inventory."""
1834
# TODO: this should allow the ready-to-use inventory to be passed in,
1835
# as commit already has that ready-to-use [while the format is the
1838
# this double handles the inventory - unpack and repack -
1839
# but is easier to understand. We can/should put a conditional
1840
# in here based on whether the inventory is in the latest format
1841
# - perhaps we should repack all inventories on a repository
1843
# the fast path is to copy the raw xml from the repository. If the
1844
# xml contains 'revision_id="', then we assume the right
1845
# revision_id is set. We must check for this full string, because a
1846
# root node id can legitimately look like 'revision_id' but cannot
1848
xml = self.branch.repository.get_inventory_xml(new_revision)
1849
firstline = xml.split('\n', 1)[0]
1850
if (not 'revision_id="' in firstline or
1851
'format="7"' not in firstline):
1852
inv = self.branch.repository.deserialise_inventory(
1854
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1855
self._write_basis_inventory(xml)
1856
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1859
def read_basis_inventory(self):
1860
"""Read the cached basis inventory."""
1861
path = self._basis_inventory_name()
1862
return self._transport.get_bytes(path)
1865
def read_working_inventory(self):
1866
"""Read the working inventory.
1868
:raises errors.InventoryModified: read_working_inventory will fail
1869
when the current in memory inventory has been modified.
1871
# conceptually this should be an implementation detail of the tree.
1872
# XXX: Deprecate this.
1873
# ElementTree does its own conversion from UTF-8, so open in
1875
if self._inventory_is_modified:
1876
raise errors.InventoryModified(self)
1877
result = self._deserialize(self._transport.get('inventory'))
1878
self._set_inventory(result, dirty=False)
1881
@needs_tree_write_lock
1882
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1884
"""Remove nominated files from the working inventory.
1886
:files: File paths relative to the basedir.
1887
:keep_files: If true, the files will also be kept.
1888
:force: Delete files and directories, even if they are changed and
1889
even if the directories are not empty.
1891
if isinstance(files, basestring):
1897
unknown_nested_files=set()
1899
def recurse_directory_to_add_files(directory):
1900
# Recurse directory and add all files
1901
# so we can check if they have changed.
1902
for parent_info, file_infos in\
1903
self.walkdirs(directory):
1904
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1905
# Is it versioned or ignored?
1906
if self.path2id(relpath) or self.is_ignored(relpath):
1907
# Add nested content for deletion.
1908
new_files.add(relpath)
1910
# Files which are not versioned and not ignored
1911
# should be treated as unknown.
1912
unknown_nested_files.add((relpath, None, kind))
1914
for filename in files:
1915
# Get file name into canonical form.
1916
abspath = self.abspath(filename)
1917
filename = self.relpath(abspath)
1918
if len(filename) > 0:
1919
new_files.add(filename)
1920
recurse_directory_to_add_files(filename)
1922
files = list(new_files)
1925
return # nothing to do
1927
# Sort needed to first handle directory content before the directory
1928
files.sort(reverse=True)
1930
# Bail out if we are going to delete files we shouldn't
1931
if not keep_files and not force:
1932
has_changed_files = len(unknown_nested_files) > 0
1933
if not has_changed_files:
1934
for (file_id, path, content_change, versioned, parent_id, name,
1935
kind, executable) in self.iter_changes(self.basis_tree(),
1936
include_unchanged=True, require_versioned=False,
1937
want_unversioned=True, specific_files=files):
1938
if versioned == (False, False):
1939
# The record is unknown ...
1940
if not self.is_ignored(path[1]):
1941
# ... but not ignored
1942
has_changed_files = True
1944
elif content_change and (kind[1] is not None):
1945
# Versioned and changed, but not deleted
1946
has_changed_files = True
1949
if has_changed_files:
1950
# Make delta show ALL applicable changes in error message.
1951
tree_delta = self.changes_from(self.basis_tree(),
1952
require_versioned=False, want_unversioned=True,
1953
specific_files=files)
1954
for unknown_file in unknown_nested_files:
1955
if unknown_file not in tree_delta.unversioned:
1956
tree_delta.unversioned.extend((unknown_file,))
1957
raise errors.BzrRemoveChangedFilesError(tree_delta)
1959
# Build inv_delta and delete files where applicaple,
1960
# do this before any modifications to inventory.
1962
fid = self.path2id(f)
1965
message = "%s is not versioned." % (f,)
1968
# having removed it, it must be either ignored or unknown
1969
if self.is_ignored(f):
1973
textui.show_status(new_status, self.kind(fid), f,
1976
inv_delta.append((f, None, fid, None))
1977
message = "removed %s" % (f,)
1980
abs_path = self.abspath(f)
1981
if osutils.lexists(abs_path):
1982
if (osutils.isdir(abs_path) and
1983
len(os.listdir(abs_path)) > 0):
1985
osutils.rmtree(abs_path)
1987
message = "%s is not an empty directory "\
1988
"and won't be deleted." % (f,)
1990
osutils.delete_any(abs_path)
1991
message = "deleted %s" % (f,)
1992
elif message is not None:
1993
# Only care if we haven't done anything yet.
1994
message = "%s does not exist." % (f,)
1996
# Print only one message (if any) per file.
1997
if message is not None:
1999
self.apply_inventory_delta(inv_delta)
2001
@needs_tree_write_lock
2002
def revert(self, filenames=None, old_tree=None, backups=True,
2003
pb=DummyProgress(), report_changes=False):
2004
from bzrlib.conflicts import resolve
2007
symbol_versioning.warn('Using [] to revert all files is deprecated'
2008
' as of bzr 0.91. Please use None (the default) instead.',
2009
DeprecationWarning, stacklevel=2)
2010
if old_tree is None:
2011
basis_tree = self.basis_tree()
2012
basis_tree.lock_read()
2013
old_tree = basis_tree
2017
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2019
if filenames is None and len(self.get_parent_ids()) > 1:
2021
last_revision = self.last_revision()
2022
if last_revision != NULL_REVISION:
2023
if basis_tree is None:
2024
basis_tree = self.basis_tree()
2025
basis_tree.lock_read()
2026
parent_trees.append((last_revision, basis_tree))
2027
self.set_parent_trees(parent_trees)
2030
resolve(self, filenames, ignore_misses=True, recursive=True)
2032
if basis_tree is not None:
2036
def revision_tree(self, revision_id):
2037
"""See Tree.revision_tree.
2039
WorkingTree can supply revision_trees for the basis revision only
2040
because there is only one cached inventory in the bzr directory.
2042
if revision_id == self.last_revision():
2044
xml = self.read_basis_inventory()
2045
except errors.NoSuchFile:
2049
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2050
# dont use the repository revision_tree api because we want
2051
# to supply the inventory.
2052
if inv.revision_id == revision_id:
2053
return revisiontree.RevisionTree(self.branch.repository,
2055
except errors.BadInventoryFormat:
2057
# raise if there was no inventory, or if we read the wrong inventory.
2058
raise errors.NoSuchRevisionInTree(self, revision_id)
2060
# XXX: This method should be deprecated in favour of taking in a proper
2061
# new Inventory object.
2062
@needs_tree_write_lock
2063
def set_inventory(self, new_inventory_list):
2064
from bzrlib.inventory import (Inventory,
2069
inv = Inventory(self.get_root_id())
2070
for path, file_id, parent, kind in new_inventory_list:
2071
name = os.path.basename(path)
2074
# fixme, there should be a factory function inv,add_??
2075
if kind == 'directory':
2076
inv.add(InventoryDirectory(file_id, name, parent))
2077
elif kind == 'file':
2078
inv.add(InventoryFile(file_id, name, parent))
2079
elif kind == 'symlink':
2080
inv.add(InventoryLink(file_id, name, parent))
2082
raise errors.BzrError("unknown kind %r" % kind)
2083
self._write_inventory(inv)
2085
@needs_tree_write_lock
2086
def set_root_id(self, file_id):
2087
"""Set the root id for this tree."""
2091
'WorkingTree.set_root_id with fileid=None')
2092
file_id = osutils.safe_file_id(file_id)
2093
self._set_root_id(file_id)
2095
def _set_root_id(self, file_id):
2096
"""Set the root id for this tree, in a format specific manner.
2098
:param file_id: The file id to assign to the root. It must not be
2099
present in the current inventory or an error will occur. It must
2100
not be None, but rather a valid file id.
2102
inv = self._inventory
2103
orig_root_id = inv.root.file_id
2104
# TODO: it might be nice to exit early if there was nothing
2105
# to do, saving us from trigger a sync on unlock.
2106
self._inventory_is_modified = True
2107
# we preserve the root inventory entry object, but
2108
# unlinkit from the byid index
2109
del inv._byid[inv.root.file_id]
2110
inv.root.file_id = file_id
2111
# and link it into the index with the new changed id.
2112
inv._byid[inv.root.file_id] = inv.root
2113
# and finally update all children to reference the new id.
2114
# XXX: this should be safe to just look at the root.children
2115
# list, not the WHOLE INVENTORY.
2118
if entry.parent_id == orig_root_id:
2119
entry.parent_id = inv.root.file_id
2122
"""See Branch.unlock.
2124
WorkingTree locking just uses the Branch locking facilities.
2125
This is current because all working trees have an embedded branch
2126
within them. IF in the future, we were to make branch data shareable
2127
between multiple working trees, i.e. via shared storage, then we
2128
would probably want to lock both the local tree, and the branch.
2130
raise NotImplementedError(self.unlock)
2132
def update(self, change_reporter=None, possible_transports=None):
2133
"""Update a working tree along its branch.
2135
This will update the branch if its bound too, which means we have
2136
multiple trees involved:
2138
- The new basis tree of the master.
2139
- The old basis tree of the branch.
2140
- The old basis tree of the working tree.
2141
- The current working tree state.
2143
Pathologically, all three may be different, and non-ancestors of each
2144
other. Conceptually we want to:
2146
- Preserve the wt.basis->wt.state changes
2147
- Transform the wt.basis to the new master basis.
2148
- Apply a merge of the old branch basis to get any 'local' changes from
2150
- Restore the wt.basis->wt.state changes.
2152
There isn't a single operation at the moment to do that, so we:
2153
- Merge current state -> basis tree of the master w.r.t. the old tree
2155
- Do a 'normal' merge of the old branch basis if it is relevant.
2157
if self.branch.get_bound_location() is not None:
2159
update_branch = True
2161
self.lock_tree_write()
2162
update_branch = False
2165
old_tip = self.branch.update(possible_transports)
2168
return self._update_tree(old_tip, change_reporter)
2172
@needs_tree_write_lock
2173
def _update_tree(self, old_tip=None, change_reporter=None):
2174
"""Update a tree to the master branch.
2176
:param old_tip: if supplied, the previous tip revision the branch,
2177
before it was changed to the master branch's tip.
2179
# here if old_tip is not None, it is the old tip of the branch before
2180
# it was updated from the master branch. This should become a pending
2181
# merge in the working tree to preserve the user existing work. we
2182
# cant set that until we update the working trees last revision to be
2183
# one from the new branch, because it will just get absorbed by the
2184
# parent de-duplication logic.
2186
# We MUST save it even if an error occurs, because otherwise the users
2187
# local work is unreferenced and will appear to have been lost.
2191
last_rev = self.get_parent_ids()[0]
2193
last_rev = _mod_revision.NULL_REVISION
2194
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2195
# merge tree state up to new branch tip.
2196
basis = self.basis_tree()
2199
to_tree = self.branch.basis_tree()
2200
if basis.inventory.root is None:
2201
self.set_root_id(to_tree.get_root_id())
2203
result += merge.merge_inner(
2208
change_reporter=change_reporter)
2211
# TODO - dedup parents list with things merged by pull ?
2212
# reuse the tree we've updated to to set the basis:
2213
parent_trees = [(self.branch.last_revision(), to_tree)]
2214
merges = self.get_parent_ids()[1:]
2215
# Ideally we ask the tree for the trees here, that way the working
2216
# tree can decide whether to give us teh entire tree or give us a
2217
# lazy initialised tree. dirstate for instance will have the trees
2218
# in ram already, whereas a last-revision + basis-inventory tree
2219
# will not, but also does not need them when setting parents.
2220
for parent in merges:
2221
parent_trees.append(
2222
(parent, self.branch.repository.revision_tree(parent)))
2223
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2224
parent_trees.append(
2225
(old_tip, self.branch.repository.revision_tree(old_tip)))
2226
self.set_parent_trees(parent_trees)
2227
last_rev = parent_trees[0][0]
2229
# the working tree had the same last-revision as the master
2230
# branch did. We may still have pivot local work from the local
2231
# branch into old_tip:
2232
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2233
self.add_parent_tree_id(old_tip)
2234
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2235
and old_tip != last_rev):
2236
# our last revision was not the prior branch last revision
2237
# and we have converted that last revision to a pending merge.
2238
# base is somewhere between the branch tip now
2239
# and the now pending merge
2241
# Since we just modified the working tree and inventory, flush out
2242
# the current state, before we modify it again.
2243
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2244
# requires it only because TreeTransform directly munges the
2245
# inventory and calls tree._write_inventory(). Ultimately we
2246
# should be able to remove this extra flush.
2248
graph = self.branch.repository.get_graph()
2249
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2251
base_tree = self.branch.repository.revision_tree(base_rev_id)
2252
other_tree = self.branch.repository.revision_tree(old_tip)
2253
result += merge.merge_inner(
2258
change_reporter=change_reporter)
2261
def _write_hashcache_if_dirty(self):
2262
"""Write out the hashcache if it is dirty."""
2263
if self._hashcache.needs_write:
2265
self._hashcache.write()
2267
if e.errno not in (errno.EPERM, errno.EACCES):
2269
# TODO: jam 20061219 Should this be a warning? A single line
2270
# warning might be sufficient to let the user know what
2272
mutter('Could not write hashcache for %s\nError: %s',
2273
self._hashcache.cache_file_name(), e)
2275
@needs_tree_write_lock
2276
def _write_inventory(self, inv):
2277
"""Write inventory as the current inventory."""
2278
self._set_inventory(inv, dirty=True)
2281
def set_conflicts(self, arg):
2282
raise errors.UnsupportedOperation(self.set_conflicts, self)
2284
def add_conflicts(self, arg):
2285
raise errors.UnsupportedOperation(self.add_conflicts, self)
2288
def conflicts(self):
2289
conflicts = _mod_conflicts.ConflictList()
2290
for conflicted in self._iter_conflicts():
2293
if file_kind(self.abspath(conflicted)) != "file":
2295
except errors.NoSuchFile:
2298
for suffix in ('.THIS', '.OTHER'):
2300
kind = file_kind(self.abspath(conflicted+suffix))
2303
except errors.NoSuchFile:
2307
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2308
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2310
file_id=self.path2id(conflicted)))
2313
def walkdirs(self, prefix=""):
2314
"""Walk the directories of this tree.
2316
returns a generator which yields items in the form:
2317
((curren_directory_path, fileid),
2318
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2321
This API returns a generator, which is only valid during the current
2322
tree transaction - within a single lock_read or lock_write duration.
2324
If the tree is not locked, it may cause an error to be raised,
2325
depending on the tree implementation.
2327
disk_top = self.abspath(prefix)
2328
if disk_top.endswith('/'):
2329
disk_top = disk_top[:-1]
2330
top_strip_len = len(disk_top) + 1
2331
inventory_iterator = self._walkdirs(prefix)
2332
disk_iterator = osutils.walkdirs(disk_top, prefix)
2334
current_disk = disk_iterator.next()
2335
disk_finished = False
2337
if not (e.errno == errno.ENOENT or
2338
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2341
disk_finished = True
2343
current_inv = inventory_iterator.next()
2344
inv_finished = False
2345
except StopIteration:
2348
while not inv_finished or not disk_finished:
2350
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2351
cur_disk_dir_content) = current_disk
2353
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2354
cur_disk_dir_content) = ((None, None), None)
2355
if not disk_finished:
2356
# strip out .bzr dirs
2357
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2358
len(cur_disk_dir_content) > 0):
2359
# osutils.walkdirs can be made nicer -
2360
# yield the path-from-prefix rather than the pathjoined
2362
bzrdir_loc = bisect_left(cur_disk_dir_content,
2364
if (bzrdir_loc < len(cur_disk_dir_content)
2365
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2366
# we dont yield the contents of, or, .bzr itself.
2367
del cur_disk_dir_content[bzrdir_loc]
2369
# everything is unknown
2372
# everything is missing
2375
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2377
# disk is before inventory - unknown
2378
dirblock = [(relpath, basename, kind, stat, None, None) for
2379
relpath, basename, kind, stat, top_path in
2380
cur_disk_dir_content]
2381
yield (cur_disk_dir_relpath, None), dirblock
2383
current_disk = disk_iterator.next()
2384
except StopIteration:
2385
disk_finished = True
2387
# inventory is before disk - missing.
2388
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2389
for relpath, basename, dkind, stat, fileid, kind in
2391
yield (current_inv[0][0], current_inv[0][1]), dirblock
2393
current_inv = inventory_iterator.next()
2394
except StopIteration:
2397
# versioned present directory
2398
# merge the inventory and disk data together
2400
for relpath, subiterator in itertools.groupby(sorted(
2401
current_inv[1] + cur_disk_dir_content,
2402
key=operator.itemgetter(0)), operator.itemgetter(1)):
2403
path_elements = list(subiterator)
2404
if len(path_elements) == 2:
2405
inv_row, disk_row = path_elements
2406
# versioned, present file
2407
dirblock.append((inv_row[0],
2408
inv_row[1], disk_row[2],
2409
disk_row[3], inv_row[4],
2411
elif len(path_elements[0]) == 5:
2413
dirblock.append((path_elements[0][0],
2414
path_elements[0][1], path_elements[0][2],
2415
path_elements[0][3], None, None))
2416
elif len(path_elements[0]) == 6:
2417
# versioned, absent file.
2418
dirblock.append((path_elements[0][0],
2419
path_elements[0][1], 'unknown', None,
2420
path_elements[0][4], path_elements[0][5]))
2422
raise NotImplementedError('unreachable code')
2423
yield current_inv[0], dirblock
2425
current_inv = inventory_iterator.next()
2426
except StopIteration:
2429
current_disk = disk_iterator.next()
2430
except StopIteration:
2431
disk_finished = True
2433
def _walkdirs(self, prefix=""):
2434
"""Walk the directories of this tree.
2436
:prefix: is used as the directrory to start with.
2437
returns a generator which yields items in the form:
2438
((curren_directory_path, fileid),
2439
[(file1_path, file1_name, file1_kind, None, file1_id,
2442
_directory = 'directory'
2443
# get the root in the inventory
2444
inv = self.inventory
2445
top_id = inv.path2id(prefix)
2449
pending = [(prefix, '', _directory, None, top_id, None)]
2452
currentdir = pending.pop()
2453
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2454
top_id = currentdir[4]
2456
relroot = currentdir[0] + '/'
2459
# FIXME: stash the node in pending
2461
if entry.kind == 'directory':
2462
for name, child in entry.sorted_children():
2463
dirblock.append((relroot + name, name, child.kind, None,
2464
child.file_id, child.kind
2466
yield (currentdir[0], entry.file_id), dirblock
2467
# push the user specified dirs from dirblock
2468
for dir in reversed(dirblock):
2469
if dir[2] == _directory:
2472
@needs_tree_write_lock
2473
def auto_resolve(self):
2474
"""Automatically resolve text conflicts according to contents.
2476
Only text conflicts are auto_resolvable. Files with no conflict markers
2477
are considered 'resolved', because bzr always puts conflict markers
2478
into files that have text conflicts. The corresponding .THIS .BASE and
2479
.OTHER files are deleted, as per 'resolve'.
2480
:return: a tuple of ConflictLists: (un_resolved, resolved).
2482
un_resolved = _mod_conflicts.ConflictList()
2483
resolved = _mod_conflicts.ConflictList()
2484
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2485
for conflict in self.conflicts():
2486
if (conflict.typestring != 'text conflict' or
2487
self.kind(conflict.file_id) != 'file'):
2488
un_resolved.append(conflict)
2490
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2492
for line in my_file:
2493
if conflict_re.search(line):
2494
un_resolved.append(conflict)
2497
resolved.append(conflict)
2500
resolved.remove_files(self)
2501
self.set_conflicts(un_resolved)
2502
return un_resolved, resolved
2506
tree_basis = self.basis_tree()
2507
tree_basis.lock_read()
2509
repo_basis = self.branch.repository.revision_tree(
2510
self.last_revision())
2511
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2512
raise errors.BzrCheckError(
2513
"Mismatched basis inventory content.")
2518
def _validate(self):
2519
"""Validate internal structures.
2521
This is meant mostly for the test suite. To give it a chance to detect
2522
corruption after actions have occurred. The default implementation is a
2525
:return: None. An exception should be raised if there is an error.
2530
def _get_rules_searcher(self, default_searcher):
2531
"""See Tree._get_rules_searcher."""
2532
if self._rules_searcher is None:
2533
self._rules_searcher = super(WorkingTree,
2534
self)._get_rules_searcher(default_searcher)
2535
return self._rules_searcher
2537
def get_shelf_manager(self):
2538
"""Return the ShelfManager for this WorkingTree."""
2539
from bzrlib.shelf import ShelfManager
2540
return ShelfManager(self, self._transport)
2543
class WorkingTree2(WorkingTree):
2544
"""This is the Format 2 working tree.
2546
This was the first weave based working tree.
2547
- uses os locks for locking.
2548
- uses the branch last-revision.
2551
def __init__(self, *args, **kwargs):
2552
super(WorkingTree2, self).__init__(*args, **kwargs)
2553
# WorkingTree2 has more of a constraint that self._inventory must
2554
# exist. Because this is an older format, we don't mind the overhead
2555
# caused by the extra computation here.
2557
# Newer WorkingTree's should only have self._inventory set when they
2559
if self._inventory is None:
2560
self.read_working_inventory()
2562
def lock_tree_write(self):
2563
"""See WorkingTree.lock_tree_write().
2565
In Format2 WorkingTrees we have a single lock for the branch and tree
2566
so lock_tree_write() degrades to lock_write().
2568
self.branch.lock_write()
2570
return self._control_files.lock_write()
2572
self.branch.unlock()
2576
# do non-implementation specific cleanup
2579
# we share control files:
2580
if self._control_files._lock_count == 3:
2581
# _inventory_is_modified is always False during a read lock.
2582
if self._inventory_is_modified:
2584
self._write_hashcache_if_dirty()
2586
# reverse order of locking.
2588
return self._control_files.unlock()
2590
self.branch.unlock()
2593
class WorkingTree3(WorkingTree):
2594
"""This is the Format 3 working tree.
2596
This differs from the base WorkingTree by:
2597
- having its own file lock
2598
- having its own last-revision property.
2600
This is new in bzr 0.8
2604
def _last_revision(self):
2605
"""See Mutable.last_revision."""
2607
return self._transport.get_bytes('last-revision')
2608
except errors.NoSuchFile:
2609
return _mod_revision.NULL_REVISION
2611
def _change_last_revision(self, revision_id):
2612
"""See WorkingTree._change_last_revision."""
2613
if revision_id is None or revision_id == NULL_REVISION:
2615
self._transport.delete('last-revision')
2616
except errors.NoSuchFile:
2620
self._transport.put_bytes('last-revision', revision_id,
2621
mode=self._control_files._file_mode)
2624
@needs_tree_write_lock
2625
def set_conflicts(self, conflicts):
2626
self._put_rio('conflicts', conflicts.to_stanzas(),
2629
@needs_tree_write_lock
2630
def add_conflicts(self, new_conflicts):
2631
conflict_set = set(self.conflicts())
2632
conflict_set.update(set(list(new_conflicts)))
2633
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2634
key=_mod_conflicts.Conflict.sort_key)))
2637
def conflicts(self):
2639
confile = self._transport.get('conflicts')
2640
except errors.NoSuchFile:
2641
return _mod_conflicts.ConflictList()
2644
if confile.next() != CONFLICT_HEADER_1 + '\n':
2645
raise errors.ConflictFormatError()
2646
except StopIteration:
2647
raise errors.ConflictFormatError()
2648
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2653
# do non-implementation specific cleanup
2655
if self._control_files._lock_count == 1:
2656
# _inventory_is_modified is always False during a read lock.
2657
if self._inventory_is_modified:
2659
self._write_hashcache_if_dirty()
2660
# reverse order of locking.
2662
return self._control_files.unlock()
2664
self.branch.unlock()
2667
def get_conflicted_stem(path):
2668
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2669
if path.endswith(suffix):
2670
return path[:-len(suffix)]
2673
class WorkingTreeFormat(object):
2674
"""An encapsulation of the initialization and open routines for a format.
2676
Formats provide three things:
2677
* An initialization routine,
2681
Formats are placed in an dict by their format string for reference
2682
during workingtree opening. Its not required that these be instances, they
2683
can be classes themselves with class methods - it simply depends on
2684
whether state is needed for a given format or not.
2686
Once a format is deprecated, just deprecate the initialize and open
2687
methods on the format class. Do not deprecate the object, as the
2688
object will be created every time regardless.
2691
_default_format = None
2692
"""The default format used for new trees."""
2695
"""The known formats."""
2697
requires_rich_root = False
2699
upgrade_recommended = False
2702
def find_format(klass, a_bzrdir):
2703
"""Return the format for the working tree object in a_bzrdir."""
2705
transport = a_bzrdir.get_workingtree_transport(None)
2706
format_string = transport.get("format").read()
2707
return klass._formats[format_string]
2708
except errors.NoSuchFile:
2709
raise errors.NoWorkingTree(base=transport.base)
2711
raise errors.UnknownFormatError(format=format_string,
2712
kind="working tree")
2714
def __eq__(self, other):
2715
return self.__class__ is other.__class__
2717
def __ne__(self, other):
2718
return not (self == other)
2721
def get_default_format(klass):
2722
"""Return the current default format."""
2723
return klass._default_format
2725
def get_format_string(self):
2726
"""Return the ASCII format string that identifies this format."""
2727
raise NotImplementedError(self.get_format_string)
2729
def get_format_description(self):
2730
"""Return the short description for this format."""
2731
raise NotImplementedError(self.get_format_description)
2733
def is_supported(self):
2734
"""Is this format supported?
2736
Supported formats can be initialized and opened.
2737
Unsupported formats may not support initialization or committing or
2738
some other features depending on the reason for not being supported.
2743
def register_format(klass, format):
2744
klass._formats[format.get_format_string()] = format
2747
def set_default_format(klass, format):
2748
klass._default_format = format
2751
def unregister_format(klass, format):
2752
del klass._formats[format.get_format_string()]
2755
class WorkingTreeFormat2(WorkingTreeFormat):
2756
"""The second working tree format.
2758
This format modified the hash cache from the format 1 hash cache.
2761
upgrade_recommended = True
2763
def get_format_description(self):
2764
"""See WorkingTreeFormat.get_format_description()."""
2765
return "Working tree format 2"
2767
def _stub_initialize_on_transport(self, transport, file_mode):
2768
"""Workaround: create control files for a remote working tree.
2770
This ensures that it can later be updated and dealt with locally,
2771
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2772
no working tree. (See bug #43064).
2776
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2778
transport.put_file('inventory', sio, file_mode)
2779
transport.put_bytes('pending-merges', '', file_mode)
2781
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2782
accelerator_tree=None, hardlink=False):
2783
"""See WorkingTreeFormat.initialize()."""
2784
if not isinstance(a_bzrdir.transport, LocalTransport):
2785
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2786
if from_branch is not None:
2787
branch = from_branch
2789
branch = a_bzrdir.open_branch()
2790
if revision_id is None:
2791
revision_id = _mod_revision.ensure_null(branch.last_revision())
2794
branch.generate_revision_history(revision_id)
2798
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2804
basis_tree = branch.repository.revision_tree(revision_id)
2805
if basis_tree.inventory.root is not None:
2806
wt.set_root_id(basis_tree.get_root_id())
2807
# set the parent list and cache the basis tree.
2808
if _mod_revision.is_null(revision_id):
2811
parent_trees = [(revision_id, basis_tree)]
2812
wt.set_parent_trees(parent_trees)
2813
transform.build_tree(basis_tree, wt)
2817
super(WorkingTreeFormat2, self).__init__()
2818
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2820
def open(self, a_bzrdir, _found=False):
2821
"""Return the WorkingTree object for a_bzrdir
2823
_found is a private parameter, do not use it. It is used to indicate
2824
if format probing has already been done.
2827
# we are being called directly and must probe.
2828
raise NotImplementedError
2829
if not isinstance(a_bzrdir.transport, LocalTransport):
2830
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2831
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2837
class WorkingTreeFormat3(WorkingTreeFormat):
2838
"""The second working tree format updated to record a format marker.
2841
- exists within a metadir controlling .bzr
2842
- includes an explicit version marker for the workingtree control
2843
files, separate from the BzrDir format
2844
- modifies the hash cache format
2846
- uses a LockDir to guard access for writes.
2849
upgrade_recommended = True
2851
def get_format_string(self):
2852
"""See WorkingTreeFormat.get_format_string()."""
2853
return "Bazaar-NG Working Tree format 3"
2855
def get_format_description(self):
2856
"""See WorkingTreeFormat.get_format_description()."""
2857
return "Working tree format 3"
2859
_lock_file_name = 'lock'
2860
_lock_class = LockDir
2862
_tree_class = WorkingTree3
2864
def __get_matchingbzrdir(self):
2865
return bzrdir.BzrDirMetaFormat1()
2867
_matchingbzrdir = property(__get_matchingbzrdir)
2869
def _open_control_files(self, a_bzrdir):
2870
transport = a_bzrdir.get_workingtree_transport(None)
2871
return LockableFiles(transport, self._lock_file_name,
2874
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2875
accelerator_tree=None, hardlink=False):
2876
"""See WorkingTreeFormat.initialize().
2878
:param revision_id: if supplied, create a working tree at a different
2879
revision than the branch is at.
2880
:param accelerator_tree: A tree which can be used for retrieving file
2881
contents more quickly than the revision tree, i.e. a workingtree.
2882
The revision tree will be used for cases where accelerator_tree's
2883
content is different.
2884
:param hardlink: If true, hard-link files from accelerator_tree,
2887
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2889
transport = a_bzrdir.get_workingtree_transport(self)
2890
control_files = self._open_control_files(a_bzrdir)
2891
control_files.create_lock()
2892
control_files.lock_write()
2893
transport.put_bytes('format', self.get_format_string(),
2894
mode=control_files._file_mode)
2895
if from_branch is not None:
2896
branch = from_branch
2898
branch = a_bzrdir.open_branch()
2899
if revision_id is None:
2900
revision_id = _mod_revision.ensure_null(branch.last_revision())
2901
# WorkingTree3 can handle an inventory which has a unique root id.
2902
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2903
# those trees. And because there isn't a format bump inbetween, we
2904
# are maintaining compatibility with older clients.
2905
# inv = Inventory(root_id=gen_root_id())
2906
inv = self._initial_inventory()
2907
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2913
_control_files=control_files)
2914
wt.lock_tree_write()
2916
basis_tree = branch.repository.revision_tree(revision_id)
2917
# only set an explicit root id if there is one to set.
2918
if basis_tree.inventory.root is not None:
2919
wt.set_root_id(basis_tree.get_root_id())
2920
if revision_id == NULL_REVISION:
2921
wt.set_parent_trees([])
2923
wt.set_parent_trees([(revision_id, basis_tree)])
2924
transform.build_tree(basis_tree, wt)
2926
# Unlock in this order so that the unlock-triggers-flush in
2927
# WorkingTree is given a chance to fire.
2928
control_files.unlock()
2932
def _initial_inventory(self):
2936
super(WorkingTreeFormat3, self).__init__()
2938
def open(self, a_bzrdir, _found=False):
2939
"""Return the WorkingTree object for a_bzrdir
2941
_found is a private parameter, do not use it. It is used to indicate
2942
if format probing has already been done.
2945
# we are being called directly and must probe.
2946
raise NotImplementedError
2947
if not isinstance(a_bzrdir.transport, LocalTransport):
2948
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2949
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2952
def _open(self, a_bzrdir, control_files):
2953
"""Open the tree itself.
2955
:param a_bzrdir: the dir for the tree.
2956
:param control_files: the control files for the tree.
2958
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2962
_control_files=control_files)
2965
return self.get_format_string()
2968
__default_format = WorkingTreeFormat4()
2969
WorkingTreeFormat.register_format(__default_format)
2970
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2971
WorkingTreeFormat.set_default_format(__default_format)
2972
# formats which have no format string are not discoverable
2973
# and not independently creatable, so are not registered.
2974
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
