1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
57
conflicts as _mod_conflicts,
65
revision as _mod_revision,
76
from bzrlib.transport import get_transport
77
from bzrlib.workingtree_4 import (
84
from bzrlib import symbol_versioning
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib import osutils
91
from bzrlib.osutils import (
101
from bzrlib.filters import filtered_input_file
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (
109
DEPRECATED_PARAMETER,
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
116
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
119
class TreeEntry(object):
120
"""An entry that implements the minimum interface used by commands.
122
This needs further inspection, it may be better to have
123
InventoryEntries without ids - though that seems wrong. For now,
124
this is a parallel hierarchy to InventoryEntry, and needs to become
125
one of several things: decorates to that hierarchy, children of, or
127
Another note is that these objects are currently only used when there is
128
no InventoryEntry available - i.e. for unversioned objects.
129
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
132
def __eq__(self, other):
133
# yes, this us ugly, TODO: best practice __eq__ style.
134
return (isinstance(other, TreeEntry)
135
and other.__class__ == self.__class__)
137
def kind_character(self):
141
class TreeDirectory(TreeEntry):
142
"""See TreeEntry. This is a directory in a working tree."""
144
def __eq__(self, other):
145
return (isinstance(other, TreeDirectory)
146
and other.__class__ == self.__class__)
148
def kind_character(self):
152
class TreeFile(TreeEntry):
153
"""See TreeEntry. This is a regular file in a working tree."""
155
def __eq__(self, other):
156
return (isinstance(other, TreeFile)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeLink(TreeEntry):
164
"""See TreeEntry. This is a symlink in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeLink)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class WorkingTree(bzrlib.mutabletree.MutableTree):
175
"""Working copy tree.
177
The inventory is held in the `Branch` working-inventory, and the
178
files are in a directory on disk.
180
It is possible for a `WorkingTree` to have a filename which is
181
not listed in the Inventory and vice versa.
184
# override this to set the strategy for storing views
185
def _make_views(self):
186
return views.DisabledViews(self)
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode(),
229
self._content_filter_stack_provider())
232
# is this scan needed ? it makes things kinda slow.
239
if _inventory is None:
240
# This will be acquired on lock_read() or lock_write()
241
self._inventory_is_modified = False
242
self._inventory = None
244
# the caller of __init__ has provided an inventory,
245
# we assume they know what they are doing - as its only
246
# the Format factory and creation methods that are
247
# permitted to do this.
248
self._set_inventory(_inventory, dirty=False)
249
self._detect_case_handling()
250
self._rules_searcher = None
251
self.views = self._make_views()
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 supports_content_filtering(self):
290
return self._format.supports_content_filtering()
292
def supports_views(self):
293
return self.views.supports_views()
295
def _set_inventory(self, inv, dirty):
296
"""Set the internal cached inventory.
298
:param inv: The inventory to set.
299
:param dirty: A boolean indicating whether the inventory is the same
300
logical inventory as whats on disk. If True the inventory is not
301
the same and should be written to disk or data will be lost, if
302
False then the inventory is the same as that on disk and any
303
serialisation would be unneeded overhead.
305
self._inventory = inv
306
self._inventory_is_modified = dirty
309
def open(path=None, _unsupported=False):
310
"""Open an existing working tree at path.
314
path = osutils.getcwd()
315
control = bzrdir.BzrDir.open(path, _unsupported)
316
return control.open_workingtree(_unsupported)
319
def open_containing(path=None):
320
"""Open an existing working tree which has its root about path.
322
This probes for a working tree at path and searches upwards from there.
324
Basically we keep looking up until we find the control directory or
325
run into /. If there isn't one, raises NotBranchError.
326
TODO: give this a new exception.
327
If there is one, it is returned, along with the unused portion of path.
329
:return: The WorkingTree that contains 'path', and the rest of path
332
path = osutils.getcwd()
333
control, relpath = bzrdir.BzrDir.open_containing(path)
335
return control.open_workingtree(), relpath
338
def open_downlevel(path=None):
339
"""Open an unsupported working tree.
341
Only intended for advanced situations like upgrading part of a bzrdir.
343
return WorkingTree.open(path, _unsupported=True)
346
def find_trees(location):
347
def list_current(transport):
348
return [d for d in transport.list_dir('') if d != '.bzr']
349
def evaluate(bzrdir):
351
tree = bzrdir.open_workingtree()
352
except errors.NoWorkingTree:
356
transport = get_transport(location)
357
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
358
list_current=list_current)
359
return [t for t in iterator if t is not None]
361
# should be deprecated - this is slow and in any case treating them as a
362
# container is (we now know) bad style -- mbp 20070302
363
## @deprecated_method(zero_fifteen)
365
"""Iterate through file_ids for this tree.
367
file_ids are in a WorkingTree if they are in the working inventory
368
and the working file exists.
370
inv = self._inventory
371
for path, ie in inv.iter_entries():
372
if osutils.lexists(self.abspath(path)):
375
def all_file_ids(self):
376
"""See Tree.iter_all_file_ids"""
377
return set(self.inventory)
380
return "<%s of %s>" % (self.__class__.__name__,
381
getattr(self, 'basedir', None))
383
def abspath(self, filename):
384
return pathjoin(self.basedir, filename)
386
def basis_tree(self):
387
"""Return RevisionTree for the current last revision.
389
If the left most parent is a ghost then the returned tree will be an
390
empty tree - one obtained by calling
391
repository.revision_tree(NULL_REVISION).
394
revision_id = self.get_parent_ids()[0]
396
# no parents, return an empty revision tree.
397
# in the future this should return the tree for
398
# 'empty:' - the implicit root empty tree.
399
return self.branch.repository.revision_tree(
400
_mod_revision.NULL_REVISION)
402
return self.revision_tree(revision_id)
403
except errors.NoSuchRevision:
405
# No cached copy available, retrieve from the repository.
406
# FIXME? RBC 20060403 should we cache the inventory locally
409
return self.branch.repository.revision_tree(revision_id)
410
except (errors.RevisionNotPresent, errors.NoSuchRevision):
411
# the basis tree *may* be a ghost or a low level error may have
412
# occurred. If the revision is present, its a problem, if its not
414
if self.branch.repository.has_revision(revision_id):
416
# the basis tree is a ghost so return an empty tree.
417
return self.branch.repository.revision_tree(
418
_mod_revision.NULL_REVISION)
421
self._flush_ignore_list_cache()
423
def relpath(self, path):
424
"""Return the local path portion from a given path.
426
The path may be absolute or relative. If its a relative path it is
427
interpreted relative to the python current working directory.
429
return osutils.relpath(self.basedir, path)
431
def has_filename(self, filename):
432
return osutils.lexists(self.abspath(filename))
434
def get_file(self, file_id, path=None, filtered=True):
435
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
437
def get_file_with_stat(self, file_id, path=None, filtered=True,
439
"""See Tree.get_file_with_stat."""
441
path = self.id2path(file_id)
442
file_obj = self.get_file_byname(path, filtered=False)
443
stat_value = _fstat(file_obj.fileno())
444
if filtered and self.supports_content_filtering():
445
filters = self._content_filter_stack(path)
446
file_obj = filtered_input_file(file_obj, filters)
447
return (file_obj, stat_value)
449
def get_file_text(self, file_id, path=None, filtered=True):
450
return self.get_file(file_id, path=path, filtered=filtered).read()
452
def get_file_byname(self, filename, filtered=True):
453
path = self.abspath(filename)
455
if filtered and self.supports_content_filtering():
456
filters = self._content_filter_stack(filename)
457
return filtered_input_file(f, filters)
461
def get_file_lines(self, file_id, path=None, filtered=True):
462
"""See Tree.get_file_lines()"""
463
file = self.get_file(file_id, path, filtered=filtered)
465
return file.readlines()
470
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
471
"""See Tree.annotate_iter
473
This implementation will use the basis tree implementation if possible.
474
Lines not in the basis are attributed to CURRENT_REVISION
476
If there are pending merges, lines added by those merges will be
477
incorrectly attributed to CURRENT_REVISION (but after committing, the
478
attribution will be correct).
480
basis = self.basis_tree()
483
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
484
require_versioned=True).next()
485
changed_content, kind = changes[2], changes[6]
486
if not changed_content:
487
return basis.annotate_iter(file_id)
491
if kind[0] != 'file':
494
old_lines = list(basis.annotate_iter(file_id))
496
for tree in self.branch.repository.revision_trees(
497
self.get_parent_ids()[1:]):
498
if file_id not in tree:
500
old.append(list(tree.annotate_iter(file_id)))
501
return annotate.reannotate(old, self.get_file(file_id).readlines(),
506
def _get_ancestors(self, default_revision):
507
ancestors = set([default_revision])
508
for parent_id in self.get_parent_ids():
509
ancestors.update(self.branch.repository.get_ancestry(
510
parent_id, topo_sorted=False))
513
def get_parent_ids(self):
514
"""See Tree.get_parent_ids.
516
This implementation reads the pending merges list and last_revision
517
value and uses that to decide what the parents list should be.
519
last_rev = _mod_revision.ensure_null(self._last_revision())
520
if _mod_revision.NULL_REVISION == last_rev:
525
merges_file = self._transport.get('pending-merges')
526
except errors.NoSuchFile:
529
for l in merges_file.readlines():
530
revision_id = l.rstrip('\n')
531
parents.append(revision_id)
535
def get_root_id(self):
536
"""Return the id of this trees root"""
537
return self._inventory.root.file_id
539
def _get_store_filename(self, file_id):
540
## XXX: badly named; this is not in the store at all
541
return self.abspath(self.id2path(file_id))
544
def clone(self, to_bzrdir, revision_id=None):
545
"""Duplicate this working tree into to_bzr, including all state.
547
Specifically modified files are kept as modified, but
548
ignored and unknown files are discarded.
550
If you want to make a new line of development, see bzrdir.sprout()
553
If not None, the cloned tree will have its last revision set to
554
revision, and difference between the source trees last revision
555
and this one merged in.
557
# assumes the target bzr dir format is compatible.
558
result = to_bzrdir.create_workingtree()
559
self.copy_content_into(result, revision_id)
563
def copy_content_into(self, tree, revision_id=None):
564
"""Copy the current content and user files of this tree into tree."""
565
tree.set_root_id(self.get_root_id())
566
if revision_id is None:
567
merge.transform_tree(tree, self)
569
# TODO now merge from tree.last_revision to revision (to preserve
570
# user local changes)
571
merge.transform_tree(tree, self)
572
tree.set_parent_ids([revision_id])
574
def id2abspath(self, file_id):
575
return self.abspath(self.id2path(file_id))
577
def has_id(self, file_id):
578
# files that have been deleted are excluded
580
if not inv.has_id(file_id):
582
path = inv.id2path(file_id)
583
return osutils.lexists(self.abspath(path))
585
def has_or_had_id(self, file_id):
586
if file_id == self.inventory.root.file_id:
588
return self.inventory.has_id(file_id)
590
__contains__ = has_id
592
def get_file_size(self, file_id):
593
"""See Tree.get_file_size"""
595
return os.path.getsize(self.id2abspath(file_id))
597
if e.errno != errno.ENOENT:
603
def get_file_sha1(self, file_id, path=None, stat_value=None):
605
path = self._inventory.id2path(file_id)
606
return self._hashcache.get_sha1(path, stat_value)
608
def get_file_mtime(self, file_id, path=None):
610
path = self.inventory.id2path(file_id)
611
return os.lstat(self.abspath(path)).st_mtime
613
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
614
file_id = self.path2id(path)
615
return self._inventory[file_id].executable
617
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
618
mode = stat_result.st_mode
619
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
621
if not supports_executable():
622
def is_executable(self, file_id, path=None):
623
return self._inventory[file_id].executable
625
_is_executable_from_path_and_stat = \
626
_is_executable_from_path_and_stat_from_basis
628
def is_executable(self, file_id, path=None):
630
path = self.id2path(file_id)
631
mode = os.lstat(self.abspath(path)).st_mode
632
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
634
_is_executable_from_path_and_stat = \
635
_is_executable_from_path_and_stat_from_stat
637
@needs_tree_write_lock
638
def _add(self, files, ids, kinds):
639
"""See MutableTree._add."""
640
# TODO: Re-adding a file that is removed in the working copy
641
# should probably put it back with the previous ID.
642
# the read and write working inventory should not occur in this
643
# function - they should be part of lock_write and unlock.
645
for f, file_id, kind in zip(files, ids, kinds):
647
inv.add_path(f, kind=kind)
649
inv.add_path(f, kind=kind, file_id=file_id)
650
self._inventory_is_modified = True
652
@needs_tree_write_lock
653
def _gather_kinds(self, files, kinds):
654
"""See MutableTree._gather_kinds."""
655
for pos, f in enumerate(files):
656
if kinds[pos] is None:
657
fullpath = normpath(self.abspath(f))
659
kinds[pos] = file_kind(fullpath)
661
if e.errno == errno.ENOENT:
662
raise errors.NoSuchFile(fullpath)
665
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
666
"""Add revision_id as a parent.
668
This is equivalent to retrieving the current list of parent ids
669
and setting the list to its value plus revision_id.
671
:param revision_id: The revision id to add to the parent list. It may
672
be a ghost revision as long as its not the first parent to be added,
673
or the allow_leftmost_as_ghost parameter is set True.
674
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
676
parents = self.get_parent_ids() + [revision_id]
677
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
678
or allow_leftmost_as_ghost)
680
@needs_tree_write_lock
681
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
682
"""Add revision_id, tree tuple as a parent.
684
This is equivalent to retrieving the current list of parent trees
685
and setting the list to its value plus parent_tuple. See also
686
add_parent_tree_id - if you only have a parent id available it will be
687
simpler to use that api. If you have the parent already available, using
688
this api is preferred.
690
:param parent_tuple: The (revision id, tree) to add to the parent list.
691
If the revision_id is a ghost, pass None for the tree.
692
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
694
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
695
if len(parent_ids) > 1:
696
# the leftmost may have already been a ghost, preserve that if it
698
allow_leftmost_as_ghost = True
699
self.set_parent_ids(parent_ids,
700
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
702
@needs_tree_write_lock
703
def add_pending_merge(self, *revision_ids):
704
# TODO: Perhaps should check at this point that the
705
# history of the revision is actually present?
706
parents = self.get_parent_ids()
708
for rev_id in revision_ids:
709
if rev_id in parents:
711
parents.append(rev_id)
714
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
716
def path_content_summary(self, path, _lstat=os.lstat,
717
_mapper=osutils.file_kind_from_stat_mode):
718
"""See Tree.path_content_summary."""
719
abspath = self.abspath(path)
721
stat_result = _lstat(abspath)
723
if getattr(e, 'errno', None) == errno.ENOENT:
725
return ('missing', None, None, None)
726
# propagate other errors
728
kind = _mapper(stat_result.st_mode)
730
size = stat_result.st_size
731
# try for a stat cache lookup
732
executable = self._is_executable_from_path_and_stat(path, stat_result)
733
return (kind, size, executable, self._sha_from_stat(
735
elif kind == 'directory':
736
# perhaps it looks like a plain directory, but it's really a
738
if self._directory_is_tree_reference(path):
739
kind = 'tree-reference'
740
return kind, None, None, None
741
elif kind == 'symlink':
742
target = osutils.readlink(abspath)
743
return ('symlink', None, None, target)
745
return (kind, None, None, None)
747
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
748
"""Common ghost checking functionality from set_parent_*.
750
This checks that the left hand-parent exists if there are any
753
if len(revision_ids) > 0:
754
leftmost_id = revision_ids[0]
755
if (not allow_leftmost_as_ghost and not
756
self.branch.repository.has_revision(leftmost_id)):
757
raise errors.GhostRevisionUnusableHere(leftmost_id)
759
def _set_merges_from_parent_ids(self, parent_ids):
760
merges = parent_ids[1:]
761
self._transport.put_bytes('pending-merges', '\n'.join(merges),
762
mode=self.bzrdir._get_file_mode())
764
def _filter_parent_ids_by_ancestry(self, revision_ids):
765
"""Check that all merged revisions are proper 'heads'.
767
This will always return the first revision_id, and any merged revisions
770
if len(revision_ids) == 0:
772
graph = self.branch.repository.get_graph()
773
heads = graph.heads(revision_ids)
774
new_revision_ids = revision_ids[:1]
775
for revision_id in revision_ids[1:]:
776
if revision_id in heads and revision_id not in new_revision_ids:
777
new_revision_ids.append(revision_id)
778
if new_revision_ids != revision_ids:
779
trace.mutter('requested to set revision_ids = %s,'
780
' but filtered to %s', revision_ids, new_revision_ids)
781
return new_revision_ids
783
@needs_tree_write_lock
784
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
785
"""Set the parent ids to revision_ids.
787
See also set_parent_trees. This api will try to retrieve the tree data
788
for each element of revision_ids from the trees repository. If you have
789
tree data already available, it is more efficient to use
790
set_parent_trees rather than set_parent_ids. set_parent_ids is however
791
an easier API to use.
793
:param revision_ids: The revision_ids to set as the parent ids of this
794
working tree. Any of these may be ghosts.
796
self._check_parents_for_ghosts(revision_ids,
797
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
798
for revision_id in revision_ids:
799
_mod_revision.check_not_reserved_id(revision_id)
801
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
803
if len(revision_ids) > 0:
804
self.set_last_revision(revision_ids[0])
806
self.set_last_revision(_mod_revision.NULL_REVISION)
808
self._set_merges_from_parent_ids(revision_ids)
810
@needs_tree_write_lock
811
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
812
"""See MutableTree.set_parent_trees."""
813
parent_ids = [rev for (rev, tree) in parents_list]
814
for revision_id in parent_ids:
815
_mod_revision.check_not_reserved_id(revision_id)
817
self._check_parents_for_ghosts(parent_ids,
818
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
820
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
822
if len(parent_ids) == 0:
823
leftmost_parent_id = _mod_revision.NULL_REVISION
824
leftmost_parent_tree = None
826
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
828
if self._change_last_revision(leftmost_parent_id):
829
if leftmost_parent_tree is None:
830
# If we don't have a tree, fall back to reading the
831
# parent tree from the repository.
832
self._cache_basis_inventory(leftmost_parent_id)
834
inv = leftmost_parent_tree.inventory
835
xml = self._create_basis_xml_from_inventory(
836
leftmost_parent_id, inv)
837
self._write_basis_inventory(xml)
838
self._set_merges_from_parent_ids(parent_ids)
840
@needs_tree_write_lock
841
def set_pending_merges(self, rev_list):
842
parents = self.get_parent_ids()
843
leftmost = parents[:1]
844
new_parents = leftmost + rev_list
845
self.set_parent_ids(new_parents)
847
@needs_tree_write_lock
848
def set_merge_modified(self, modified_hashes):
850
for file_id, hash in modified_hashes.iteritems():
851
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
852
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
854
def _sha_from_stat(self, path, stat_result):
855
"""Get a sha digest from the tree's stat cache.
857
The default implementation assumes no stat cache is present.
859
:param path: The path.
860
:param stat_result: The stat result being looked up.
864
def _put_rio(self, filename, stanzas, header):
865
self._must_be_locked()
866
my_file = rio_file(stanzas, header)
867
self._transport.put_file(filename, my_file,
868
mode=self.bzrdir._get_file_mode())
870
@needs_write_lock # because merge pulls data into the branch.
871
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
873
"""Merge from a branch into this working tree.
875
:param branch: The branch to merge from.
876
:param to_revision: If non-None, the merge will merge to to_revision,
877
but not beyond it. to_revision does not need to be in the history
878
of the branch when it is supplied. If None, to_revision defaults to
879
branch.last_revision().
881
from bzrlib.merge import Merger, Merge3Merger
882
pb = ui.ui_factory.nested_progress_bar()
884
merger = Merger(self.branch, this_tree=self, pb=pb)
885
merger.pp = ProgressPhase("Merge phase", 5, pb)
886
merger.pp.next_phase()
887
# check that there are no
889
merger.check_basis(check_clean=True, require_commits=False)
890
if to_revision is None:
891
to_revision = _mod_revision.ensure_null(branch.last_revision())
892
merger.other_rev_id = to_revision
893
if _mod_revision.is_null(merger.other_rev_id):
894
raise errors.NoCommits(branch)
895
self.branch.fetch(branch, last_revision=merger.other_rev_id)
896
merger.other_basis = merger.other_rev_id
897
merger.other_tree = self.branch.repository.revision_tree(
899
merger.other_branch = branch
900
merger.pp.next_phase()
901
if from_revision is None:
904
merger.set_base_revision(from_revision, branch)
905
if merger.base_rev_id == merger.other_rev_id:
906
raise errors.PointlessMerge
907
merger.backup_files = False
908
if merge_type is None:
909
merger.merge_type = Merge3Merger
911
merger.merge_type = merge_type
912
merger.set_interesting_files(None)
913
merger.show_base = False
914
merger.reprocess = False
915
conflicts = merger.do_merge()
922
def merge_modified(self):
923
"""Return a dictionary of files modified by a merge.
925
The list is initialized by WorkingTree.set_merge_modified, which is
926
typically called after we make some automatic updates to the tree
929
This returns a map of file_id->sha1, containing only files which are
930
still in the working inventory and have that text hash.
933
hashfile = self._transport.get('merge-hashes')
934
except errors.NoSuchFile:
939
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
940
raise errors.MergeModifiedFormatError()
941
except StopIteration:
942
raise errors.MergeModifiedFormatError()
943
for s in RioReader(hashfile):
944
# RioReader reads in Unicode, so convert file_ids back to utf8
945
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
946
if file_id not in self.inventory:
948
text_hash = s.get("hash")
949
if text_hash == self.get_file_sha1(file_id):
950
merge_hashes[file_id] = text_hash
956
def mkdir(self, path, file_id=None):
957
"""See MutableTree.mkdir()."""
959
file_id = generate_ids.gen_file_id(os.path.basename(path))
960
os.mkdir(self.abspath(path))
961
self.add(path, file_id, 'directory')
964
def get_symlink_target(self, file_id):
965
abspath = self.id2abspath(file_id)
966
target = osutils.readlink(abspath)
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(_mod_revision.NULL_REVISION)
1075
wt.set_parent_ids(self.get_parent_ids())
1076
my_inv = self.inventory
1077
child_inv = inventory.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.bzrdir._get_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, from_dir=None, recursive=True):
1109
"""List all files as (path, class, kind, id, entry).
1111
Lists, but does not descend into unversioned directories.
1112
This does not include files that have been deleted in this
1113
tree. Skips the control directory.
1115
:param include_root: if True, do not return an entry for the root
1116
:param from_dir: start from this directory or None for the root
1117
:param recursive: whether to recurse into subdirectories or not
1119
# list_files is an iterator, so @needs_read_lock doesn't work properly
1120
# with it. So callers should be careful to always read_lock the tree.
1121
if not self.is_locked():
1122
raise errors.ObjectNotLocked(self)
1124
inv = self.inventory
1125
if from_dir is None and include_root is True:
1126
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1127
# Convert these into local objects to save lookup times
1128
pathjoin = osutils.pathjoin
1129
file_kind = self._kind
1131
# transport.base ends in a slash, we want the piece
1132
# between the last two slashes
1133
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1135
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1137
# directory file_id, relative path, absolute path, reverse sorted children
1138
if from_dir is not None:
1139
from_dir_id = inv.path2id(from_dir)
1140
if from_dir_id is None:
1141
# Directory not versioned
1143
from_dir_abspath = pathjoin(self.basedir, from_dir)
1145
from_dir_id = inv.root.file_id
1146
from_dir_abspath = self.basedir
1147
children = os.listdir(from_dir_abspath)
1149
# jam 20060527 The kernel sized tree seems equivalent whether we
1150
# use a deque and popleft to keep them sorted, or if we use a plain
1151
# list and just reverse() them.
1152
children = collections.deque(children)
1153
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1155
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1158
f = children.popleft()
1159
## TODO: If we find a subdirectory with its own .bzr
1160
## directory, then that is a separate tree and we
1161
## should exclude it.
1163
# the bzrdir for this tree
1164
if transport_base_dir == f:
1167
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1168
# and 'f' doesn't begin with one, we can do a string op, rather
1169
# than the checks of pathjoin(), all relative paths will have an extra slash
1171
fp = from_dir_relpath + '/' + f
1174
fap = from_dir_abspath + '/' + f
1176
f_ie = inv.get_child(from_dir_id, f)
1179
elif self.is_ignored(fp[1:]):
1182
# we may not have found this file, because of a unicode issue
1183
f_norm, can_access = osutils.normalized_filename(f)
1184
if f == f_norm or not can_access:
1185
# No change, so treat this file normally
1188
# this file can be accessed by a normalized path
1189
# check again if it is versioned
1190
# these lines are repeated here for performance
1192
fp = from_dir_relpath + '/' + f
1193
fap = from_dir_abspath + '/' + f
1194
f_ie = inv.get_child(from_dir_id, f)
1197
elif self.is_ignored(fp[1:]):
1204
# make a last minute entry
1206
yield fp[1:], c, fk, f_ie.file_id, f_ie
1209
yield fp[1:], c, fk, None, fk_entries[fk]()
1211
yield fp[1:], c, fk, None, TreeEntry()
1214
if fk != 'directory':
1217
# But do this child first if recursing down
1219
new_children = os.listdir(fap)
1221
new_children = collections.deque(new_children)
1222
stack.append((f_ie.file_id, fp, fap, new_children))
1223
# Break out of inner loop,
1224
# so that we start outer loop with child
1227
# if we finished all children, pop it off the stack
1230
@needs_tree_write_lock
1231
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1234
to_dir must exist in the inventory.
1236
If to_dir exists and is a directory, the files are moved into
1237
it, keeping their old names.
1239
Note that to_dir is only the last component of the new name;
1240
this doesn't change the directory.
1242
For each entry in from_paths the move mode will be determined
1245
The first mode moves the file in the filesystem and updates the
1246
inventory. The second mode only updates the inventory without
1247
touching the file on the filesystem. This is the new mode introduced
1250
move uses the second mode if 'after == True' and the target is not
1251
versioned but present in the working tree.
1253
move uses the second mode if 'after == False' and the source is
1254
versioned but no longer in the working tree, and the target is not
1255
versioned but present in the working tree.
1257
move uses the first mode if 'after == False' and the source is
1258
versioned and present in the working tree, and the target is not
1259
versioned and not present in the working tree.
1261
Everything else results in an error.
1263
This returns a list of (from_path, to_path) pairs for each
1264
entry that is moved.
1269
# check for deprecated use of signature
1271
to_dir = kwargs.get('to_name', None)
1273
raise TypeError('You must supply a target directory')
1275
symbol_versioning.warn('The parameter to_name was deprecated'
1276
' in version 0.13. Use to_dir instead',
1279
# check destination directory
1280
if isinstance(from_paths, basestring):
1282
inv = self.inventory
1283
to_abs = self.abspath(to_dir)
1284
if not isdir(to_abs):
1285
raise errors.BzrMoveFailedError('',to_dir,
1286
errors.NotADirectory(to_abs))
1287
if not self.has_filename(to_dir):
1288
raise errors.BzrMoveFailedError('',to_dir,
1289
errors.NotInWorkingDirectory(to_dir))
1290
to_dir_id = inv.path2id(to_dir)
1291
if to_dir_id is None:
1292
raise errors.BzrMoveFailedError('',to_dir,
1293
errors.NotVersionedError(path=str(to_dir)))
1295
to_dir_ie = inv[to_dir_id]
1296
if to_dir_ie.kind != 'directory':
1297
raise errors.BzrMoveFailedError('',to_dir,
1298
errors.NotADirectory(to_abs))
1300
# create rename entries and tuples
1301
for from_rel in from_paths:
1302
from_tail = splitpath(from_rel)[-1]
1303
from_id = inv.path2id(from_rel)
1305
raise errors.BzrMoveFailedError(from_rel,to_dir,
1306
errors.NotVersionedError(path=str(from_rel)))
1308
from_entry = inv[from_id]
1309
from_parent_id = from_entry.parent_id
1310
to_rel = pathjoin(to_dir, from_tail)
1311
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1313
from_tail=from_tail,
1314
from_parent_id=from_parent_id,
1315
to_rel=to_rel, to_tail=from_tail,
1316
to_parent_id=to_dir_id)
1317
rename_entries.append(rename_entry)
1318
rename_tuples.append((from_rel, to_rel))
1320
# determine which move mode to use. checks also for movability
1321
rename_entries = self._determine_mv_mode(rename_entries, after)
1323
original_modified = self._inventory_is_modified
1326
self._inventory_is_modified = True
1327
self._move(rename_entries)
1329
# restore the inventory on error
1330
self._inventory_is_modified = original_modified
1332
self._write_inventory(inv)
1333
return rename_tuples
1335
def _determine_mv_mode(self, rename_entries, after=False):
1336
"""Determines for each from-to pair if both inventory and working tree
1337
or only the inventory has to be changed.
1339
Also does basic plausability tests.
1341
inv = self.inventory
1343
for rename_entry in rename_entries:
1344
# store to local variables for easier reference
1345
from_rel = rename_entry.from_rel
1346
from_id = rename_entry.from_id
1347
to_rel = rename_entry.to_rel
1348
to_id = inv.path2id(to_rel)
1349
only_change_inv = False
1351
# check the inventory for source and destination
1353
raise errors.BzrMoveFailedError(from_rel,to_rel,
1354
errors.NotVersionedError(path=str(from_rel)))
1355
if to_id is not None:
1356
raise errors.BzrMoveFailedError(from_rel,to_rel,
1357
errors.AlreadyVersionedError(path=str(to_rel)))
1359
# try to determine the mode for rename (only change inv or change
1360
# inv and file system)
1362
if not self.has_filename(to_rel):
1363
raise errors.BzrMoveFailedError(from_id,to_rel,
1364
errors.NoSuchFile(path=str(to_rel),
1365
extra="New file has not been created yet"))
1366
only_change_inv = True
1367
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1368
only_change_inv = True
1369
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1370
only_change_inv = False
1371
elif (not self.case_sensitive
1372
and from_rel.lower() == to_rel.lower()
1373
and self.has_filename(from_rel)):
1374
only_change_inv = False
1376
# something is wrong, so lets determine what exactly
1377
if not self.has_filename(from_rel) and \
1378
not self.has_filename(to_rel):
1379
raise errors.BzrRenameFailedError(from_rel,to_rel,
1380
errors.PathsDoNotExist(paths=(str(from_rel),
1383
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1384
rename_entry.only_change_inv = only_change_inv
1385
return rename_entries
1387
def _move(self, rename_entries):
1388
"""Moves a list of files.
1390
Depending on the value of the flag 'only_change_inv', the
1391
file will be moved on the file system or not.
1393
inv = self.inventory
1396
for entry in rename_entries:
1398
self._move_entry(entry)
1400
self._rollback_move(moved)
1404
def _rollback_move(self, moved):
1405
"""Try to rollback a previous move in case of an filesystem error."""
1406
inv = self.inventory
1409
self._move_entry(WorkingTree._RenameEntry(
1410
entry.to_rel, entry.from_id,
1411
entry.to_tail, entry.to_parent_id, entry.from_rel,
1412
entry.from_tail, entry.from_parent_id,
1413
entry.only_change_inv))
1414
except errors.BzrMoveFailedError, e:
1415
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1416
" The working tree is in an inconsistent state."
1417
" Please consider doing a 'bzr revert'."
1418
" Error message is: %s" % e)
1420
def _move_entry(self, entry):
1421
inv = self.inventory
1422
from_rel_abs = self.abspath(entry.from_rel)
1423
to_rel_abs = self.abspath(entry.to_rel)
1424
if from_rel_abs == to_rel_abs:
1425
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1426
"Source and target are identical.")
1428
if not entry.only_change_inv:
1430
osutils.rename(from_rel_abs, to_rel_abs)
1432
raise errors.BzrMoveFailedError(entry.from_rel,
1434
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1436
@needs_tree_write_lock
1437
def rename_one(self, from_rel, to_rel, after=False):
1440
This can change the directory or the filename or both.
1442
rename_one has several 'modes' to work. First, it can rename a physical
1443
file and change the file_id. That is the normal mode. Second, it can
1444
only change the file_id without touching any physical file. This is
1445
the new mode introduced in version 0.15.
1447
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1448
versioned but present in the working tree.
1450
rename_one uses the second mode if 'after == False' and 'from_rel' is
1451
versioned but no longer in the working tree, and 'to_rel' is not
1452
versioned but present in the working tree.
1454
rename_one uses the first mode if 'after == False' and 'from_rel' is
1455
versioned and present in the working tree, and 'to_rel' is not
1456
versioned and not present in the working tree.
1458
Everything else results in an error.
1460
inv = self.inventory
1463
# create rename entries and tuples
1464
from_tail = splitpath(from_rel)[-1]
1465
from_id = inv.path2id(from_rel)
1467
raise errors.BzrRenameFailedError(from_rel,to_rel,
1468
errors.NotVersionedError(path=str(from_rel)))
1469
from_entry = inv[from_id]
1470
from_parent_id = from_entry.parent_id
1471
to_dir, to_tail = os.path.split(to_rel)
1472
to_dir_id = inv.path2id(to_dir)
1473
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1475
from_tail=from_tail,
1476
from_parent_id=from_parent_id,
1477
to_rel=to_rel, to_tail=to_tail,
1478
to_parent_id=to_dir_id)
1479
rename_entries.append(rename_entry)
1481
# determine which move mode to use. checks also for movability
1482
rename_entries = self._determine_mv_mode(rename_entries, after)
1484
# check if the target changed directory and if the target directory is
1486
if to_dir_id is None:
1487
raise errors.BzrMoveFailedError(from_rel,to_rel,
1488
errors.NotVersionedError(path=str(to_dir)))
1490
# all checks done. now we can continue with our actual work
1491
mutter('rename_one:\n'
1496
' to_dir_id {%s}\n',
1497
from_id, from_rel, to_rel, to_dir, to_dir_id)
1499
self._move(rename_entries)
1500
self._write_inventory(inv)
1502
class _RenameEntry(object):
1503
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1504
to_rel, to_tail, to_parent_id, only_change_inv=False):
1505
self.from_rel = from_rel
1506
self.from_id = from_id
1507
self.from_tail = from_tail
1508
self.from_parent_id = from_parent_id
1509
self.to_rel = to_rel
1510
self.to_tail = to_tail
1511
self.to_parent_id = to_parent_id
1512
self.only_change_inv = only_change_inv
1516
"""Return all unknown files.
1518
These are files in the working directory that are not versioned or
1519
control files or ignored.
1521
# force the extras method to be fully executed before returning, to
1522
# prevent race conditions with the lock
1524
[subp for subp in self.extras() if not self.is_ignored(subp)])
1526
@needs_tree_write_lock
1527
def unversion(self, file_ids):
1528
"""Remove the file ids in file_ids from the current versioned set.
1530
When a file_id is unversioned, all of its children are automatically
1533
:param file_ids: The file ids to stop versioning.
1534
:raises: NoSuchId if any fileid is not currently versioned.
1536
for file_id in file_ids:
1537
if file_id not in self._inventory:
1538
raise errors.NoSuchId(self, file_id)
1539
for file_id in file_ids:
1540
if self._inventory.has_id(file_id):
1541
self._inventory.remove_recursive_id(file_id)
1543
# in the future this should just set a dirty bit to wait for the
1544
# final unlock. However, until all methods of workingtree start
1545
# with the current in -memory inventory rather than triggering
1546
# a read, it is more complex - we need to teach read_inventory
1547
# to know when to read, and when to not read first... and possibly
1548
# to save first when the in memory one may be corrupted.
1549
# so for now, we just only write it if it is indeed dirty.
1551
self._write_inventory(self._inventory)
1553
def _iter_conflicts(self):
1555
for info in self.list_files():
1557
stem = get_conflicted_stem(path)
1560
if stem not in conflicted:
1561
conflicted.add(stem)
1565
def pull(self, source, overwrite=False, stop_revision=None,
1566
change_reporter=None, possible_transports=None, local=False):
1567
top_pb = ui.ui_factory.nested_progress_bar()
1570
pp = ProgressPhase("Pull phase", 2, top_pb)
1572
old_revision_info = self.branch.last_revision_info()
1573
basis_tree = self.basis_tree()
1574
count = self.branch.pull(source, overwrite, stop_revision,
1575
possible_transports=possible_transports,
1577
new_revision_info = self.branch.last_revision_info()
1578
if new_revision_info != old_revision_info:
1580
repository = self.branch.repository
1581
pb = ui.ui_factory.nested_progress_bar()
1582
basis_tree.lock_read()
1584
new_basis_tree = self.branch.basis_tree()
1591
change_reporter=change_reporter)
1592
if (basis_tree.inventory.root is None and
1593
new_basis_tree.inventory.root is not None):
1594
self.set_root_id(new_basis_tree.get_root_id())
1598
# TODO - dedup parents list with things merged by pull ?
1599
# reuse the revisiontree we merged against to set the new
1601
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1602
# we have to pull the merge trees out again, because
1603
# merge_inner has set the ids. - this corner is not yet
1604
# layered well enough to prevent double handling.
1605
# XXX TODO: Fix the double handling: telling the tree about
1606
# the already known parent data is wasteful.
1607
merges = self.get_parent_ids()[1:]
1608
parent_trees.extend([
1609
(parent, repository.revision_tree(parent)) for
1611
self.set_parent_trees(parent_trees)
1618
def put_file_bytes_non_atomic(self, file_id, bytes):
1619
"""See MutableTree.put_file_bytes_non_atomic."""
1620
stream = file(self.id2abspath(file_id), 'wb')
1625
# TODO: update the hashcache here ?
1628
"""Yield all unversioned files in this WorkingTree.
1630
If there are any unversioned directories then only the directory is
1631
returned, not all its children. But if there are unversioned files
1632
under a versioned subdirectory, they are returned.
1634
Currently returned depth-first, sorted by name within directories.
1635
This is the same order used by 'osutils.walkdirs'.
1637
## TODO: Work from given directory downwards
1638
for path, dir_entry in self.inventory.directories():
1639
# mutter("search for unknowns in %r", path)
1640
dirabs = self.abspath(path)
1641
if not isdir(dirabs):
1642
# e.g. directory deleted
1646
for subf in os.listdir(dirabs):
1647
if self.bzrdir.is_control_filename(subf):
1649
if subf not in dir_entry.children:
1652
can_access) = osutils.normalized_filename(subf)
1653
except UnicodeDecodeError:
1654
path_os_enc = path.encode(osutils._fs_enc)
1655
relpath = path_os_enc + '/' + subf
1656
raise errors.BadFilenameEncoding(relpath,
1658
if subf_norm != subf and can_access:
1659
if subf_norm not in dir_entry.children:
1660
fl.append(subf_norm)
1666
subp = pathjoin(path, subf)
1669
def ignored_files(self):
1670
"""Yield list of PATH, IGNORE_PATTERN"""
1671
for subp in self.extras():
1672
pat = self.is_ignored(subp)
1676
def get_ignore_list(self):
1677
"""Return list of ignore patterns.
1679
Cached in the Tree object after the first call.
1681
ignoreset = getattr(self, '_ignoreset', None)
1682
if ignoreset is not None:
1685
ignore_globs = set()
1686
ignore_globs.update(ignores.get_runtime_ignores())
1687
ignore_globs.update(ignores.get_user_ignores())
1688
if self.has_filename(bzrlib.IGNORE_FILENAME):
1689
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1691
ignore_globs.update(ignores.parse_ignore_file(f))
1694
self._ignoreset = ignore_globs
1697
def _flush_ignore_list_cache(self):
1698
"""Resets the cached ignore list to force a cache rebuild."""
1699
self._ignoreset = None
1700
self._ignoreglobster = None
1702
def is_ignored(self, filename):
1703
r"""Check whether the filename matches an ignore pattern.
1705
Patterns containing '/' or '\' need to match the whole path;
1706
others match against only the last component.
1708
If the file is ignored, returns the pattern which caused it to
1709
be ignored, otherwise None. So this can simply be used as a
1710
boolean if desired."""
1711
if getattr(self, '_ignoreglobster', None) is None:
1712
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1713
return self._ignoreglobster.match(filename)
1715
def kind(self, file_id):
1716
return file_kind(self.id2abspath(file_id))
1718
def stored_kind(self, file_id):
1719
"""See Tree.stored_kind"""
1720
return self.inventory[file_id].kind
1722
def _comparison_data(self, entry, path):
1723
abspath = self.abspath(path)
1725
stat_value = os.lstat(abspath)
1727
if getattr(e, 'errno', None) == errno.ENOENT:
1734
mode = stat_value.st_mode
1735
kind = osutils.file_kind_from_stat_mode(mode)
1736
if not supports_executable():
1737
executable = entry is not None and entry.executable
1739
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1740
return kind, executable, stat_value
1742
def _file_size(self, entry, stat_value):
1743
return stat_value.st_size
1745
def last_revision(self):
1746
"""Return the last revision of the branch for this tree.
1748
This format tree does not support a separate marker for last-revision
1749
compared to the branch.
1751
See MutableTree.last_revision
1753
return self._last_revision()
1756
def _last_revision(self):
1757
"""helper for get_parent_ids."""
1758
return _mod_revision.ensure_null(self.branch.last_revision())
1760
def is_locked(self):
1761
return self._control_files.is_locked()
1763
def _must_be_locked(self):
1764
if not self.is_locked():
1765
raise errors.ObjectNotLocked(self)
1767
def lock_read(self):
1768
"""See Branch.lock_read, and WorkingTree.unlock."""
1769
if not self.is_locked():
1771
self.branch.lock_read()
1773
return self._control_files.lock_read()
1775
self.branch.unlock()
1778
def lock_tree_write(self):
1779
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1780
if not self.is_locked():
1782
self.branch.lock_read()
1784
return self._control_files.lock_write()
1786
self.branch.unlock()
1789
def lock_write(self):
1790
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1791
if not self.is_locked():
1793
self.branch.lock_write()
1795
return self._control_files.lock_write()
1797
self.branch.unlock()
1800
def get_physical_lock_status(self):
1801
return self._control_files.get_physical_lock_status()
1803
def _basis_inventory_name(self):
1804
return 'basis-inventory-cache'
1806
def _reset_data(self):
1807
"""Reset transient data that cannot be revalidated."""
1808
self._inventory_is_modified = False
1809
result = self._deserialize(self._transport.get('inventory'))
1810
self._set_inventory(result, dirty=False)
1812
@needs_tree_write_lock
1813
def set_last_revision(self, new_revision):
1814
"""Change the last revision in the working tree."""
1815
if self._change_last_revision(new_revision):
1816
self._cache_basis_inventory(new_revision)
1818
def _change_last_revision(self, new_revision):
1819
"""Template method part of set_last_revision to perform the change.
1821
This is used to allow WorkingTree3 instances to not affect branch
1822
when their last revision is set.
1824
if _mod_revision.is_null(new_revision):
1825
self.branch.set_revision_history([])
1828
self.branch.generate_revision_history(new_revision)
1829
except errors.NoSuchRevision:
1830
# not present in the repo - dont try to set it deeper than the tip
1831
self.branch.set_revision_history([new_revision])
1834
def _write_basis_inventory(self, xml):
1835
"""Write the basis inventory XML to the basis-inventory file"""
1836
path = self._basis_inventory_name()
1838
self._transport.put_file(path, sio,
1839
mode=self.bzrdir._get_file_mode())
1841
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1842
"""Create the text that will be saved in basis-inventory"""
1843
inventory.revision_id = revision_id
1844
return xml7.serializer_v7.write_inventory_to_string(inventory)
1846
def _cache_basis_inventory(self, new_revision):
1847
"""Cache new_revision as the basis inventory."""
1848
# TODO: this should allow the ready-to-use inventory to be passed in,
1849
# as commit already has that ready-to-use [while the format is the
1852
# this double handles the inventory - unpack and repack -
1853
# but is easier to understand. We can/should put a conditional
1854
# in here based on whether the inventory is in the latest format
1855
# - perhaps we should repack all inventories on a repository
1857
# the fast path is to copy the raw xml from the repository. If the
1858
# xml contains 'revision_id="', then we assume the right
1859
# revision_id is set. We must check for this full string, because a
1860
# root node id can legitimately look like 'revision_id' but cannot
1862
xml = self.branch.repository.get_inventory_xml(new_revision)
1863
firstline = xml.split('\n', 1)[0]
1864
if (not 'revision_id="' in firstline or
1865
'format="7"' not in firstline):
1866
inv = self.branch.repository.deserialise_inventory(
1868
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1869
self._write_basis_inventory(xml)
1870
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1873
def read_basis_inventory(self):
1874
"""Read the cached basis inventory."""
1875
path = self._basis_inventory_name()
1876
return self._transport.get_bytes(path)
1879
def read_working_inventory(self):
1880
"""Read the working inventory.
1882
:raises errors.InventoryModified: read_working_inventory will fail
1883
when the current in memory inventory has been modified.
1885
# conceptually this should be an implementation detail of the tree.
1886
# XXX: Deprecate this.
1887
# ElementTree does its own conversion from UTF-8, so open in
1889
if self._inventory_is_modified:
1890
raise errors.InventoryModified(self)
1891
result = self._deserialize(self._transport.get('inventory'))
1892
self._set_inventory(result, dirty=False)
1895
@needs_tree_write_lock
1896
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1898
"""Remove nominated files from the working inventory.
1900
:files: File paths relative to the basedir.
1901
:keep_files: If true, the files will also be kept.
1902
:force: Delete files and directories, even if they are changed and
1903
even if the directories are not empty.
1905
if isinstance(files, basestring):
1911
unknown_nested_files=set()
1913
def recurse_directory_to_add_files(directory):
1914
# Recurse directory and add all files
1915
# so we can check if they have changed.
1916
for parent_info, file_infos in\
1917
self.walkdirs(directory):
1918
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1919
# Is it versioned or ignored?
1920
if self.path2id(relpath) or self.is_ignored(relpath):
1921
# Add nested content for deletion.
1922
new_files.add(relpath)
1924
# Files which are not versioned and not ignored
1925
# should be treated as unknown.
1926
unknown_nested_files.add((relpath, None, kind))
1928
for filename in files:
1929
# Get file name into canonical form.
1930
abspath = self.abspath(filename)
1931
filename = self.relpath(abspath)
1932
if len(filename) > 0:
1933
new_files.add(filename)
1934
recurse_directory_to_add_files(filename)
1936
files = list(new_files)
1939
return # nothing to do
1941
# Sort needed to first handle directory content before the directory
1942
files.sort(reverse=True)
1944
# Bail out if we are going to delete files we shouldn't
1945
if not keep_files and not force:
1946
has_changed_files = len(unknown_nested_files) > 0
1947
if not has_changed_files:
1948
for (file_id, path, content_change, versioned, parent_id, name,
1949
kind, executable) in self.iter_changes(self.basis_tree(),
1950
include_unchanged=True, require_versioned=False,
1951
want_unversioned=True, specific_files=files):
1952
if versioned == (False, False):
1953
# The record is unknown ...
1954
if not self.is_ignored(path[1]):
1955
# ... but not ignored
1956
has_changed_files = True
1958
elif content_change and (kind[1] is not None):
1959
# Versioned and changed, but not deleted
1960
has_changed_files = True
1963
if has_changed_files:
1964
# Make delta show ALL applicable changes in error message.
1965
tree_delta = self.changes_from(self.basis_tree(),
1966
require_versioned=False, want_unversioned=True,
1967
specific_files=files)
1968
for unknown_file in unknown_nested_files:
1969
if unknown_file not in tree_delta.unversioned:
1970
tree_delta.unversioned.extend((unknown_file,))
1971
raise errors.BzrRemoveChangedFilesError(tree_delta)
1973
# Build inv_delta and delete files where applicable,
1974
# do this before any modifications to inventory.
1976
fid = self.path2id(f)
1979
message = "%s is not versioned." % (f,)
1982
# having removed it, it must be either ignored or unknown
1983
if self.is_ignored(f):
1987
textui.show_status(new_status, self.kind(fid), f,
1990
inv_delta.append((f, None, fid, None))
1991
message = "removed %s" % (f,)
1994
abs_path = self.abspath(f)
1995
if osutils.lexists(abs_path):
1996
if (osutils.isdir(abs_path) and
1997
len(os.listdir(abs_path)) > 0):
1999
osutils.rmtree(abs_path)
2001
message = "%s is not an empty directory "\
2002
"and won't be deleted." % (f,)
2004
osutils.delete_any(abs_path)
2005
message = "deleted %s" % (f,)
2006
elif message is not None:
2007
# Only care if we haven't done anything yet.
2008
message = "%s does not exist." % (f,)
2010
# Print only one message (if any) per file.
2011
if message is not None:
2013
self.apply_inventory_delta(inv_delta)
2015
@needs_tree_write_lock
2016
def revert(self, filenames=None, old_tree=None, backups=True,
2017
pb=DummyProgress(), report_changes=False):
2018
from bzrlib.conflicts import resolve
2021
symbol_versioning.warn('Using [] to revert all files is deprecated'
2022
' as of bzr 0.91. Please use None (the default) instead.',
2023
DeprecationWarning, stacklevel=2)
2024
if old_tree is None:
2025
basis_tree = self.basis_tree()
2026
basis_tree.lock_read()
2027
old_tree = basis_tree
2031
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2033
if filenames is None and len(self.get_parent_ids()) > 1:
2035
last_revision = self.last_revision()
2036
if last_revision != _mod_revision.NULL_REVISION:
2037
if basis_tree is None:
2038
basis_tree = self.basis_tree()
2039
basis_tree.lock_read()
2040
parent_trees.append((last_revision, basis_tree))
2041
self.set_parent_trees(parent_trees)
2044
resolve(self, filenames, ignore_misses=True, recursive=True)
2046
if basis_tree is not None:
2050
def revision_tree(self, revision_id):
2051
"""See Tree.revision_tree.
2053
WorkingTree can supply revision_trees for the basis revision only
2054
because there is only one cached inventory in the bzr directory.
2056
if revision_id == self.last_revision():
2058
xml = self.read_basis_inventory()
2059
except errors.NoSuchFile:
2063
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2064
# dont use the repository revision_tree api because we want
2065
# to supply the inventory.
2066
if inv.revision_id == revision_id:
2067
return revisiontree.RevisionTree(self.branch.repository,
2069
except errors.BadInventoryFormat:
2071
# raise if there was no inventory, or if we read the wrong inventory.
2072
raise errors.NoSuchRevisionInTree(self, revision_id)
2074
# XXX: This method should be deprecated in favour of taking in a proper
2075
# new Inventory object.
2076
@needs_tree_write_lock
2077
def set_inventory(self, new_inventory_list):
2078
from bzrlib.inventory import (Inventory,
2082
inv = Inventory(self.get_root_id())
2083
for path, file_id, parent, kind in new_inventory_list:
2084
name = os.path.basename(path)
2087
# fixme, there should be a factory function inv,add_??
2088
if kind == 'directory':
2089
inv.add(InventoryDirectory(file_id, name, parent))
2090
elif kind == 'file':
2091
inv.add(InventoryFile(file_id, name, parent))
2092
elif kind == 'symlink':
2093
inv.add(InventoryLink(file_id, name, parent))
2095
raise errors.BzrError("unknown kind %r" % kind)
2096
self._write_inventory(inv)
2098
@needs_tree_write_lock
2099
def set_root_id(self, file_id):
2100
"""Set the root id for this tree."""
2104
'WorkingTree.set_root_id with fileid=None')
2105
file_id = osutils.safe_file_id(file_id)
2106
self._set_root_id(file_id)
2108
def _set_root_id(self, file_id):
2109
"""Set the root id for this tree, in a format specific manner.
2111
:param file_id: The file id to assign to the root. It must not be
2112
present in the current inventory or an error will occur. It must
2113
not be None, but rather a valid file id.
2115
inv = self._inventory
2116
orig_root_id = inv.root.file_id
2117
# TODO: it might be nice to exit early if there was nothing
2118
# to do, saving us from trigger a sync on unlock.
2119
self._inventory_is_modified = True
2120
# we preserve the root inventory entry object, but
2121
# unlinkit from the byid index
2122
del inv._byid[inv.root.file_id]
2123
inv.root.file_id = file_id
2124
# and link it into the index with the new changed id.
2125
inv._byid[inv.root.file_id] = inv.root
2126
# and finally update all children to reference the new id.
2127
# XXX: this should be safe to just look at the root.children
2128
# list, not the WHOLE INVENTORY.
2131
if entry.parent_id == orig_root_id:
2132
entry.parent_id = inv.root.file_id
2135
"""See Branch.unlock.
2137
WorkingTree locking just uses the Branch locking facilities.
2138
This is current because all working trees have an embedded branch
2139
within them. IF in the future, we were to make branch data shareable
2140
between multiple working trees, i.e. via shared storage, then we
2141
would probably want to lock both the local tree, and the branch.
2143
raise NotImplementedError(self.unlock)
2145
def update(self, change_reporter=None, possible_transports=None):
2146
"""Update a working tree along its branch.
2148
This will update the branch if its bound too, which means we have
2149
multiple trees involved:
2151
- The new basis tree of the master.
2152
- The old basis tree of the branch.
2153
- The old basis tree of the working tree.
2154
- The current working tree state.
2156
Pathologically, all three may be different, and non-ancestors of each
2157
other. Conceptually we want to:
2159
- Preserve the wt.basis->wt.state changes
2160
- Transform the wt.basis to the new master basis.
2161
- Apply a merge of the old branch basis to get any 'local' changes from
2163
- Restore the wt.basis->wt.state changes.
2165
There isn't a single operation at the moment to do that, so we:
2166
- Merge current state -> basis tree of the master w.r.t. the old tree
2168
- Do a 'normal' merge of the old branch basis if it is relevant.
2170
if self.branch.get_bound_location() is not None:
2172
update_branch = True
2174
self.lock_tree_write()
2175
update_branch = False
2178
old_tip = self.branch.update(possible_transports)
2181
return self._update_tree(old_tip, change_reporter)
2185
@needs_tree_write_lock
2186
def _update_tree(self, old_tip=None, change_reporter=None):
2187
"""Update a tree to the master branch.
2189
:param old_tip: if supplied, the previous tip revision the branch,
2190
before it was changed to the master branch's tip.
2192
# here if old_tip is not None, it is the old tip of the branch before
2193
# it was updated from the master branch. This should become a pending
2194
# merge in the working tree to preserve the user existing work. we
2195
# cant set that until we update the working trees last revision to be
2196
# one from the new branch, because it will just get absorbed by the
2197
# parent de-duplication logic.
2199
# We MUST save it even if an error occurs, because otherwise the users
2200
# local work is unreferenced and will appear to have been lost.
2204
last_rev = self.get_parent_ids()[0]
2206
last_rev = _mod_revision.NULL_REVISION
2207
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2208
# merge tree state up to new branch tip.
2209
basis = self.basis_tree()
2212
to_tree = self.branch.basis_tree()
2213
if basis.inventory.root is None:
2214
self.set_root_id(to_tree.get_root_id())
2216
result += merge.merge_inner(
2221
change_reporter=change_reporter)
2224
# TODO - dedup parents list with things merged by pull ?
2225
# reuse the tree we've updated to to set the basis:
2226
parent_trees = [(self.branch.last_revision(), to_tree)]
2227
merges = self.get_parent_ids()[1:]
2228
# Ideally we ask the tree for the trees here, that way the working
2229
# tree can decide whether to give us the entire tree or give us a
2230
# lazy initialised tree. dirstate for instance will have the trees
2231
# in ram already, whereas a last-revision + basis-inventory tree
2232
# will not, but also does not need them when setting parents.
2233
for parent in merges:
2234
parent_trees.append(
2235
(parent, self.branch.repository.revision_tree(parent)))
2236
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2237
parent_trees.append(
2238
(old_tip, self.branch.repository.revision_tree(old_tip)))
2239
self.set_parent_trees(parent_trees)
2240
last_rev = parent_trees[0][0]
2242
# the working tree had the same last-revision as the master
2243
# branch did. We may still have pivot local work from the local
2244
# branch into old_tip:
2245
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2246
self.add_parent_tree_id(old_tip)
2247
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2248
and old_tip != last_rev):
2249
# our last revision was not the prior branch last revision
2250
# and we have converted that last revision to a pending merge.
2251
# base is somewhere between the branch tip now
2252
# and the now pending merge
2254
# Since we just modified the working tree and inventory, flush out
2255
# the current state, before we modify it again.
2256
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2257
# requires it only because TreeTransform directly munges the
2258
# inventory and calls tree._write_inventory(). Ultimately we
2259
# should be able to remove this extra flush.
2261
graph = self.branch.repository.get_graph()
2262
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2264
base_tree = self.branch.repository.revision_tree(base_rev_id)
2265
other_tree = self.branch.repository.revision_tree(old_tip)
2266
result += merge.merge_inner(
2271
change_reporter=change_reporter)
2274
def _write_hashcache_if_dirty(self):
2275
"""Write out the hashcache if it is dirty."""
2276
if self._hashcache.needs_write:
2278
self._hashcache.write()
2280
if e.errno not in (errno.EPERM, errno.EACCES):
2282
# TODO: jam 20061219 Should this be a warning? A single line
2283
# warning might be sufficient to let the user know what
2285
mutter('Could not write hashcache for %s\nError: %s',
2286
self._hashcache.cache_file_name(), e)
2288
@needs_tree_write_lock
2289
def _write_inventory(self, inv):
2290
"""Write inventory as the current inventory."""
2291
self._set_inventory(inv, dirty=True)
2294
def set_conflicts(self, arg):
2295
raise errors.UnsupportedOperation(self.set_conflicts, self)
2297
def add_conflicts(self, arg):
2298
raise errors.UnsupportedOperation(self.add_conflicts, self)
2301
def conflicts(self):
2302
conflicts = _mod_conflicts.ConflictList()
2303
for conflicted in self._iter_conflicts():
2306
if file_kind(self.abspath(conflicted)) != "file":
2308
except errors.NoSuchFile:
2311
for suffix in ('.THIS', '.OTHER'):
2313
kind = file_kind(self.abspath(conflicted+suffix))
2316
except errors.NoSuchFile:
2320
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2321
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2323
file_id=self.path2id(conflicted)))
2326
def walkdirs(self, prefix=""):
2327
"""Walk the directories of this tree.
2329
returns a generator which yields items in the form:
2330
((curren_directory_path, fileid),
2331
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2334
This API returns a generator, which is only valid during the current
2335
tree transaction - within a single lock_read or lock_write duration.
2337
If the tree is not locked, it may cause an error to be raised,
2338
depending on the tree implementation.
2340
disk_top = self.abspath(prefix)
2341
if disk_top.endswith('/'):
2342
disk_top = disk_top[:-1]
2343
top_strip_len = len(disk_top) + 1
2344
inventory_iterator = self._walkdirs(prefix)
2345
disk_iterator = osutils.walkdirs(disk_top, prefix)
2347
current_disk = disk_iterator.next()
2348
disk_finished = False
2350
if not (e.errno == errno.ENOENT or
2351
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2354
disk_finished = True
2356
current_inv = inventory_iterator.next()
2357
inv_finished = False
2358
except StopIteration:
2361
while not inv_finished or not disk_finished:
2363
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2364
cur_disk_dir_content) = current_disk
2366
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2367
cur_disk_dir_content) = ((None, None), None)
2368
if not disk_finished:
2369
# strip out .bzr dirs
2370
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2371
len(cur_disk_dir_content) > 0):
2372
# osutils.walkdirs can be made nicer -
2373
# yield the path-from-prefix rather than the pathjoined
2375
bzrdir_loc = bisect_left(cur_disk_dir_content,
2377
if (bzrdir_loc < len(cur_disk_dir_content)
2378
and self.bzrdir.is_control_filename(
2379
cur_disk_dir_content[bzrdir_loc][0])):
2380
# we dont yield the contents of, or, .bzr itself.
2381
del cur_disk_dir_content[bzrdir_loc]
2383
# everything is unknown
2386
# everything is missing
2389
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2391
# disk is before inventory - unknown
2392
dirblock = [(relpath, basename, kind, stat, None, None) for
2393
relpath, basename, kind, stat, top_path in
2394
cur_disk_dir_content]
2395
yield (cur_disk_dir_relpath, None), dirblock
2397
current_disk = disk_iterator.next()
2398
except StopIteration:
2399
disk_finished = True
2401
# inventory is before disk - missing.
2402
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2403
for relpath, basename, dkind, stat, fileid, kind in
2405
yield (current_inv[0][0], current_inv[0][1]), dirblock
2407
current_inv = inventory_iterator.next()
2408
except StopIteration:
2411
# versioned present directory
2412
# merge the inventory and disk data together
2414
for relpath, subiterator in itertools.groupby(sorted(
2415
current_inv[1] + cur_disk_dir_content,
2416
key=operator.itemgetter(0)), operator.itemgetter(1)):
2417
path_elements = list(subiterator)
2418
if len(path_elements) == 2:
2419
inv_row, disk_row = path_elements
2420
# versioned, present file
2421
dirblock.append((inv_row[0],
2422
inv_row[1], disk_row[2],
2423
disk_row[3], inv_row[4],
2425
elif len(path_elements[0]) == 5:
2427
dirblock.append((path_elements[0][0],
2428
path_elements[0][1], path_elements[0][2],
2429
path_elements[0][3], None, None))
2430
elif len(path_elements[0]) == 6:
2431
# versioned, absent file.
2432
dirblock.append((path_elements[0][0],
2433
path_elements[0][1], 'unknown', None,
2434
path_elements[0][4], path_elements[0][5]))
2436
raise NotImplementedError('unreachable code')
2437
yield current_inv[0], dirblock
2439
current_inv = inventory_iterator.next()
2440
except StopIteration:
2443
current_disk = disk_iterator.next()
2444
except StopIteration:
2445
disk_finished = True
2447
def _walkdirs(self, prefix=""):
2448
"""Walk the directories of this tree.
2450
:prefix: is used as the directrory to start with.
2451
returns a generator which yields items in the form:
2452
((curren_directory_path, fileid),
2453
[(file1_path, file1_name, file1_kind, None, file1_id,
2456
_directory = 'directory'
2457
# get the root in the inventory
2458
inv = self.inventory
2459
top_id = inv.path2id(prefix)
2463
pending = [(prefix, '', _directory, None, top_id, None)]
2466
currentdir = pending.pop()
2467
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2468
top_id = currentdir[4]
2470
relroot = currentdir[0] + '/'
2473
# FIXME: stash the node in pending
2475
if entry.kind == 'directory':
2476
for name, child in entry.sorted_children():
2477
dirblock.append((relroot + name, name, child.kind, None,
2478
child.file_id, child.kind
2480
yield (currentdir[0], entry.file_id), dirblock
2481
# push the user specified dirs from dirblock
2482
for dir in reversed(dirblock):
2483
if dir[2] == _directory:
2486
@needs_tree_write_lock
2487
def auto_resolve(self):
2488
"""Automatically resolve text conflicts according to contents.
2490
Only text conflicts are auto_resolvable. Files with no conflict markers
2491
are considered 'resolved', because bzr always puts conflict markers
2492
into files that have text conflicts. The corresponding .THIS .BASE and
2493
.OTHER files are deleted, as per 'resolve'.
2494
:return: a tuple of ConflictLists: (un_resolved, resolved).
2496
un_resolved = _mod_conflicts.ConflictList()
2497
resolved = _mod_conflicts.ConflictList()
2498
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2499
for conflict in self.conflicts():
2500
if (conflict.typestring != 'text conflict' or
2501
self.kind(conflict.file_id) != 'file'):
2502
un_resolved.append(conflict)
2504
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2506
for line in my_file:
2507
if conflict_re.search(line):
2508
un_resolved.append(conflict)
2511
resolved.append(conflict)
2514
resolved.remove_files(self)
2515
self.set_conflicts(un_resolved)
2516
return un_resolved, resolved
2520
tree_basis = self.basis_tree()
2521
tree_basis.lock_read()
2523
repo_basis = self.branch.repository.revision_tree(
2524
self.last_revision())
2525
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2526
raise errors.BzrCheckError(
2527
"Mismatched basis inventory content.")
2532
def _validate(self):
2533
"""Validate internal structures.
2535
This is meant mostly for the test suite. To give it a chance to detect
2536
corruption after actions have occurred. The default implementation is a
2539
:return: None. An exception should be raised if there is an error.
2544
def _get_rules_searcher(self, default_searcher):
2545
"""See Tree._get_rules_searcher."""
2546
if self._rules_searcher is None:
2547
self._rules_searcher = super(WorkingTree,
2548
self)._get_rules_searcher(default_searcher)
2549
return self._rules_searcher
2551
def get_shelf_manager(self):
2552
"""Return the ShelfManager for this WorkingTree."""
2553
from bzrlib.shelf import ShelfManager
2554
return ShelfManager(self, self._transport)
2557
class WorkingTree2(WorkingTree):
2558
"""This is the Format 2 working tree.
2560
This was the first weave based working tree.
2561
- uses os locks for locking.
2562
- uses the branch last-revision.
2565
def __init__(self, *args, **kwargs):
2566
super(WorkingTree2, self).__init__(*args, **kwargs)
2567
# WorkingTree2 has more of a constraint that self._inventory must
2568
# exist. Because this is an older format, we don't mind the overhead
2569
# caused by the extra computation here.
2571
# Newer WorkingTree's should only have self._inventory set when they
2573
if self._inventory is None:
2574
self.read_working_inventory()
2576
def lock_tree_write(self):
2577
"""See WorkingTree.lock_tree_write().
2579
In Format2 WorkingTrees we have a single lock for the branch and tree
2580
so lock_tree_write() degrades to lock_write().
2582
self.branch.lock_write()
2584
return self._control_files.lock_write()
2586
self.branch.unlock()
2590
# do non-implementation specific cleanup
2593
# we share control files:
2594
if self._control_files._lock_count == 3:
2595
# _inventory_is_modified is always False during a read lock.
2596
if self._inventory_is_modified:
2598
self._write_hashcache_if_dirty()
2600
# reverse order of locking.
2602
return self._control_files.unlock()
2604
self.branch.unlock()
2607
class WorkingTree3(WorkingTree):
2608
"""This is the Format 3 working tree.
2610
This differs from the base WorkingTree by:
2611
- having its own file lock
2612
- having its own last-revision property.
2614
This is new in bzr 0.8
2618
def _last_revision(self):
2619
"""See Mutable.last_revision."""
2621
return self._transport.get_bytes('last-revision')
2622
except errors.NoSuchFile:
2623
return _mod_revision.NULL_REVISION
2625
def _change_last_revision(self, revision_id):
2626
"""See WorkingTree._change_last_revision."""
2627
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2629
self._transport.delete('last-revision')
2630
except errors.NoSuchFile:
2634
self._transport.put_bytes('last-revision', revision_id,
2635
mode=self.bzrdir._get_file_mode())
2638
@needs_tree_write_lock
2639
def set_conflicts(self, conflicts):
2640
self._put_rio('conflicts', conflicts.to_stanzas(),
2643
@needs_tree_write_lock
2644
def add_conflicts(self, new_conflicts):
2645
conflict_set = set(self.conflicts())
2646
conflict_set.update(set(list(new_conflicts)))
2647
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2648
key=_mod_conflicts.Conflict.sort_key)))
2651
def conflicts(self):
2653
confile = self._transport.get('conflicts')
2654
except errors.NoSuchFile:
2655
return _mod_conflicts.ConflictList()
2658
if confile.next() != CONFLICT_HEADER_1 + '\n':
2659
raise errors.ConflictFormatError()
2660
except StopIteration:
2661
raise errors.ConflictFormatError()
2662
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2667
# do non-implementation specific cleanup
2669
if self._control_files._lock_count == 1:
2670
# _inventory_is_modified is always False during a read lock.
2671
if self._inventory_is_modified:
2673
self._write_hashcache_if_dirty()
2674
# reverse order of locking.
2676
return self._control_files.unlock()
2678
self.branch.unlock()
2681
def get_conflicted_stem(path):
2682
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2683
if path.endswith(suffix):
2684
return path[:-len(suffix)]
2687
class WorkingTreeFormat(object):
2688
"""An encapsulation of the initialization and open routines for a format.
2690
Formats provide three things:
2691
* An initialization routine,
2695
Formats are placed in an dict by their format string for reference
2696
during workingtree opening. Its not required that these be instances, they
2697
can be classes themselves with class methods - it simply depends on
2698
whether state is needed for a given format or not.
2700
Once a format is deprecated, just deprecate the initialize and open
2701
methods on the format class. Do not deprecate the object, as the
2702
object will be created every time regardless.
2705
_default_format = None
2706
"""The default format used for new trees."""
2709
"""The known formats."""
2711
requires_rich_root = False
2713
upgrade_recommended = False
2716
def find_format(klass, a_bzrdir):
2717
"""Return the format for the working tree object in a_bzrdir."""
2719
transport = a_bzrdir.get_workingtree_transport(None)
2720
format_string = transport.get("format").read()
2721
return klass._formats[format_string]
2722
except errors.NoSuchFile:
2723
raise errors.NoWorkingTree(base=transport.base)
2725
raise errors.UnknownFormatError(format=format_string,
2726
kind="working tree")
2728
def __eq__(self, other):
2729
return self.__class__ is other.__class__
2731
def __ne__(self, other):
2732
return not (self == other)
2735
def get_default_format(klass):
2736
"""Return the current default format."""
2737
return klass._default_format
2739
def get_format_string(self):
2740
"""Return the ASCII format string that identifies this format."""
2741
raise NotImplementedError(self.get_format_string)
2743
def get_format_description(self):
2744
"""Return the short description for this format."""
2745
raise NotImplementedError(self.get_format_description)
2747
def is_supported(self):
2748
"""Is this format supported?
2750
Supported formats can be initialized and opened.
2751
Unsupported formats may not support initialization or committing or
2752
some other features depending on the reason for not being supported.
2756
def supports_content_filtering(self):
2757
"""True if this format supports content filtering."""
2760
def supports_views(self):
2761
"""True if this format supports stored views."""
2765
def register_format(klass, format):
2766
klass._formats[format.get_format_string()] = format
2769
def set_default_format(klass, format):
2770
klass._default_format = format
2773
def unregister_format(klass, format):
2774
del klass._formats[format.get_format_string()]
2777
class WorkingTreeFormat2(WorkingTreeFormat):
2778
"""The second working tree format.
2780
This format modified the hash cache from the format 1 hash cache.
2783
upgrade_recommended = True
2785
def get_format_description(self):
2786
"""See WorkingTreeFormat.get_format_description()."""
2787
return "Working tree format 2"
2789
def _stub_initialize_on_transport(self, transport, file_mode):
2790
"""Workaround: create control files for a remote working tree.
2792
This ensures that it can later be updated and dealt with locally,
2793
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2794
no working tree. (See bug #43064).
2797
inv = inventory.Inventory()
2798
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2800
transport.put_file('inventory', sio, file_mode)
2801
transport.put_bytes('pending-merges', '', file_mode)
2803
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2804
accelerator_tree=None, hardlink=False):
2805
"""See WorkingTreeFormat.initialize()."""
2806
if not isinstance(a_bzrdir.transport, LocalTransport):
2807
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2808
if from_branch is not None:
2809
branch = from_branch
2811
branch = a_bzrdir.open_branch()
2812
if revision_id is None:
2813
revision_id = _mod_revision.ensure_null(branch.last_revision())
2816
branch.generate_revision_history(revision_id)
2819
inv = inventory.Inventory()
2820
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2826
basis_tree = branch.repository.revision_tree(revision_id)
2827
if basis_tree.inventory.root is not None:
2828
wt.set_root_id(basis_tree.get_root_id())
2829
# set the parent list and cache the basis tree.
2830
if _mod_revision.is_null(revision_id):
2833
parent_trees = [(revision_id, basis_tree)]
2834
wt.set_parent_trees(parent_trees)
2835
transform.build_tree(basis_tree, wt)
2839
super(WorkingTreeFormat2, self).__init__()
2840
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2842
def open(self, a_bzrdir, _found=False):
2843
"""Return the WorkingTree object for a_bzrdir
2845
_found is a private parameter, do not use it. It is used to indicate
2846
if format probing has already been done.
2849
# we are being called directly and must probe.
2850
raise NotImplementedError
2851
if not isinstance(a_bzrdir.transport, LocalTransport):
2852
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2853
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2859
class WorkingTreeFormat3(WorkingTreeFormat):
2860
"""The second working tree format updated to record a format marker.
2863
- exists within a metadir controlling .bzr
2864
- includes an explicit version marker for the workingtree control
2865
files, separate from the BzrDir format
2866
- modifies the hash cache format
2868
- uses a LockDir to guard access for writes.
2871
upgrade_recommended = True
2873
def get_format_string(self):
2874
"""See WorkingTreeFormat.get_format_string()."""
2875
return "Bazaar-NG Working Tree format 3"
2877
def get_format_description(self):
2878
"""See WorkingTreeFormat.get_format_description()."""
2879
return "Working tree format 3"
2881
_lock_file_name = 'lock'
2882
_lock_class = LockDir
2884
_tree_class = WorkingTree3
2886
def __get_matchingbzrdir(self):
2887
return bzrdir.BzrDirMetaFormat1()
2889
_matchingbzrdir = property(__get_matchingbzrdir)
2891
def _open_control_files(self, a_bzrdir):
2892
transport = a_bzrdir.get_workingtree_transport(None)
2893
return LockableFiles(transport, self._lock_file_name,
2896
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2897
accelerator_tree=None, hardlink=False):
2898
"""See WorkingTreeFormat.initialize().
2900
:param revision_id: if supplied, create a working tree at a different
2901
revision than the branch is at.
2902
:param accelerator_tree: A tree which can be used for retrieving file
2903
contents more quickly than the revision tree, i.e. a workingtree.
2904
The revision tree will be used for cases where accelerator_tree's
2905
content is different.
2906
:param hardlink: If true, hard-link files from accelerator_tree,
2909
if not isinstance(a_bzrdir.transport, LocalTransport):
2910
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2911
transport = a_bzrdir.get_workingtree_transport(self)
2912
control_files = self._open_control_files(a_bzrdir)
2913
control_files.create_lock()
2914
control_files.lock_write()
2915
transport.put_bytes('format', self.get_format_string(),
2916
mode=a_bzrdir._get_file_mode())
2917
if from_branch is not None:
2918
branch = from_branch
2920
branch = a_bzrdir.open_branch()
2921
if revision_id is None:
2922
revision_id = _mod_revision.ensure_null(branch.last_revision())
2923
# WorkingTree3 can handle an inventory which has a unique root id.
2924
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2925
# those trees. And because there isn't a format bump inbetween, we
2926
# are maintaining compatibility with older clients.
2927
# inv = Inventory(root_id=gen_root_id())
2928
inv = self._initial_inventory()
2929
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2935
_control_files=control_files)
2936
wt.lock_tree_write()
2938
basis_tree = branch.repository.revision_tree(revision_id)
2939
# only set an explicit root id if there is one to set.
2940
if basis_tree.inventory.root is not None:
2941
wt.set_root_id(basis_tree.get_root_id())
2942
if revision_id == _mod_revision.NULL_REVISION:
2943
wt.set_parent_trees([])
2945
wt.set_parent_trees([(revision_id, basis_tree)])
2946
transform.build_tree(basis_tree, wt)
2948
# Unlock in this order so that the unlock-triggers-flush in
2949
# WorkingTree is given a chance to fire.
2950
control_files.unlock()
2954
def _initial_inventory(self):
2955
return inventory.Inventory()
2958
super(WorkingTreeFormat3, self).__init__()
2960
def open(self, a_bzrdir, _found=False):
2961
"""Return the WorkingTree object for a_bzrdir
2963
_found is a private parameter, do not use it. It is used to indicate
2964
if format probing has already been done.
2967
# we are being called directly and must probe.
2968
raise NotImplementedError
2969
if not isinstance(a_bzrdir.transport, LocalTransport):
2970
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2971
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2974
def _open(self, a_bzrdir, control_files):
2975
"""Open the tree itself.
2977
:param a_bzrdir: the dir for the tree.
2978
:param control_files: the control files for the tree.
2980
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2984
_control_files=control_files)
2987
return self.get_format_string()
2990
__default_format = WorkingTreeFormat4()
2991
WorkingTreeFormat.register_format(__default_format)
2992
WorkingTreeFormat.register_format(WorkingTreeFormat6())
2993
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2994
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2995
WorkingTreeFormat.set_default_format(__default_format)
2996
# formats which have no format string are not discoverable
2997
# and not independently creatable, so are not registered.
2998
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
