1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib import osutils
94
from bzrlib.osutils import (
106
from bzrlib.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
# override this to set the strategy for storing views
190
def _make_views(self):
191
return views.DisabledViews(self)
193
def __init__(self, basedir='.',
194
branch=DEPRECATED_PARAMETER,
200
"""Construct a WorkingTree instance. This is not a public API.
202
:param branch: A branch to override probing for the branch.
204
self._format = _format
205
self.bzrdir = _bzrdir
207
raise errors.BzrError("Please use bzrdir.open_workingtree or "
208
"WorkingTree.open() to obtain a WorkingTree.")
209
basedir = safe_unicode(basedir)
210
mutter("opening working tree %r", basedir)
211
if deprecated_passed(branch):
212
self._branch = branch
214
self._branch = self.bzrdir.open_branch()
215
self.basedir = realpath(basedir)
216
# if branch is at our basedir and is a format 6 or less
217
if isinstance(self._format, WorkingTreeFormat2):
218
# share control object
219
self._control_files = self.branch.control_files
221
# assume all other formats have their own control files.
222
self._control_files = _control_files
223
self._transport = self._control_files._transport
224
# update the whole cache up front and write to disk if anything changed;
225
# in the future we might want to do this more selectively
226
# two possible ways offer themselves : in self._unlock, write the cache
227
# if needed, or, when the cache sees a change, append it to the hash
228
# cache file, and have the parser take the most recent entry for a
230
wt_trans = self.bzrdir.get_workingtree_transport(None)
231
cache_filename = wt_trans.local_abspath('stat-cache')
232
self._hashcache = hashcache.HashCache(basedir, cache_filename,
233
self.bzrdir._get_file_mode())
236
# is this scan needed ? it makes things kinda slow.
243
if _inventory is None:
244
# This will be acquired on lock_read() or lock_write()
245
self._inventory_is_modified = False
246
self._inventory = None
248
# the caller of __init__ has provided an inventory,
249
# we assume they know what they are doing - as its only
250
# the Format factory and creation methods that are
251
# permitted to do this.
252
self._set_inventory(_inventory, dirty=False)
253
self._detect_case_handling()
254
self._rules_searcher = None
255
self.views = self._make_views()
257
def _detect_case_handling(self):
258
wt_trans = self.bzrdir.get_workingtree_transport(None)
260
wt_trans.stat("FoRMaT")
261
except errors.NoSuchFile:
262
self.case_sensitive = True
264
self.case_sensitive = False
266
self._setup_directory_is_tree_reference()
269
fget=lambda self: self._branch,
270
doc="""The branch this WorkingTree is connected to.
272
This cannot be set - it is reflective of the actual disk structure
273
the working tree has been constructed from.
276
def break_lock(self):
277
"""Break a lock if one is present from another instance.
279
Uses the ui factory to ask for confirmation if the lock may be from
282
This will probe the repository for its lock as well.
284
self._control_files.break_lock()
285
self.branch.break_lock()
287
def requires_rich_root(self):
288
return self._format.requires_rich_root
290
def supports_tree_reference(self):
293
def supports_content_filtering(self):
294
return self._format.supports_content_filtering()
296
def supports_views(self):
297
return self.views.supports_views()
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
self._inventory = inv
310
self._inventory_is_modified = dirty
313
def open(path=None, _unsupported=False):
314
"""Open an existing working tree at path.
318
path = osutils.getcwd()
319
control = bzrdir.BzrDir.open(path, _unsupported)
320
return control.open_workingtree(_unsupported)
323
def open_containing(path=None):
324
"""Open an existing working tree which has its root about path.
326
This probes for a working tree at path and searches upwards from there.
328
Basically we keep looking up until we find the control directory or
329
run into /. If there isn't one, raises NotBranchError.
330
TODO: give this a new exception.
331
If there is one, it is returned, along with the unused portion of path.
333
:return: The WorkingTree that contains 'path', and the rest of path
336
path = osutils.getcwd()
337
control, relpath = bzrdir.BzrDir.open_containing(path)
339
return control.open_workingtree(), relpath
342
def open_downlevel(path=None):
343
"""Open an unsupported working tree.
345
Only intended for advanced situations like upgrading part of a bzrdir.
347
return WorkingTree.open(path, _unsupported=True)
350
def find_trees(location):
351
def list_current(transport):
352
return [d for d in transport.list_dir('') if d != '.bzr']
353
def evaluate(bzrdir):
355
tree = bzrdir.open_workingtree()
356
except errors.NoWorkingTree:
360
transport = get_transport(location)
361
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
362
list_current=list_current)
363
return [t for t in iterator if t is not None]
365
# should be deprecated - this is slow and in any case treating them as a
366
# container is (we now know) bad style -- mbp 20070302
367
## @deprecated_method(zero_fifteen)
369
"""Iterate through file_ids for this tree.
371
file_ids are in a WorkingTree if they are in the working inventory
372
and the working file exists.
374
inv = self._inventory
375
for path, ie in inv.iter_entries():
376
if osutils.lexists(self.abspath(path)):
379
def all_file_ids(self):
380
"""See Tree.iter_all_file_ids"""
381
return set(self.inventory)
384
return "<%s of %s>" % (self.__class__.__name__,
385
getattr(self, 'basedir', None))
387
def abspath(self, filename):
388
return pathjoin(self.basedir, filename)
390
def basis_tree(self):
391
"""Return RevisionTree for the current last revision.
393
If the left most parent is a ghost then the returned tree will be an
394
empty tree - one obtained by calling
395
repository.revision_tree(NULL_REVISION).
398
revision_id = self.get_parent_ids()[0]
400
# no parents, return an empty revision tree.
401
# in the future this should return the tree for
402
# 'empty:' - the implicit root empty tree.
403
return self.branch.repository.revision_tree(
404
_mod_revision.NULL_REVISION)
406
return self.revision_tree(revision_id)
407
except errors.NoSuchRevision:
409
# No cached copy available, retrieve from the repository.
410
# FIXME? RBC 20060403 should we cache the inventory locally
413
return self.branch.repository.revision_tree(revision_id)
414
except (errors.RevisionNotPresent, errors.NoSuchRevision):
415
# the basis tree *may* be a ghost or a low level error may have
416
# occured. If the revision is present, its a problem, if its not
418
if self.branch.repository.has_revision(revision_id):
420
# the basis tree is a ghost so return an empty tree.
421
return self.branch.repository.revision_tree(
422
_mod_revision.NULL_REVISION)
425
self._flush_ignore_list_cache()
427
def relpath(self, path):
428
"""Return the local path portion from a given path.
430
The path may be absolute or relative. If its a relative path it is
431
interpreted relative to the python current working directory.
433
return osutils.relpath(self.basedir, path)
435
def has_filename(self, filename):
436
return osutils.lexists(self.abspath(filename))
438
def get_file(self, file_id, path=None):
439
return self.get_file_with_stat(file_id, path)[0]
441
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
442
"""See MutableTree.get_file_with_stat."""
444
path = self.id2path(file_id)
445
file_obj = self.get_file_byname(path)
446
return (file_obj, _fstat(file_obj.fileno()))
448
def get_file_byname(self, filename):
449
return file(self.abspath(filename), 'rb')
451
def get_file_lines(self, file_id, path=None):
452
"""See Tree.get_file_lines()"""
453
file = self.get_file(file_id, path)
455
return file.readlines()
460
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
461
"""See Tree.annotate_iter
463
This implementation will use the basis tree implementation if possible.
464
Lines not in the basis are attributed to CURRENT_REVISION
466
If there are pending merges, lines added by those merges will be
467
incorrectly attributed to CURRENT_REVISION (but after committing, the
468
attribution will be correct).
470
basis = self.basis_tree()
473
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
474
require_versioned=True).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
496
def _get_ancestors(self, default_revision):
497
ancestors = set([default_revision])
498
for parent_id in self.get_parent_ids():
499
ancestors.update(self.branch.repository.get_ancestry(
500
parent_id, topo_sorted=False))
503
def get_parent_ids(self):
504
"""See Tree.get_parent_ids.
506
This implementation reads the pending merges list and last_revision
507
value and uses that to decide what the parents list should be.
509
last_rev = _mod_revision.ensure_null(self._last_revision())
510
if _mod_revision.NULL_REVISION == last_rev:
515
merges_file = self._transport.get('pending-merges')
516
except errors.NoSuchFile:
519
for l in merges_file.readlines():
520
revision_id = l.rstrip('\n')
521
parents.append(revision_id)
525
def get_root_id(self):
526
"""Return the id of this trees root"""
527
return self._inventory.root.file_id
529
def _get_store_filename(self, file_id):
530
## XXX: badly named; this is not in the store at all
531
return self.abspath(self.id2path(file_id))
534
def clone(self, to_bzrdir, revision_id=None):
535
"""Duplicate this working tree into to_bzr, including all state.
537
Specifically modified files are kept as modified, but
538
ignored and unknown files are discarded.
540
If you want to make a new line of development, see bzrdir.sprout()
543
If not None, the cloned tree will have its last revision set to
544
revision, and and difference between the source trees last revision
545
and this one merged in.
547
# assumes the target bzr dir format is compatible.
548
result = to_bzrdir.create_workingtree()
549
self.copy_content_into(result, revision_id)
553
def copy_content_into(self, tree, revision_id=None):
554
"""Copy the current content and user files of this tree into tree."""
555
tree.set_root_id(self.get_root_id())
556
if revision_id is None:
557
merge.transform_tree(tree, self)
559
# TODO now merge from tree.last_revision to revision (to preserve
560
# user local changes)
561
merge.transform_tree(tree, self)
562
tree.set_parent_ids([revision_id])
564
def id2abspath(self, file_id):
565
return self.abspath(self.id2path(file_id))
567
def has_id(self, file_id):
568
# files that have been deleted are excluded
570
if not inv.has_id(file_id):
572
path = inv.id2path(file_id)
573
return osutils.lexists(self.abspath(path))
575
def has_or_had_id(self, file_id):
576
if file_id == self.inventory.root.file_id:
578
return self.inventory.has_id(file_id)
580
__contains__ = has_id
582
def get_file_size(self, file_id):
583
"""See Tree.get_file_size"""
585
return os.path.getsize(self.id2abspath(file_id))
587
if e.errno != errno.ENOENT:
593
def get_file_sha1(self, file_id, path=None, stat_value=None):
595
path = self._inventory.id2path(file_id)
596
return self._hashcache.get_sha1(path, stat_value)
598
def get_file_mtime(self, file_id, path=None):
600
path = self.inventory.id2path(file_id)
601
return os.lstat(self.abspath(path)).st_mtime
603
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
604
file_id = self.path2id(path)
605
return self._inventory[file_id].executable
607
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
608
mode = stat_result.st_mode
609
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
611
if not supports_executable():
612
def is_executable(self, file_id, path=None):
613
return self._inventory[file_id].executable
615
_is_executable_from_path_and_stat = \
616
_is_executable_from_path_and_stat_from_basis
618
def is_executable(self, file_id, path=None):
620
path = self.id2path(file_id)
621
mode = os.lstat(self.abspath(path)).st_mode
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
_is_executable_from_path_and_stat = \
625
_is_executable_from_path_and_stat_from_stat
627
@needs_tree_write_lock
628
def _add(self, files, ids, kinds):
629
"""See MutableTree._add."""
630
# TODO: Re-adding a file that is removed in the working copy
631
# should probably put it back with the previous ID.
632
# the read and write working inventory should not occur in this
633
# function - they should be part of lock_write and unlock.
635
for f, file_id, kind in zip(files, ids, kinds):
637
inv.add_path(f, kind=kind)
639
inv.add_path(f, kind=kind, file_id=file_id)
640
self._inventory_is_modified = True
642
@needs_tree_write_lock
643
def _gather_kinds(self, files, kinds):
644
"""See MutableTree._gather_kinds."""
645
for pos, f in enumerate(files):
646
if kinds[pos] is None:
647
fullpath = normpath(self.abspath(f))
649
kinds[pos] = file_kind(fullpath)
651
if e.errno == errno.ENOENT:
652
raise errors.NoSuchFile(fullpath)
655
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
656
"""Add revision_id as a parent.
658
This is equivalent to retrieving the current list of parent ids
659
and setting the list to its value plus revision_id.
661
:param revision_id: The revision id to add to the parent list. It may
662
be a ghost revision as long as its not the first parent to be added,
663
or the allow_leftmost_as_ghost parameter is set True.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parents = self.get_parent_ids() + [revision_id]
667
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
668
or allow_leftmost_as_ghost)
670
@needs_tree_write_lock
671
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
672
"""Add revision_id, tree tuple as a parent.
674
This is equivalent to retrieving the current list of parent trees
675
and setting the list to its value plus parent_tuple. See also
676
add_parent_tree_id - if you only have a parent id available it will be
677
simpler to use that api. If you have the parent already available, using
678
this api is preferred.
680
:param parent_tuple: The (revision id, tree) to add to the parent list.
681
If the revision_id is a ghost, pass None for the tree.
682
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
684
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
685
if len(parent_ids) > 1:
686
# the leftmost may have already been a ghost, preserve that if it
688
allow_leftmost_as_ghost = True
689
self.set_parent_ids(parent_ids,
690
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
692
@needs_tree_write_lock
693
def add_pending_merge(self, *revision_ids):
694
# TODO: Perhaps should check at this point that the
695
# history of the revision is actually present?
696
parents = self.get_parent_ids()
698
for rev_id in revision_ids:
699
if rev_id in parents:
701
parents.append(rev_id)
704
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
706
def path_content_summary(self, path, _lstat=os.lstat,
707
_mapper=osutils.file_kind_from_stat_mode):
708
"""See Tree.path_content_summary."""
709
abspath = self.abspath(path)
711
stat_result = _lstat(abspath)
713
if getattr(e, 'errno', None) == errno.ENOENT:
715
return ('missing', None, None, None)
716
# propagate other errors
718
kind = _mapper(stat_result.st_mode)
720
size = stat_result.st_size
721
# try for a stat cache lookup
722
executable = self._is_executable_from_path_and_stat(path, stat_result)
723
return (kind, size, executable, self._sha_from_stat(
725
elif kind == 'directory':
726
# perhaps it looks like a plain directory, but it's really a
728
if self._directory_is_tree_reference(path):
729
kind = 'tree-reference'
730
return kind, None, None, None
731
elif kind == 'symlink':
732
return ('symlink', None, None, os.readlink(abspath.encode(osutils._fs_enc)))
734
return (kind, None, None, None)
736
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
737
"""Common ghost checking functionality from set_parent_*.
739
This checks that the left hand-parent exists if there are any
742
if len(revision_ids) > 0:
743
leftmost_id = revision_ids[0]
744
if (not allow_leftmost_as_ghost and not
745
self.branch.repository.has_revision(leftmost_id)):
746
raise errors.GhostRevisionUnusableHere(leftmost_id)
748
def _set_merges_from_parent_ids(self, parent_ids):
749
merges = parent_ids[1:]
750
self._transport.put_bytes('pending-merges', '\n'.join(merges),
751
mode=self._control_files._file_mode)
753
def _filter_parent_ids_by_ancestry(self, revision_ids):
754
"""Check that all merged revisions are proper 'heads'.
756
This will always return the first revision_id, and any merged revisions
759
if len(revision_ids) == 0:
761
graph = self.branch.repository.get_graph()
762
heads = graph.heads(revision_ids)
763
new_revision_ids = revision_ids[:1]
764
for revision_id in revision_ids[1:]:
765
if revision_id in heads and revision_id not in new_revision_ids:
766
new_revision_ids.append(revision_id)
767
if new_revision_ids != revision_ids:
768
trace.mutter('requested to set revision_ids = %s,'
769
' but filtered to %s', revision_ids, new_revision_ids)
770
return new_revision_ids
772
@needs_tree_write_lock
773
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
774
"""Set the parent ids to revision_ids.
776
See also set_parent_trees. This api will try to retrieve the tree data
777
for each element of revision_ids from the trees repository. If you have
778
tree data already available, it is more efficient to use
779
set_parent_trees rather than set_parent_ids. set_parent_ids is however
780
an easier API to use.
782
:param revision_ids: The revision_ids to set as the parent ids of this
783
working tree. Any of these may be ghosts.
785
self._check_parents_for_ghosts(revision_ids,
786
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
787
for revision_id in revision_ids:
788
_mod_revision.check_not_reserved_id(revision_id)
790
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
792
if len(revision_ids) > 0:
793
self.set_last_revision(revision_ids[0])
795
self.set_last_revision(_mod_revision.NULL_REVISION)
797
self._set_merges_from_parent_ids(revision_ids)
799
@needs_tree_write_lock
800
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
801
"""See MutableTree.set_parent_trees."""
802
parent_ids = [rev for (rev, tree) in parents_list]
803
for revision_id in parent_ids:
804
_mod_revision.check_not_reserved_id(revision_id)
806
self._check_parents_for_ghosts(parent_ids,
807
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
809
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
811
if len(parent_ids) == 0:
812
leftmost_parent_id = _mod_revision.NULL_REVISION
813
leftmost_parent_tree = None
815
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
817
if self._change_last_revision(leftmost_parent_id):
818
if leftmost_parent_tree is None:
819
# If we don't have a tree, fall back to reading the
820
# parent tree from the repository.
821
self._cache_basis_inventory(leftmost_parent_id)
823
inv = leftmost_parent_tree.inventory
824
xml = self._create_basis_xml_from_inventory(
825
leftmost_parent_id, inv)
826
self._write_basis_inventory(xml)
827
self._set_merges_from_parent_ids(parent_ids)
829
@needs_tree_write_lock
830
def set_pending_merges(self, rev_list):
831
parents = self.get_parent_ids()
832
leftmost = parents[:1]
833
new_parents = leftmost + rev_list
834
self.set_parent_ids(new_parents)
836
@needs_tree_write_lock
837
def set_merge_modified(self, modified_hashes):
839
for file_id, hash in modified_hashes.iteritems():
840
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
841
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
843
def _sha_from_stat(self, path, stat_result):
844
"""Get a sha digest from the tree's stat cache.
846
The default implementation assumes no stat cache is present.
848
:param path: The path.
849
:param stat_result: The stat result being looked up.
853
def _put_rio(self, filename, stanzas, header):
854
self._must_be_locked()
855
my_file = rio_file(stanzas, header)
856
self._transport.put_file(filename, my_file,
857
mode=self._control_files._file_mode)
859
@needs_write_lock # because merge pulls data into the branch.
860
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
862
"""Merge from a branch into this working tree.
864
:param branch: The branch to merge from.
865
:param to_revision: If non-None, the merge will merge to to_revision,
866
but not beyond it. to_revision does not need to be in the history
867
of the branch when it is supplied. If None, to_revision defaults to
868
branch.last_revision().
870
from bzrlib.merge import Merger, Merge3Merger
871
pb = bzrlib.ui.ui_factory.nested_progress_bar()
873
merger = Merger(self.branch, this_tree=self, pb=pb)
874
merger.pp = ProgressPhase("Merge phase", 5, pb)
875
merger.pp.next_phase()
876
# check that there are no
878
merger.check_basis(check_clean=True, require_commits=False)
879
if to_revision is None:
880
to_revision = _mod_revision.ensure_null(branch.last_revision())
881
merger.other_rev_id = to_revision
882
if _mod_revision.is_null(merger.other_rev_id):
883
raise errors.NoCommits(branch)
884
self.branch.fetch(branch, last_revision=merger.other_rev_id)
885
merger.other_basis = merger.other_rev_id
886
merger.other_tree = self.branch.repository.revision_tree(
888
merger.other_branch = branch
889
merger.pp.next_phase()
890
if from_revision is None:
893
merger.set_base_revision(from_revision, branch)
894
if merger.base_rev_id == merger.other_rev_id:
895
raise errors.PointlessMerge
896
merger.backup_files = False
897
if merge_type is None:
898
merger.merge_type = Merge3Merger
900
merger.merge_type = merge_type
901
merger.set_interesting_files(None)
902
merger.show_base = False
903
merger.reprocess = False
904
conflicts = merger.do_merge()
911
def merge_modified(self):
912
"""Return a dictionary of files modified by a merge.
914
The list is initialized by WorkingTree.set_merge_modified, which is
915
typically called after we make some automatic updates to the tree
918
This returns a map of file_id->sha1, containing only files which are
919
still in the working inventory and have that text hash.
922
hashfile = self._transport.get('merge-hashes')
923
except errors.NoSuchFile:
928
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
929
raise errors.MergeModifiedFormatError()
930
except StopIteration:
931
raise errors.MergeModifiedFormatError()
932
for s in RioReader(hashfile):
933
# RioReader reads in Unicode, so convert file_ids back to utf8
934
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
935
if file_id not in self.inventory:
937
text_hash = s.get("hash")
938
if text_hash == self.get_file_sha1(file_id):
939
merge_hashes[file_id] = text_hash
945
def mkdir(self, path, file_id=None):
946
"""See MutableTree.mkdir()."""
948
file_id = generate_ids.gen_file_id(os.path.basename(path))
949
os.mkdir(self.abspath(path))
950
self.add(path, file_id, 'directory')
953
def get_symlink_target(self, file_id):
954
return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
957
def subsume(self, other_tree):
958
def add_children(inventory, entry):
959
for child_entry in entry.children.values():
960
inventory._byid[child_entry.file_id] = child_entry
961
if child_entry.kind == 'directory':
962
add_children(inventory, child_entry)
963
if other_tree.get_root_id() == self.get_root_id():
964
raise errors.BadSubsumeSource(self, other_tree,
965
'Trees have the same root')
967
other_tree_path = self.relpath(other_tree.basedir)
968
except errors.PathNotChild:
969
raise errors.BadSubsumeSource(self, other_tree,
970
'Tree is not contained by the other')
971
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
972
if new_root_parent is None:
973
raise errors.BadSubsumeSource(self, other_tree,
974
'Parent directory is not versioned.')
975
# We need to ensure that the result of a fetch will have a
976
# versionedfile for the other_tree root, and only fetching into
977
# RepositoryKnit2 guarantees that.
978
if not self.branch.repository.supports_rich_root():
979
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
980
other_tree.lock_tree_write()
982
new_parents = other_tree.get_parent_ids()
983
other_root = other_tree.inventory.root
984
other_root.parent_id = new_root_parent
985
other_root.name = osutils.basename(other_tree_path)
986
self.inventory.add(other_root)
987
add_children(self.inventory, other_root)
988
self._write_inventory(self.inventory)
989
# normally we don't want to fetch whole repositories, but i think
990
# here we really do want to consolidate the whole thing.
991
for parent_id in other_tree.get_parent_ids():
992
self.branch.fetch(other_tree.branch, parent_id)
993
self.add_parent_tree_id(parent_id)
996
other_tree.bzrdir.retire_bzrdir()
998
def _setup_directory_is_tree_reference(self):
999
if self._branch.repository._format.supports_tree_reference:
1000
self._directory_is_tree_reference = \
1001
self._directory_may_be_tree_reference
1003
self._directory_is_tree_reference = \
1004
self._directory_is_never_tree_reference
1006
def _directory_is_never_tree_reference(self, relpath):
1009
def _directory_may_be_tree_reference(self, relpath):
1010
# as a special case, if a directory contains control files then
1011
# it's a tree reference, except that the root of the tree is not
1012
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1013
# TODO: We could ask all the control formats whether they
1014
# recognize this directory, but at the moment there's no cheap api
1015
# to do that. Since we probably can only nest bzr checkouts and
1016
# they always use this name it's ok for now. -- mbp 20060306
1018
# FIXME: There is an unhandled case here of a subdirectory
1019
# containing .bzr but not a branch; that will probably blow up
1020
# when you try to commit it. It might happen if there is a
1021
# checkout in a subdirectory. This can be avoided by not adding
1024
@needs_tree_write_lock
1025
def extract(self, file_id, format=None):
1026
"""Extract a subtree from this tree.
1028
A new branch will be created, relative to the path for this tree.
1032
segments = osutils.splitpath(path)
1033
transport = self.branch.bzrdir.root_transport
1034
for name in segments:
1035
transport = transport.clone(name)
1036
transport.ensure_base()
1039
sub_path = self.id2path(file_id)
1040
branch_transport = mkdirs(sub_path)
1042
format = self.bzrdir.cloning_metadir()
1043
branch_transport.ensure_base()
1044
branch_bzrdir = format.initialize_on_transport(branch_transport)
1046
repo = branch_bzrdir.find_repository()
1047
except errors.NoRepositoryPresent:
1048
repo = branch_bzrdir.create_repository()
1049
if not repo.supports_rich_root():
1050
raise errors.RootNotRich()
1051
new_branch = branch_bzrdir.create_branch()
1052
new_branch.pull(self.branch)
1053
for parent_id in self.get_parent_ids():
1054
new_branch.fetch(self.branch, parent_id)
1055
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1056
if tree_transport.base != branch_transport.base:
1057
tree_bzrdir = format.initialize_on_transport(tree_transport)
1058
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1060
tree_bzrdir = branch_bzrdir
1061
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1062
wt.set_parent_ids(self.get_parent_ids())
1063
my_inv = self.inventory
1064
child_inv = Inventory(root_id=None)
1065
new_root = my_inv[file_id]
1066
my_inv.remove_recursive_id(file_id)
1067
new_root.parent_id = None
1068
child_inv.add(new_root)
1069
self._write_inventory(my_inv)
1070
wt._write_inventory(child_inv)
1073
def _serialize(self, inventory, out_file):
1074
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1077
def _deserialize(selt, in_file):
1078
return xml5.serializer_v5.read_inventory(in_file)
1081
"""Write the in memory inventory to disk."""
1082
# TODO: Maybe this should only write on dirty ?
1083
if self._control_files._lock_mode != 'w':
1084
raise errors.NotWriteLocked(self)
1086
self._serialize(self._inventory, sio)
1088
self._transport.put_file('inventory', sio,
1089
mode=self._control_files._file_mode)
1090
self._inventory_is_modified = False
1092
def _kind(self, relpath):
1093
return osutils.file_kind(self.abspath(relpath))
1095
def list_files(self, include_root=False):
1096
"""Recursively list all files as (path, class, kind, id, entry).
1098
Lists, but does not descend into unversioned directories.
1100
This does not include files that have been deleted in this
1103
Skips the control directory.
1105
# list_files is an iterator, so @needs_read_lock doesn't work properly
1106
# with it. So callers should be careful to always read_lock the tree.
1107
if not self.is_locked():
1108
raise errors.ObjectNotLocked(self)
1110
inv = self.inventory
1111
if include_root is True:
1112
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1113
# Convert these into local objects to save lookup times
1114
pathjoin = osutils.pathjoin
1115
file_kind = self._kind
1117
# transport.base ends in a slash, we want the piece
1118
# between the last two slashes
1119
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1121
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1123
# directory file_id, relative path, absolute path, reverse sorted children
1124
children = os.listdir(self.basedir)
1126
# jam 20060527 The kernel sized tree seems equivalent whether we
1127
# use a deque and popleft to keep them sorted, or if we use a plain
1128
# list and just reverse() them.
1129
children = collections.deque(children)
1130
stack = [(inv.root.file_id, u'', self.basedir, children)]
1132
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1135
f = children.popleft()
1136
## TODO: If we find a subdirectory with its own .bzr
1137
## directory, then that is a separate tree and we
1138
## should exclude it.
1140
# the bzrdir for this tree
1141
if transport_base_dir == f:
1144
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1145
# and 'f' doesn't begin with one, we can do a string op, rather
1146
# than the checks of pathjoin(), all relative paths will have an extra slash
1148
fp = from_dir_relpath + '/' + f
1151
fap = from_dir_abspath + '/' + f
1153
f_ie = inv.get_child(from_dir_id, f)
1156
elif self.is_ignored(fp[1:]):
1159
# we may not have found this file, because of a unicode issue
1160
f_norm, can_access = osutils.normalized_filename(f)
1161
if f == f_norm or not can_access:
1162
# No change, so treat this file normally
1165
# this file can be accessed by a normalized path
1166
# check again if it is versioned
1167
# these lines are repeated here for performance
1169
fp = from_dir_relpath + '/' + f
1170
fap = from_dir_abspath + '/' + f
1171
f_ie = inv.get_child(from_dir_id, f)
1174
elif self.is_ignored(fp[1:]):
1181
# make a last minute entry
1183
yield fp[1:], c, fk, f_ie.file_id, f_ie
1186
yield fp[1:], c, fk, None, fk_entries[fk]()
1188
yield fp[1:], c, fk, None, TreeEntry()
1191
if fk != 'directory':
1194
# But do this child first
1195
new_children = os.listdir(fap)
1197
new_children = collections.deque(new_children)
1198
stack.append((f_ie.file_id, fp, fap, new_children))
1199
# Break out of inner loop,
1200
# so that we start outer loop with child
1203
# if we finished all children, pop it off the stack
1206
@needs_tree_write_lock
1207
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1210
to_dir must exist in the inventory.
1212
If to_dir exists and is a directory, the files are moved into
1213
it, keeping their old names.
1215
Note that to_dir is only the last component of the new name;
1216
this doesn't change the directory.
1218
For each entry in from_paths the move mode will be determined
1221
The first mode moves the file in the filesystem and updates the
1222
inventory. The second mode only updates the inventory without
1223
touching the file on the filesystem. This is the new mode introduced
1226
move uses the second mode if 'after == True' and the target is not
1227
versioned but present in the working tree.
1229
move uses the second mode if 'after == False' and the source is
1230
versioned but no longer in the working tree, and the target is not
1231
versioned but present in the working tree.
1233
move uses the first mode if 'after == False' and the source is
1234
versioned and present in the working tree, and the target is not
1235
versioned and not present in the working tree.
1237
Everything else results in an error.
1239
This returns a list of (from_path, to_path) pairs for each
1240
entry that is moved.
1245
# check for deprecated use of signature
1247
to_dir = kwargs.get('to_name', None)
1249
raise TypeError('You must supply a target directory')
1251
symbol_versioning.warn('The parameter to_name was deprecated'
1252
' in version 0.13. Use to_dir instead',
1255
# check destination directory
1256
if isinstance(from_paths, basestring):
1258
inv = self.inventory
1259
to_abs = self.abspath(to_dir)
1260
if not isdir(to_abs):
1261
raise errors.BzrMoveFailedError('',to_dir,
1262
errors.NotADirectory(to_abs))
1263
if not self.has_filename(to_dir):
1264
raise errors.BzrMoveFailedError('',to_dir,
1265
errors.NotInWorkingDirectory(to_dir))
1266
to_dir_id = inv.path2id(to_dir)
1267
if to_dir_id is None:
1268
raise errors.BzrMoveFailedError('',to_dir,
1269
errors.NotVersionedError(path=str(to_dir)))
1271
to_dir_ie = inv[to_dir_id]
1272
if to_dir_ie.kind != 'directory':
1273
raise errors.BzrMoveFailedError('',to_dir,
1274
errors.NotADirectory(to_abs))
1276
# create rename entries and tuples
1277
for from_rel in from_paths:
1278
from_tail = splitpath(from_rel)[-1]
1279
from_id = inv.path2id(from_rel)
1281
raise errors.BzrMoveFailedError(from_rel,to_dir,
1282
errors.NotVersionedError(path=str(from_rel)))
1284
from_entry = inv[from_id]
1285
from_parent_id = from_entry.parent_id
1286
to_rel = pathjoin(to_dir, from_tail)
1287
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1289
from_tail=from_tail,
1290
from_parent_id=from_parent_id,
1291
to_rel=to_rel, to_tail=from_tail,
1292
to_parent_id=to_dir_id)
1293
rename_entries.append(rename_entry)
1294
rename_tuples.append((from_rel, to_rel))
1296
# determine which move mode to use. checks also for movability
1297
rename_entries = self._determine_mv_mode(rename_entries, after)
1299
original_modified = self._inventory_is_modified
1302
self._inventory_is_modified = True
1303
self._move(rename_entries)
1305
# restore the inventory on error
1306
self._inventory_is_modified = original_modified
1308
self._write_inventory(inv)
1309
return rename_tuples
1311
def _determine_mv_mode(self, rename_entries, after=False):
1312
"""Determines for each from-to pair if both inventory and working tree
1313
or only the inventory has to be changed.
1315
Also does basic plausability tests.
1317
inv = self.inventory
1319
for rename_entry in rename_entries:
1320
# store to local variables for easier reference
1321
from_rel = rename_entry.from_rel
1322
from_id = rename_entry.from_id
1323
to_rel = rename_entry.to_rel
1324
to_id = inv.path2id(to_rel)
1325
only_change_inv = False
1327
# check the inventory for source and destination
1329
raise errors.BzrMoveFailedError(from_rel,to_rel,
1330
errors.NotVersionedError(path=str(from_rel)))
1331
if to_id is not None:
1332
raise errors.BzrMoveFailedError(from_rel,to_rel,
1333
errors.AlreadyVersionedError(path=str(to_rel)))
1335
# try to determine the mode for rename (only change inv or change
1336
# inv and file system)
1338
if not self.has_filename(to_rel):
1339
raise errors.BzrMoveFailedError(from_id,to_rel,
1340
errors.NoSuchFile(path=str(to_rel),
1341
extra="New file has not been created yet"))
1342
only_change_inv = True
1343
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1344
only_change_inv = True
1345
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1346
only_change_inv = False
1347
elif (not self.case_sensitive
1348
and from_rel.lower() == to_rel.lower()
1349
and self.has_filename(from_rel)):
1350
only_change_inv = False
1352
# something is wrong, so lets determine what exactly
1353
if not self.has_filename(from_rel) and \
1354
not self.has_filename(to_rel):
1355
raise errors.BzrRenameFailedError(from_rel,to_rel,
1356
errors.PathsDoNotExist(paths=(str(from_rel),
1359
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1360
rename_entry.only_change_inv = only_change_inv
1361
return rename_entries
1363
def _move(self, rename_entries):
1364
"""Moves a list of files.
1366
Depending on the value of the flag 'only_change_inv', the
1367
file will be moved on the file system or not.
1369
inv = self.inventory
1372
for entry in rename_entries:
1374
self._move_entry(entry)
1376
self._rollback_move(moved)
1380
def _rollback_move(self, moved):
1381
"""Try to rollback a previous move in case of an filesystem error."""
1382
inv = self.inventory
1385
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1386
entry.to_tail, entry.to_parent_id, entry.from_rel,
1387
entry.from_tail, entry.from_parent_id,
1388
entry.only_change_inv))
1389
except errors.BzrMoveFailedError, e:
1390
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1391
" The working tree is in an inconsistent state."
1392
" Please consider doing a 'bzr revert'."
1393
" Error message is: %s" % e)
1395
def _move_entry(self, entry):
1396
inv = self.inventory
1397
from_rel_abs = self.abspath(entry.from_rel)
1398
to_rel_abs = self.abspath(entry.to_rel)
1399
if from_rel_abs == to_rel_abs:
1400
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1401
"Source and target are identical.")
1403
if not entry.only_change_inv:
1405
osutils.rename(from_rel_abs, to_rel_abs)
1407
raise errors.BzrMoveFailedError(entry.from_rel,
1409
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1411
@needs_tree_write_lock
1412
def rename_one(self, from_rel, to_rel, after=False):
1415
This can change the directory or the filename or both.
1417
rename_one has several 'modes' to work. First, it can rename a physical
1418
file and change the file_id. That is the normal mode. Second, it can
1419
only change the file_id without touching any physical file. This is
1420
the new mode introduced in version 0.15.
1422
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1423
versioned but present in the working tree.
1425
rename_one uses the second mode if 'after == False' and 'from_rel' is
1426
versioned but no longer in the working tree, and 'to_rel' is not
1427
versioned but present in the working tree.
1429
rename_one uses the first mode if 'after == False' and 'from_rel' is
1430
versioned and present in the working tree, and 'to_rel' is not
1431
versioned and not present in the working tree.
1433
Everything else results in an error.
1435
inv = self.inventory
1438
# create rename entries and tuples
1439
from_tail = splitpath(from_rel)[-1]
1440
from_id = inv.path2id(from_rel)
1442
raise errors.BzrRenameFailedError(from_rel,to_rel,
1443
errors.NotVersionedError(path=str(from_rel)))
1444
from_entry = inv[from_id]
1445
from_parent_id = from_entry.parent_id
1446
to_dir, to_tail = os.path.split(to_rel)
1447
to_dir_id = inv.path2id(to_dir)
1448
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1450
from_tail=from_tail,
1451
from_parent_id=from_parent_id,
1452
to_rel=to_rel, to_tail=to_tail,
1453
to_parent_id=to_dir_id)
1454
rename_entries.append(rename_entry)
1456
# determine which move mode to use. checks also for movability
1457
rename_entries = self._determine_mv_mode(rename_entries, after)
1459
# check if the target changed directory and if the target directory is
1461
if to_dir_id is None:
1462
raise errors.BzrMoveFailedError(from_rel,to_rel,
1463
errors.NotVersionedError(path=str(to_dir)))
1465
# all checks done. now we can continue with our actual work
1466
mutter('rename_one:\n'
1471
' to_dir_id {%s}\n',
1472
from_id, from_rel, to_rel, to_dir, to_dir_id)
1474
self._move(rename_entries)
1475
self._write_inventory(inv)
1477
class _RenameEntry(object):
1478
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1479
to_rel, to_tail, to_parent_id, only_change_inv=False):
1480
self.from_rel = from_rel
1481
self.from_id = from_id
1482
self.from_tail = from_tail
1483
self.from_parent_id = from_parent_id
1484
self.to_rel = to_rel
1485
self.to_tail = to_tail
1486
self.to_parent_id = to_parent_id
1487
self.only_change_inv = only_change_inv
1491
"""Return all unknown files.
1493
These are files in the working directory that are not versioned or
1494
control files or ignored.
1496
# force the extras method to be fully executed before returning, to
1497
# prevent race conditions with the lock
1499
[subp for subp in self.extras() if not self.is_ignored(subp)])
1501
@needs_tree_write_lock
1502
def unversion(self, file_ids):
1503
"""Remove the file ids in file_ids from the current versioned set.
1505
When a file_id is unversioned, all of its children are automatically
1508
:param file_ids: The file ids to stop versioning.
1509
:raises: NoSuchId if any fileid is not currently versioned.
1511
for file_id in file_ids:
1512
if self._inventory.has_id(file_id):
1513
self._inventory.remove_recursive_id(file_id)
1515
raise errors.NoSuchId(self, file_id)
1517
# in the future this should just set a dirty bit to wait for the
1518
# final unlock. However, until all methods of workingtree start
1519
# with the current in -memory inventory rather than triggering
1520
# a read, it is more complex - we need to teach read_inventory
1521
# to know when to read, and when to not read first... and possibly
1522
# to save first when the in memory one may be corrupted.
1523
# so for now, we just only write it if it is indeed dirty.
1525
self._write_inventory(self._inventory)
1527
def _iter_conflicts(self):
1529
for info in self.list_files():
1531
stem = get_conflicted_stem(path)
1534
if stem not in conflicted:
1535
conflicted.add(stem)
1539
def pull(self, source, overwrite=False, stop_revision=None,
1540
change_reporter=None, possible_transports=None):
1541
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1544
pp = ProgressPhase("Pull phase", 2, top_pb)
1546
old_revision_info = self.branch.last_revision_info()
1547
basis_tree = self.basis_tree()
1548
count = self.branch.pull(source, overwrite, stop_revision,
1549
possible_transports=possible_transports)
1550
new_revision_info = self.branch.last_revision_info()
1551
if new_revision_info != old_revision_info:
1553
repository = self.branch.repository
1554
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1555
basis_tree.lock_read()
1557
new_basis_tree = self.branch.basis_tree()
1564
change_reporter=change_reporter)
1565
if (basis_tree.inventory.root is None and
1566
new_basis_tree.inventory.root is not None):
1567
self.set_root_id(new_basis_tree.get_root_id())
1571
# TODO - dedup parents list with things merged by pull ?
1572
# reuse the revisiontree we merged against to set the new
1574
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1575
# we have to pull the merge trees out again, because
1576
# merge_inner has set the ids. - this corner is not yet
1577
# layered well enough to prevent double handling.
1578
# XXX TODO: Fix the double handling: telling the tree about
1579
# the already known parent data is wasteful.
1580
merges = self.get_parent_ids()[1:]
1581
parent_trees.extend([
1582
(parent, repository.revision_tree(parent)) for
1584
self.set_parent_trees(parent_trees)
1591
def put_file_bytes_non_atomic(self, file_id, bytes):
1592
"""See MutableTree.put_file_bytes_non_atomic."""
1593
stream = file(self.id2abspath(file_id), 'wb')
1598
# TODO: update the hashcache here ?
1601
"""Yield all unversioned files in this WorkingTree.
1603
If there are any unversioned directories then only the directory is
1604
returned, not all its children. But if there are unversioned files
1605
under a versioned subdirectory, they are returned.
1607
Currently returned depth-first, sorted by name within directories.
1608
This is the same order used by 'osutils.walkdirs'.
1610
## TODO: Work from given directory downwards
1611
for path, dir_entry in self.inventory.directories():
1612
# mutter("search for unknowns in %r", path)
1613
dirabs = self.abspath(path)
1614
if not isdir(dirabs):
1615
# e.g. directory deleted
1619
for subf in os.listdir(dirabs):
1622
if subf not in dir_entry.children:
1625
can_access) = osutils.normalized_filename(subf)
1626
except UnicodeDecodeError:
1627
path_os_enc = path.encode(osutils._fs_enc)
1628
relpath = path_os_enc + '/' + subf
1629
raise errors.BadFilenameEncoding(relpath,
1631
if subf_norm != subf and can_access:
1632
if subf_norm not in dir_entry.children:
1633
fl.append(subf_norm)
1639
subp = pathjoin(path, subf)
1642
def ignored_files(self):
1643
"""Yield list of PATH, IGNORE_PATTERN"""
1644
for subp in self.extras():
1645
pat = self.is_ignored(subp)
1649
def get_ignore_list(self):
1650
"""Return list of ignore patterns.
1652
Cached in the Tree object after the first call.
1654
ignoreset = getattr(self, '_ignoreset', None)
1655
if ignoreset is not None:
1658
ignore_globs = set()
1659
ignore_globs.update(ignores.get_runtime_ignores())
1660
ignore_globs.update(ignores.get_user_ignores())
1661
if self.has_filename(bzrlib.IGNORE_FILENAME):
1662
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1664
ignore_globs.update(ignores.parse_ignore_file(f))
1667
self._ignoreset = ignore_globs
1670
def _flush_ignore_list_cache(self):
1671
"""Resets the cached ignore list to force a cache rebuild."""
1672
self._ignoreset = None
1673
self._ignoreglobster = None
1675
def is_ignored(self, filename):
1676
r"""Check whether the filename matches an ignore pattern.
1678
Patterns containing '/' or '\' need to match the whole path;
1679
others match against only the last component.
1681
If the file is ignored, returns the pattern which caused it to
1682
be ignored, otherwise None. So this can simply be used as a
1683
boolean if desired."""
1684
if getattr(self, '_ignoreglobster', None) is None:
1685
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1686
return self._ignoreglobster.match(filename)
1688
def kind(self, file_id):
1689
return file_kind(self.id2abspath(file_id))
1691
def stored_kind(self, file_id):
1692
"""See Tree.stored_kind"""
1693
return self.inventory[file_id].kind
1695
def _comparison_data(self, entry, path):
1696
abspath = self.abspath(path)
1698
stat_value = os.lstat(abspath)
1700
if getattr(e, 'errno', None) == errno.ENOENT:
1707
mode = stat_value.st_mode
1708
kind = osutils.file_kind_from_stat_mode(mode)
1709
if not supports_executable():
1710
executable = entry is not None and entry.executable
1712
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1713
return kind, executable, stat_value
1715
def _file_size(self, entry, stat_value):
1716
return stat_value.st_size
1718
def last_revision(self):
1719
"""Return the last revision of the branch for this tree.
1721
This format tree does not support a separate marker for last-revision
1722
compared to the branch.
1724
See MutableTree.last_revision
1726
return self._last_revision()
1729
def _last_revision(self):
1730
"""helper for get_parent_ids."""
1731
return _mod_revision.ensure_null(self.branch.last_revision())
1733
def is_locked(self):
1734
return self._control_files.is_locked()
1736
def _must_be_locked(self):
1737
if not self.is_locked():
1738
raise errors.ObjectNotLocked(self)
1740
def lock_read(self):
1741
"""See Branch.lock_read, and WorkingTree.unlock."""
1742
if not self.is_locked():
1744
self.branch.lock_read()
1746
return self._control_files.lock_read()
1748
self.branch.unlock()
1751
def lock_tree_write(self):
1752
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1753
if not self.is_locked():
1755
self.branch.lock_read()
1757
return self._control_files.lock_write()
1759
self.branch.unlock()
1762
def lock_write(self):
1763
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1764
if not self.is_locked():
1766
self.branch.lock_write()
1768
return self._control_files.lock_write()
1770
self.branch.unlock()
1773
def get_physical_lock_status(self):
1774
return self._control_files.get_physical_lock_status()
1776
def _basis_inventory_name(self):
1777
return 'basis-inventory-cache'
1779
def _reset_data(self):
1780
"""Reset transient data that cannot be revalidated."""
1781
self._inventory_is_modified = False
1782
result = self._deserialize(self._transport.get('inventory'))
1783
self._set_inventory(result, dirty=False)
1785
@needs_tree_write_lock
1786
def set_last_revision(self, new_revision):
1787
"""Change the last revision in the working tree."""
1788
if self._change_last_revision(new_revision):
1789
self._cache_basis_inventory(new_revision)
1791
def _change_last_revision(self, new_revision):
1792
"""Template method part of set_last_revision to perform the change.
1794
This is used to allow WorkingTree3 instances to not affect branch
1795
when their last revision is set.
1797
if _mod_revision.is_null(new_revision):
1798
self.branch.set_revision_history([])
1801
self.branch.generate_revision_history(new_revision)
1802
except errors.NoSuchRevision:
1803
# not present in the repo - dont try to set it deeper than the tip
1804
self.branch.set_revision_history([new_revision])
1807
def _write_basis_inventory(self, xml):
1808
"""Write the basis inventory XML to the basis-inventory file"""
1809
path = self._basis_inventory_name()
1811
self._transport.put_file(path, sio,
1812
mode=self._control_files._file_mode)
1814
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1815
"""Create the text that will be saved in basis-inventory"""
1816
inventory.revision_id = revision_id
1817
return xml7.serializer_v7.write_inventory_to_string(inventory)
1819
def _cache_basis_inventory(self, new_revision):
1820
"""Cache new_revision as the basis inventory."""
1821
# TODO: this should allow the ready-to-use inventory to be passed in,
1822
# as commit already has that ready-to-use [while the format is the
1825
# this double handles the inventory - unpack and repack -
1826
# but is easier to understand. We can/should put a conditional
1827
# in here based on whether the inventory is in the latest format
1828
# - perhaps we should repack all inventories on a repository
1830
# the fast path is to copy the raw xml from the repository. If the
1831
# xml contains 'revision_id="', then we assume the right
1832
# revision_id is set. We must check for this full string, because a
1833
# root node id can legitimately look like 'revision_id' but cannot
1835
xml = self.branch.repository.get_inventory_xml(new_revision)
1836
firstline = xml.split('\n', 1)[0]
1837
if (not 'revision_id="' in firstline or
1838
'format="7"' not in firstline):
1839
inv = self.branch.repository.deserialise_inventory(
1841
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1842
self._write_basis_inventory(xml)
1843
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1846
def read_basis_inventory(self):
1847
"""Read the cached basis inventory."""
1848
path = self._basis_inventory_name()
1849
return self._transport.get_bytes(path)
1852
def read_working_inventory(self):
1853
"""Read the working inventory.
1855
:raises errors.InventoryModified: read_working_inventory will fail
1856
when the current in memory inventory has been modified.
1858
# conceptually this should be an implementation detail of the tree.
1859
# XXX: Deprecate this.
1860
# ElementTree does its own conversion from UTF-8, so open in
1862
if self._inventory_is_modified:
1863
raise errors.InventoryModified(self)
1864
result = self._deserialize(self._transport.get('inventory'))
1865
self._set_inventory(result, dirty=False)
1868
@needs_tree_write_lock
1869
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1871
"""Remove nominated files from the working inventory.
1873
:files: File paths relative to the basedir.
1874
:keep_files: If true, the files will also be kept.
1875
:force: Delete files and directories, even if they are changed and
1876
even if the directories are not empty.
1878
if isinstance(files, basestring):
1884
unknown_nested_files=set()
1886
def recurse_directory_to_add_files(directory):
1887
# Recurse directory and add all files
1888
# so we can check if they have changed.
1889
for parent_info, file_infos in\
1890
self.walkdirs(directory):
1891
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1892
# Is it versioned or ignored?
1893
if self.path2id(relpath) or self.is_ignored(relpath):
1894
# Add nested content for deletion.
1895
new_files.add(relpath)
1897
# Files which are not versioned and not ignored
1898
# should be treated as unknown.
1899
unknown_nested_files.add((relpath, None, kind))
1901
for filename in files:
1902
# Get file name into canonical form.
1903
abspath = self.abspath(filename)
1904
filename = self.relpath(abspath)
1905
if len(filename) > 0:
1906
new_files.add(filename)
1907
recurse_directory_to_add_files(filename)
1909
files = list(new_files)
1912
return # nothing to do
1914
# Sort needed to first handle directory content before the directory
1915
files.sort(reverse=True)
1917
# Bail out if we are going to delete files we shouldn't
1918
if not keep_files and not force:
1919
has_changed_files = len(unknown_nested_files) > 0
1920
if not has_changed_files:
1921
for (file_id, path, content_change, versioned, parent_id, name,
1922
kind, executable) in self.iter_changes(self.basis_tree(),
1923
include_unchanged=True, require_versioned=False,
1924
want_unversioned=True, specific_files=files):
1925
if versioned == (False, False):
1926
# The record is unknown ...
1927
if not self.is_ignored(path[1]):
1928
# ... but not ignored
1929
has_changed_files = True
1931
elif content_change and (kind[1] is not None):
1932
# Versioned and changed, but not deleted
1933
has_changed_files = True
1936
if has_changed_files:
1937
# Make delta show ALL applicable changes in error message.
1938
tree_delta = self.changes_from(self.basis_tree(),
1939
require_versioned=False, want_unversioned=True,
1940
specific_files=files)
1941
for unknown_file in unknown_nested_files:
1942
if unknown_file not in tree_delta.unversioned:
1943
tree_delta.unversioned.extend((unknown_file,))
1944
raise errors.BzrRemoveChangedFilesError(tree_delta)
1946
# Build inv_delta and delete files where applicaple,
1947
# do this before any modifications to inventory.
1949
fid = self.path2id(f)
1952
message = "%s is not versioned." % (f,)
1955
# having removed it, it must be either ignored or unknown
1956
if self.is_ignored(f):
1960
textui.show_status(new_status, self.kind(fid), f,
1963
inv_delta.append((f, None, fid, None))
1964
message = "removed %s" % (f,)
1967
abs_path = self.abspath(f)
1968
if osutils.lexists(abs_path):
1969
if (osutils.isdir(abs_path) and
1970
len(os.listdir(abs_path)) > 0):
1972
osutils.rmtree(abs_path)
1974
message = "%s is not an empty directory "\
1975
"and won't be deleted." % (f,)
1977
osutils.delete_any(abs_path)
1978
message = "deleted %s" % (f,)
1979
elif message is not None:
1980
# Only care if we haven't done anything yet.
1981
message = "%s does not exist." % (f,)
1983
# Print only one message (if any) per file.
1984
if message is not None:
1986
self.apply_inventory_delta(inv_delta)
1988
@needs_tree_write_lock
1989
def revert(self, filenames=None, old_tree=None, backups=True,
1990
pb=DummyProgress(), report_changes=False):
1991
from bzrlib.conflicts import resolve
1994
symbol_versioning.warn('Using [] to revert all files is deprecated'
1995
' as of bzr 0.91. Please use None (the default) instead.',
1996
DeprecationWarning, stacklevel=2)
1997
if old_tree is None:
1998
basis_tree = self.basis_tree()
1999
basis_tree.lock_read()
2000
old_tree = basis_tree
2004
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2006
if filenames is None and len(self.get_parent_ids()) > 1:
2008
last_revision = self.last_revision()
2009
if last_revision != NULL_REVISION:
2010
if basis_tree is None:
2011
basis_tree = self.basis_tree()
2012
basis_tree.lock_read()
2013
parent_trees.append((last_revision, basis_tree))
2014
self.set_parent_trees(parent_trees)
2017
resolve(self, filenames, ignore_misses=True, recursive=True)
2019
if basis_tree is not None:
2023
def revision_tree(self, revision_id):
2024
"""See Tree.revision_tree.
2026
WorkingTree can supply revision_trees for the basis revision only
2027
because there is only one cached inventory in the bzr directory.
2029
if revision_id == self.last_revision():
2031
xml = self.read_basis_inventory()
2032
except errors.NoSuchFile:
2036
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2037
# dont use the repository revision_tree api because we want
2038
# to supply the inventory.
2039
if inv.revision_id == revision_id:
2040
return revisiontree.RevisionTree(self.branch.repository,
2042
except errors.BadInventoryFormat:
2044
# raise if there was no inventory, or if we read the wrong inventory.
2045
raise errors.NoSuchRevisionInTree(self, revision_id)
2047
# XXX: This method should be deprecated in favour of taking in a proper
2048
# new Inventory object.
2049
@needs_tree_write_lock
2050
def set_inventory(self, new_inventory_list):
2051
from bzrlib.inventory import (Inventory,
2056
inv = Inventory(self.get_root_id())
2057
for path, file_id, parent, kind in new_inventory_list:
2058
name = os.path.basename(path)
2061
# fixme, there should be a factory function inv,add_??
2062
if kind == 'directory':
2063
inv.add(InventoryDirectory(file_id, name, parent))
2064
elif kind == 'file':
2065
inv.add(InventoryFile(file_id, name, parent))
2066
elif kind == 'symlink':
2067
inv.add(InventoryLink(file_id, name, parent))
2069
raise errors.BzrError("unknown kind %r" % kind)
2070
self._write_inventory(inv)
2072
@needs_tree_write_lock
2073
def set_root_id(self, file_id):
2074
"""Set the root id for this tree."""
2078
'WorkingTree.set_root_id with fileid=None')
2079
file_id = osutils.safe_file_id(file_id)
2080
self._set_root_id(file_id)
2082
def _set_root_id(self, file_id):
2083
"""Set the root id for this tree, in a format specific manner.
2085
:param file_id: The file id to assign to the root. It must not be
2086
present in the current inventory or an error will occur. It must
2087
not be None, but rather a valid file id.
2089
inv = self._inventory
2090
orig_root_id = inv.root.file_id
2091
# TODO: it might be nice to exit early if there was nothing
2092
# to do, saving us from trigger a sync on unlock.
2093
self._inventory_is_modified = True
2094
# we preserve the root inventory entry object, but
2095
# unlinkit from the byid index
2096
del inv._byid[inv.root.file_id]
2097
inv.root.file_id = file_id
2098
# and link it into the index with the new changed id.
2099
inv._byid[inv.root.file_id] = inv.root
2100
# and finally update all children to reference the new id.
2101
# XXX: this should be safe to just look at the root.children
2102
# list, not the WHOLE INVENTORY.
2105
if entry.parent_id == orig_root_id:
2106
entry.parent_id = inv.root.file_id
2109
"""See Branch.unlock.
2111
WorkingTree locking just uses the Branch locking facilities.
2112
This is current because all working trees have an embedded branch
2113
within them. IF in the future, we were to make branch data shareable
2114
between multiple working trees, i.e. via shared storage, then we
2115
would probably want to lock both the local tree, and the branch.
2117
raise NotImplementedError(self.unlock)
2119
def update(self, change_reporter=None, possible_transports=None):
2120
"""Update a working tree along its branch.
2122
This will update the branch if its bound too, which means we have
2123
multiple trees involved:
2125
- The new basis tree of the master.
2126
- The old basis tree of the branch.
2127
- The old basis tree of the working tree.
2128
- The current working tree state.
2130
Pathologically, all three may be different, and non-ancestors of each
2131
other. Conceptually we want to:
2133
- Preserve the wt.basis->wt.state changes
2134
- Transform the wt.basis to the new master basis.
2135
- Apply a merge of the old branch basis to get any 'local' changes from
2137
- Restore the wt.basis->wt.state changes.
2139
There isn't a single operation at the moment to do that, so we:
2140
- Merge current state -> basis tree of the master w.r.t. the old tree
2142
- Do a 'normal' merge of the old branch basis if it is relevant.
2144
if self.branch.get_bound_location() is not None:
2146
update_branch = True
2148
self.lock_tree_write()
2149
update_branch = False
2152
old_tip = self.branch.update(possible_transports)
2155
return self._update_tree(old_tip, change_reporter)
2159
@needs_tree_write_lock
2160
def _update_tree(self, old_tip=None, change_reporter=None):
2161
"""Update a tree to the master branch.
2163
:param old_tip: if supplied, the previous tip revision the branch,
2164
before it was changed to the master branch's tip.
2166
# here if old_tip is not None, it is the old tip of the branch before
2167
# it was updated from the master branch. This should become a pending
2168
# merge in the working tree to preserve the user existing work. we
2169
# cant set that until we update the working trees last revision to be
2170
# one from the new branch, because it will just get absorbed by the
2171
# parent de-duplication logic.
2173
# We MUST save it even if an error occurs, because otherwise the users
2174
# local work is unreferenced and will appear to have been lost.
2178
last_rev = self.get_parent_ids()[0]
2180
last_rev = _mod_revision.NULL_REVISION
2181
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2182
# merge tree state up to new branch tip.
2183
basis = self.basis_tree()
2186
to_tree = self.branch.basis_tree()
2187
if basis.inventory.root is None:
2188
self.set_root_id(to_tree.get_root_id())
2190
result += merge.merge_inner(
2195
change_reporter=change_reporter)
2198
# TODO - dedup parents list with things merged by pull ?
2199
# reuse the tree we've updated to to set the basis:
2200
parent_trees = [(self.branch.last_revision(), to_tree)]
2201
merges = self.get_parent_ids()[1:]
2202
# Ideally we ask the tree for the trees here, that way the working
2203
# tree can decide whether to give us teh entire tree or give us a
2204
# lazy initialised tree. dirstate for instance will have the trees
2205
# in ram already, whereas a last-revision + basis-inventory tree
2206
# will not, but also does not need them when setting parents.
2207
for parent in merges:
2208
parent_trees.append(
2209
(parent, self.branch.repository.revision_tree(parent)))
2210
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2211
parent_trees.append(
2212
(old_tip, self.branch.repository.revision_tree(old_tip)))
2213
self.set_parent_trees(parent_trees)
2214
last_rev = parent_trees[0][0]
2216
# the working tree had the same last-revision as the master
2217
# branch did. We may still have pivot local work from the local
2218
# branch into old_tip:
2219
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2220
self.add_parent_tree_id(old_tip)
2221
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2222
and old_tip != last_rev):
2223
# our last revision was not the prior branch last revision
2224
# and we have converted that last revision to a pending merge.
2225
# base is somewhere between the branch tip now
2226
# and the now pending merge
2228
# Since we just modified the working tree and inventory, flush out
2229
# the current state, before we modify it again.
2230
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2231
# requires it only because TreeTransform directly munges the
2232
# inventory and calls tree._write_inventory(). Ultimately we
2233
# should be able to remove this extra flush.
2235
graph = self.branch.repository.get_graph()
2236
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2238
base_tree = self.branch.repository.revision_tree(base_rev_id)
2239
other_tree = self.branch.repository.revision_tree(old_tip)
2240
result += merge.merge_inner(
2245
change_reporter=change_reporter)
2248
def _write_hashcache_if_dirty(self):
2249
"""Write out the hashcache if it is dirty."""
2250
if self._hashcache.needs_write:
2252
self._hashcache.write()
2254
if e.errno not in (errno.EPERM, errno.EACCES):
2256
# TODO: jam 20061219 Should this be a warning? A single line
2257
# warning might be sufficient to let the user know what
2259
mutter('Could not write hashcache for %s\nError: %s',
2260
self._hashcache.cache_file_name(), e)
2262
@needs_tree_write_lock
2263
def _write_inventory(self, inv):
2264
"""Write inventory as the current inventory."""
2265
self._set_inventory(inv, dirty=True)
2268
def set_conflicts(self, arg):
2269
raise errors.UnsupportedOperation(self.set_conflicts, self)
2271
def add_conflicts(self, arg):
2272
raise errors.UnsupportedOperation(self.add_conflicts, self)
2275
def conflicts(self):
2276
conflicts = _mod_conflicts.ConflictList()
2277
for conflicted in self._iter_conflicts():
2280
if file_kind(self.abspath(conflicted)) != "file":
2282
except errors.NoSuchFile:
2285
for suffix in ('.THIS', '.OTHER'):
2287
kind = file_kind(self.abspath(conflicted+suffix))
2290
except errors.NoSuchFile:
2294
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2295
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2297
file_id=self.path2id(conflicted)))
2300
def walkdirs(self, prefix=""):
2301
"""Walk the directories of this tree.
2303
returns a generator which yields items in the form:
2304
((curren_directory_path, fileid),
2305
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2308
This API returns a generator, which is only valid during the current
2309
tree transaction - within a single lock_read or lock_write duration.
2311
If the tree is not locked, it may cause an error to be raised,
2312
depending on the tree implementation.
2314
disk_top = self.abspath(prefix)
2315
if disk_top.endswith('/'):
2316
disk_top = disk_top[:-1]
2317
top_strip_len = len(disk_top) + 1
2318
inventory_iterator = self._walkdirs(prefix)
2319
disk_iterator = osutils.walkdirs(disk_top, prefix)
2321
current_disk = disk_iterator.next()
2322
disk_finished = False
2324
if not (e.errno == errno.ENOENT or
2325
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2328
disk_finished = True
2330
current_inv = inventory_iterator.next()
2331
inv_finished = False
2332
except StopIteration:
2335
while not inv_finished or not disk_finished:
2337
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2338
cur_disk_dir_content) = current_disk
2340
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2341
cur_disk_dir_content) = ((None, None), None)
2342
if not disk_finished:
2343
# strip out .bzr dirs
2344
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2345
len(cur_disk_dir_content) > 0):
2346
# osutils.walkdirs can be made nicer -
2347
# yield the path-from-prefix rather than the pathjoined
2349
bzrdir_loc = bisect_left(cur_disk_dir_content,
2351
if (bzrdir_loc < len(cur_disk_dir_content)
2352
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2353
# we dont yield the contents of, or, .bzr itself.
2354
del cur_disk_dir_content[bzrdir_loc]
2356
# everything is unknown
2359
# everything is missing
2362
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2364
# disk is before inventory - unknown
2365
dirblock = [(relpath, basename, kind, stat, None, None) for
2366
relpath, basename, kind, stat, top_path in
2367
cur_disk_dir_content]
2368
yield (cur_disk_dir_relpath, None), dirblock
2370
current_disk = disk_iterator.next()
2371
except StopIteration:
2372
disk_finished = True
2374
# inventory is before disk - missing.
2375
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2376
for relpath, basename, dkind, stat, fileid, kind in
2378
yield (current_inv[0][0], current_inv[0][1]), dirblock
2380
current_inv = inventory_iterator.next()
2381
except StopIteration:
2384
# versioned present directory
2385
# merge the inventory and disk data together
2387
for relpath, subiterator in itertools.groupby(sorted(
2388
current_inv[1] + cur_disk_dir_content,
2389
key=operator.itemgetter(0)), operator.itemgetter(1)):
2390
path_elements = list(subiterator)
2391
if len(path_elements) == 2:
2392
inv_row, disk_row = path_elements
2393
# versioned, present file
2394
dirblock.append((inv_row[0],
2395
inv_row[1], disk_row[2],
2396
disk_row[3], inv_row[4],
2398
elif len(path_elements[0]) == 5:
2400
dirblock.append((path_elements[0][0],
2401
path_elements[0][1], path_elements[0][2],
2402
path_elements[0][3], None, None))
2403
elif len(path_elements[0]) == 6:
2404
# versioned, absent file.
2405
dirblock.append((path_elements[0][0],
2406
path_elements[0][1], 'unknown', None,
2407
path_elements[0][4], path_elements[0][5]))
2409
raise NotImplementedError('unreachable code')
2410
yield current_inv[0], dirblock
2412
current_inv = inventory_iterator.next()
2413
except StopIteration:
2416
current_disk = disk_iterator.next()
2417
except StopIteration:
2418
disk_finished = True
2420
def _walkdirs(self, prefix=""):
2421
"""Walk the directories of this tree.
2423
:prefix: is used as the directrory to start with.
2424
returns a generator which yields items in the form:
2425
((curren_directory_path, fileid),
2426
[(file1_path, file1_name, file1_kind, None, file1_id,
2429
_directory = 'directory'
2430
# get the root in the inventory
2431
inv = self.inventory
2432
top_id = inv.path2id(prefix)
2436
pending = [(prefix, '', _directory, None, top_id, None)]
2439
currentdir = pending.pop()
2440
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2441
top_id = currentdir[4]
2443
relroot = currentdir[0] + '/'
2446
# FIXME: stash the node in pending
2448
if entry.kind == 'directory':
2449
for name, child in entry.sorted_children():
2450
dirblock.append((relroot + name, name, child.kind, None,
2451
child.file_id, child.kind
2453
yield (currentdir[0], entry.file_id), dirblock
2454
# push the user specified dirs from dirblock
2455
for dir in reversed(dirblock):
2456
if dir[2] == _directory:
2459
@needs_tree_write_lock
2460
def auto_resolve(self):
2461
"""Automatically resolve text conflicts according to contents.
2463
Only text conflicts are auto_resolvable. Files with no conflict markers
2464
are considered 'resolved', because bzr always puts conflict markers
2465
into files that have text conflicts. The corresponding .THIS .BASE and
2466
.OTHER files are deleted, as per 'resolve'.
2467
:return: a tuple of ConflictLists: (un_resolved, resolved).
2469
un_resolved = _mod_conflicts.ConflictList()
2470
resolved = _mod_conflicts.ConflictList()
2471
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2472
for conflict in self.conflicts():
2473
if (conflict.typestring != 'text conflict' or
2474
self.kind(conflict.file_id) != 'file'):
2475
un_resolved.append(conflict)
2477
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2479
for line in my_file:
2480
if conflict_re.search(line):
2481
un_resolved.append(conflict)
2484
resolved.append(conflict)
2487
resolved.remove_files(self)
2488
self.set_conflicts(un_resolved)
2489
return un_resolved, resolved
2493
tree_basis = self.basis_tree()
2494
tree_basis.lock_read()
2496
repo_basis = self.branch.repository.revision_tree(
2497
self.last_revision())
2498
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2499
raise errors.BzrCheckError(
2500
"Mismatched basis inventory content.")
2505
def _validate(self):
2506
"""Validate internal structures.
2508
This is meant mostly for the test suite. To give it a chance to detect
2509
corruption after actions have occurred. The default implementation is a
2512
:return: None. An exception should be raised if there is an error.
2517
def _get_rules_searcher(self, default_searcher):
2518
"""See Tree._get_rules_searcher."""
2519
if self._rules_searcher is None:
2520
self._rules_searcher = super(WorkingTree,
2521
self)._get_rules_searcher(default_searcher)
2522
return self._rules_searcher
2524
def get_shelf_manager(self):
2525
"""Return the ShelfManager for this WorkingTree."""
2526
from bzrlib.shelf import ShelfManager
2527
return ShelfManager(self, self._transport)
2530
class WorkingTree2(WorkingTree):
2531
"""This is the Format 2 working tree.
2533
This was the first weave based working tree.
2534
- uses os locks for locking.
2535
- uses the branch last-revision.
2538
def __init__(self, *args, **kwargs):
2539
super(WorkingTree2, self).__init__(*args, **kwargs)
2540
# WorkingTree2 has more of a constraint that self._inventory must
2541
# exist. Because this is an older format, we don't mind the overhead
2542
# caused by the extra computation here.
2544
# Newer WorkingTree's should only have self._inventory set when they
2546
if self._inventory is None:
2547
self.read_working_inventory()
2549
def lock_tree_write(self):
2550
"""See WorkingTree.lock_tree_write().
2552
In Format2 WorkingTrees we have a single lock for the branch and tree
2553
so lock_tree_write() degrades to lock_write().
2555
self.branch.lock_write()
2557
return self._control_files.lock_write()
2559
self.branch.unlock()
2563
# do non-implementation specific cleanup
2566
# we share control files:
2567
if self._control_files._lock_count == 3:
2568
# _inventory_is_modified is always False during a read lock.
2569
if self._inventory_is_modified:
2571
self._write_hashcache_if_dirty()
2573
# reverse order of locking.
2575
return self._control_files.unlock()
2577
self.branch.unlock()
2580
class WorkingTree3(WorkingTree):
2581
"""This is the Format 3 working tree.
2583
This differs from the base WorkingTree by:
2584
- having its own file lock
2585
- having its own last-revision property.
2587
This is new in bzr 0.8
2591
def _last_revision(self):
2592
"""See Mutable.last_revision."""
2594
return self._transport.get_bytes('last-revision')
2595
except errors.NoSuchFile:
2596
return _mod_revision.NULL_REVISION
2598
def _change_last_revision(self, revision_id):
2599
"""See WorkingTree._change_last_revision."""
2600
if revision_id is None or revision_id == NULL_REVISION:
2602
self._transport.delete('last-revision')
2603
except errors.NoSuchFile:
2607
self._transport.put_bytes('last-revision', revision_id,
2608
mode=self._control_files._file_mode)
2611
@needs_tree_write_lock
2612
def set_conflicts(self, conflicts):
2613
self._put_rio('conflicts', conflicts.to_stanzas(),
2616
@needs_tree_write_lock
2617
def add_conflicts(self, new_conflicts):
2618
conflict_set = set(self.conflicts())
2619
conflict_set.update(set(list(new_conflicts)))
2620
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2621
key=_mod_conflicts.Conflict.sort_key)))
2624
def conflicts(self):
2626
confile = self._transport.get('conflicts')
2627
except errors.NoSuchFile:
2628
return _mod_conflicts.ConflictList()
2631
if confile.next() != CONFLICT_HEADER_1 + '\n':
2632
raise errors.ConflictFormatError()
2633
except StopIteration:
2634
raise errors.ConflictFormatError()
2635
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2640
# do non-implementation specific cleanup
2642
if self._control_files._lock_count == 1:
2643
# _inventory_is_modified is always False during a read lock.
2644
if self._inventory_is_modified:
2646
self._write_hashcache_if_dirty()
2647
# reverse order of locking.
2649
return self._control_files.unlock()
2651
self.branch.unlock()
2654
def get_conflicted_stem(path):
2655
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2656
if path.endswith(suffix):
2657
return path[:-len(suffix)]
2660
class WorkingTreeFormat(object):
2661
"""An encapsulation of the initialization and open routines for a format.
2663
Formats provide three things:
2664
* An initialization routine,
2668
Formats are placed in an dict by their format string for reference
2669
during workingtree opening. Its not required that these be instances, they
2670
can be classes themselves with class methods - it simply depends on
2671
whether state is needed for a given format or not.
2673
Once a format is deprecated, just deprecate the initialize and open
2674
methods on the format class. Do not deprecate the object, as the
2675
object will be created every time regardless.
2678
_default_format = None
2679
"""The default format used for new trees."""
2682
"""The known formats."""
2684
requires_rich_root = False
2686
upgrade_recommended = False
2689
def find_format(klass, a_bzrdir):
2690
"""Return the format for the working tree object in a_bzrdir."""
2692
transport = a_bzrdir.get_workingtree_transport(None)
2693
format_string = transport.get("format").read()
2694
return klass._formats[format_string]
2695
except errors.NoSuchFile:
2696
raise errors.NoWorkingTree(base=transport.base)
2698
raise errors.UnknownFormatError(format=format_string,
2699
kind="working tree")
2701
def __eq__(self, other):
2702
return self.__class__ is other.__class__
2704
def __ne__(self, other):
2705
return not (self == other)
2708
def get_default_format(klass):
2709
"""Return the current default format."""
2710
return klass._default_format
2712
def get_format_string(self):
2713
"""Return the ASCII format string that identifies this format."""
2714
raise NotImplementedError(self.get_format_string)
2716
def get_format_description(self):
2717
"""Return the short description for this format."""
2718
raise NotImplementedError(self.get_format_description)
2720
def is_supported(self):
2721
"""Is this format supported?
2723
Supported formats can be initialized and opened.
2724
Unsupported formats may not support initialization or committing or
2725
some other features depending on the reason for not being supported.
2729
def supports_content_filtering(self):
2730
"""True if this format supports content filtering."""
2733
def supports_views(self):
2734
"""True if this format supports stored views."""
2738
def register_format(klass, format):
2739
klass._formats[format.get_format_string()] = format
2742
def set_default_format(klass, format):
2743
klass._default_format = format
2746
def unregister_format(klass, format):
2747
del klass._formats[format.get_format_string()]
2750
class WorkingTreeFormat2(WorkingTreeFormat):
2751
"""The second working tree format.
2753
This format modified the hash cache from the format 1 hash cache.
2756
upgrade_recommended = True
2758
def get_format_description(self):
2759
"""See WorkingTreeFormat.get_format_description()."""
2760
return "Working tree format 2"
2762
def _stub_initialize_on_transport(self, transport, file_mode):
2763
"""Workaround: create control files for a remote working tree.
2765
This ensures that it can later be updated and dealt with locally,
2766
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2767
no working tree. (See bug #43064).
2771
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2773
transport.put_file('inventory', sio, file_mode)
2774
transport.put_bytes('pending-merges', '', file_mode)
2776
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2777
accelerator_tree=None, hardlink=False):
2778
"""See WorkingTreeFormat.initialize()."""
2779
if not isinstance(a_bzrdir.transport, LocalTransport):
2780
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2781
if from_branch is not None:
2782
branch = from_branch
2784
branch = a_bzrdir.open_branch()
2785
if revision_id is None:
2786
revision_id = _mod_revision.ensure_null(branch.last_revision())
2789
branch.generate_revision_history(revision_id)
2793
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2799
basis_tree = branch.repository.revision_tree(revision_id)
2800
if basis_tree.inventory.root is not None:
2801
wt.set_root_id(basis_tree.get_root_id())
2802
# set the parent list and cache the basis tree.
2803
if _mod_revision.is_null(revision_id):
2806
parent_trees = [(revision_id, basis_tree)]
2807
wt.set_parent_trees(parent_trees)
2808
transform.build_tree(basis_tree, wt)
2812
super(WorkingTreeFormat2, self).__init__()
2813
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2815
def open(self, a_bzrdir, _found=False):
2816
"""Return the WorkingTree object for a_bzrdir
2818
_found is a private parameter, do not use it. It is used to indicate
2819
if format probing has already been done.
2822
# we are being called directly and must probe.
2823
raise NotImplementedError
2824
if not isinstance(a_bzrdir.transport, LocalTransport):
2825
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2826
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2832
class WorkingTreeFormat3(WorkingTreeFormat):
2833
"""The second working tree format updated to record a format marker.
2836
- exists within a metadir controlling .bzr
2837
- includes an explicit version marker for the workingtree control
2838
files, separate from the BzrDir format
2839
- modifies the hash cache format
2841
- uses a LockDir to guard access for writes.
2844
upgrade_recommended = True
2846
def get_format_string(self):
2847
"""See WorkingTreeFormat.get_format_string()."""
2848
return "Bazaar-NG Working Tree format 3"
2850
def get_format_description(self):
2851
"""See WorkingTreeFormat.get_format_description()."""
2852
return "Working tree format 3"
2854
_lock_file_name = 'lock'
2855
_lock_class = LockDir
2857
_tree_class = WorkingTree3
2859
def __get_matchingbzrdir(self):
2860
return bzrdir.BzrDirMetaFormat1()
2862
_matchingbzrdir = property(__get_matchingbzrdir)
2864
def _open_control_files(self, a_bzrdir):
2865
transport = a_bzrdir.get_workingtree_transport(None)
2866
return LockableFiles(transport, self._lock_file_name,
2869
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2870
accelerator_tree=None, hardlink=False):
2871
"""See WorkingTreeFormat.initialize().
2873
:param revision_id: if supplied, create a working tree at a different
2874
revision than the branch is at.
2875
:param accelerator_tree: A tree which can be used for retrieving file
2876
contents more quickly than the revision tree, i.e. a workingtree.
2877
The revision tree will be used for cases where accelerator_tree's
2878
content is different.
2879
:param hardlink: If true, hard-link files from accelerator_tree,
2882
if not isinstance(a_bzrdir.transport, LocalTransport):
2883
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2884
transport = a_bzrdir.get_workingtree_transport(self)
2885
control_files = self._open_control_files(a_bzrdir)
2886
control_files.create_lock()
2887
control_files.lock_write()
2888
transport.put_bytes('format', self.get_format_string(),
2889
mode=control_files._file_mode)
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2896
# WorkingTree3 can handle an inventory which has a unique root id.
2897
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2898
# those trees. And because there isn't a format bump inbetween, we
2899
# are maintaining compatibility with older clients.
2900
# inv = Inventory(root_id=gen_root_id())
2901
inv = self._initial_inventory()
2902
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2908
_control_files=control_files)
2909
wt.lock_tree_write()
2911
basis_tree = branch.repository.revision_tree(revision_id)
2912
# only set an explicit root id if there is one to set.
2913
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2915
if revision_id == NULL_REVISION:
2916
wt.set_parent_trees([])
2918
wt.set_parent_trees([(revision_id, basis_tree)])
2919
transform.build_tree(basis_tree, wt)
2921
# Unlock in this order so that the unlock-triggers-flush in
2922
# WorkingTree is given a chance to fire.
2923
control_files.unlock()
2927
def _initial_inventory(self):
2931
super(WorkingTreeFormat3, self).__init__()
2933
def open(self, a_bzrdir, _found=False):
2934
"""Return the WorkingTree object for a_bzrdir
2936
_found is a private parameter, do not use it. It is used to indicate
2937
if format probing has already been done.
2940
# we are being called directly and must probe.
2941
raise NotImplementedError
2942
if not isinstance(a_bzrdir.transport, LocalTransport):
2943
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2944
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2947
def _open(self, a_bzrdir, control_files):
2948
"""Open the tree itself.
2950
:param a_bzrdir: the dir for the tree.
2951
:param control_files: the control files for the tree.
2953
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2957
_control_files=control_files)
2960
return self.get_format_string()
2963
__default_format = WorkingTreeFormat4()
2964
WorkingTreeFormat.register_format(__default_format)
2965
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2966
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2967
WorkingTreeFormat.set_default_format(__default_format)
2968
# formats which have no format string are not discoverable
2969
# and not independently creatable, so are not registered.
2970
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
