1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.filters import filtered_input_file
106
from bzrlib.trace import mutter, note
107
from bzrlib.transport.local import LocalTransport
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
110
from bzrlib.rio import RioReader, rio_file, Stanza
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
124
class TreeEntry(object):
125
"""An entry that implements the minimum interface used by commands.
127
This needs further inspection, it may be better to have
128
InventoryEntries without ids - though that seems wrong. For now,
129
this is a parallel hierarchy to InventoryEntry, and needs to become
130
one of several things: decorates to that hierarchy, children of, or
132
Another note is that these objects are currently only used when there is
133
no InventoryEntry available - i.e. for unversioned objects.
134
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
137
def __eq__(self, other):
138
# yes, this us ugly, TODO: best practice __eq__ style.
139
return (isinstance(other, TreeEntry)
140
and other.__class__ == self.__class__)
142
def kind_character(self):
146
class TreeDirectory(TreeEntry):
147
"""See TreeEntry. This is a directory in a working tree."""
149
def __eq__(self, other):
150
return (isinstance(other, TreeDirectory)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeFile(TreeEntry):
158
"""See TreeEntry. This is a regular file in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeFile)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeLink(TreeEntry):
169
"""See TreeEntry. This is a symlink in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeLink)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class WorkingTree(bzrlib.mutabletree.MutableTree):
180
"""Working copy tree.
182
The inventory is held in the `Branch` working-inventory, and the
183
files are in a directory on disk.
185
It is possible for a `WorkingTree` to have a filename which is
186
not listed in the Inventory and vice versa.
189
def __init__(self, basedir='.',
190
branch=DEPRECATED_PARAMETER,
196
"""Construct a WorkingTree instance. This is not a public API.
198
:param branch: A branch to override probing for the branch.
200
self._format = _format
201
self.bzrdir = _bzrdir
203
raise errors.BzrError("Please use bzrdir.open_workingtree or "
204
"WorkingTree.open() to obtain a WorkingTree.")
205
basedir = safe_unicode(basedir)
206
mutter("opening working tree %r", basedir)
207
if deprecated_passed(branch):
208
self._branch = branch
210
self._branch = self.bzrdir.open_branch()
211
self.basedir = realpath(basedir)
212
# if branch is at our basedir and is a format 6 or less
213
if isinstance(self._format, WorkingTreeFormat2):
214
# share control object
215
self._control_files = self.branch.control_files
217
# assume all other formats have their own control files.
218
self._control_files = _control_files
219
self._transport = self._control_files._transport
220
# update the whole cache up front and write to disk if anything changed;
221
# in the future we might want to do this more selectively
222
# two possible ways offer themselves : in self._unlock, write the cache
223
# if needed, or, when the cache sees a change, append it to the hash
224
# cache file, and have the parser take the most recent entry for a
226
wt_trans = self.bzrdir.get_workingtree_transport(None)
227
cache_filename = wt_trans.local_abspath('stat-cache')
228
self._hashcache = hashcache.HashCache(basedir, cache_filename,
229
self.bzrdir._get_file_mode(),
230
self._content_filter_stack_provider())
233
# is this scan needed ? it makes things kinda slow.
240
if _inventory is None:
241
# This will be acquired on lock_read() or lock_write()
242
self._inventory_is_modified = False
243
self._inventory = None
245
# the caller of __init__ has provided an inventory,
246
# we assume they know what they are doing - as its only
247
# the Format factory and creation methods that are
248
# permitted to do this.
249
self._set_inventory(_inventory, dirty=False)
250
self._detect_case_handling()
251
self._rules_searcher = None
253
def _detect_case_handling(self):
254
wt_trans = self.bzrdir.get_workingtree_transport(None)
256
wt_trans.stat("FoRMaT")
257
except errors.NoSuchFile:
258
self.case_sensitive = True
260
self.case_sensitive = False
262
self._setup_directory_is_tree_reference()
265
fget=lambda self: self._branch,
266
doc="""The branch this WorkingTree is connected to.
268
This cannot be set - it is reflective of the actual disk structure
269
the working tree has been constructed from.
272
def break_lock(self):
273
"""Break a lock if one is present from another instance.
275
Uses the ui factory to ask for confirmation if the lock may be from
278
This will probe the repository for its lock as well.
280
self._control_files.break_lock()
281
self.branch.break_lock()
283
def requires_rich_root(self):
284
return self._format.requires_rich_root
286
def supports_tree_reference(self):
289
def _set_inventory(self, inv, dirty):
290
"""Set the internal cached inventory.
292
:param inv: The inventory to set.
293
:param dirty: A boolean indicating whether the inventory is the same
294
logical inventory as whats on disk. If True the inventory is not
295
the same and should be written to disk or data will be lost, if
296
False then the inventory is the same as that on disk and any
297
serialisation would be unneeded overhead.
299
self._inventory = inv
300
self._inventory_is_modified = dirty
303
def open(path=None, _unsupported=False):
304
"""Open an existing working tree at path.
308
path = osutils.getcwd()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
313
def open_containing(path=None):
314
"""Open an existing working tree which has its root about path.
316
This probes for a working tree at path and searches upwards from there.
318
Basically we keep looking up until we find the control directory or
319
run into /. If there isn't one, raises NotBranchError.
320
TODO: give this a new exception.
321
If there is one, it is returned, along with the unused portion of path.
323
:return: The WorkingTree that contains 'path', and the rest of path
326
path = osutils.getcwd()
327
control, relpath = bzrdir.BzrDir.open_containing(path)
329
return control.open_workingtree(), relpath
332
def open_downlevel(path=None):
333
"""Open an unsupported working tree.
335
Only intended for advanced situations like upgrading part of a bzrdir.
337
return WorkingTree.open(path, _unsupported=True)
340
def find_trees(location):
341
def list_current(transport):
342
return [d for d in transport.list_dir('') if d != '.bzr']
343
def evaluate(bzrdir):
345
tree = bzrdir.open_workingtree()
346
except errors.NoWorkingTree:
350
transport = get_transport(location)
351
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
352
list_current=list_current)
353
return [t for t in iterator if t is not None]
355
# should be deprecated - this is slow and in any case treating them as a
356
# container is (we now know) bad style -- mbp 20070302
357
## @deprecated_method(zero_fifteen)
359
"""Iterate through file_ids for this tree.
361
file_ids are in a WorkingTree if they are in the working inventory
362
and the working file exists.
364
inv = self._inventory
365
for path, ie in inv.iter_entries():
366
if osutils.lexists(self.abspath(path)):
369
def all_file_ids(self):
370
"""See Tree.iter_all_file_ids"""
371
return set(self.inventory)
374
return "<%s of %s>" % (self.__class__.__name__,
375
getattr(self, 'basedir', None))
377
def abspath(self, filename):
378
return pathjoin(self.basedir, filename)
380
def basis_tree(self):
381
"""Return RevisionTree for the current last revision.
383
If the left most parent is a ghost then the returned tree will be an
384
empty tree - one obtained by calling
385
repository.revision_tree(NULL_REVISION).
388
revision_id = self.get_parent_ids()[0]
390
# no parents, return an empty revision tree.
391
# in the future this should return the tree for
392
# 'empty:' - the implicit root empty tree.
393
return self.branch.repository.revision_tree(
394
_mod_revision.NULL_REVISION)
396
return self.revision_tree(revision_id)
397
except errors.NoSuchRevision:
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except (errors.RevisionNotPresent, errors.NoSuchRevision):
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(
412
_mod_revision.NULL_REVISION)
415
self._flush_ignore_list_cache()
417
def relpath(self, path):
418
"""Return the local path portion from a given path.
420
The path may be absolute or relative. If its a relative path it is
421
interpreted relative to the python current working directory.
423
return osutils.relpath(self.basedir, path)
425
def has_filename(self, filename):
426
return osutils.lexists(self.abspath(filename))
428
def get_file(self, file_id, path=None, filtered=True):
429
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
431
def get_file_with_stat(self, file_id, path=None, filtered=True,
433
"""See MutableTree.get_file_with_stat."""
435
path = self.id2path(file_id)
436
file_obj = self.get_file_byname(path, filtered=False)
437
stat_value = _fstat(file_obj.fileno())
438
if self.supports_content_filtering() and filtered:
439
filters = self._content_filter_stack(filename)
440
file_obj = filtered_input_file(file_obj, filters)
441
return (file_obj, stat_value)
443
def get_file_text(self, file_id, path=None, filtered=True):
444
return self.get_file(file_id, path=path, filtered=filtered).read()
446
def get_file_byname(self, filename, filtered=True):
447
path = self.abspath(filename)
449
if self.supports_content_filtering() and filtered:
450
filters = self._content_filter_stack(filename)
451
return filtered_input_file(f, filters)
455
def get_file_lines(self, file_id, path=None, filtered=True):
456
"""See Tree.get_file_lines()"""
457
file = self.get_file(file_id, path, filtered=filtered)
459
return file.readlines()
464
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
465
"""See Tree.annotate_iter
467
This implementation will use the basis tree implementation if possible.
468
Lines not in the basis are attributed to CURRENT_REVISION
470
If there are pending merges, lines added by those merges will be
471
incorrectly attributed to CURRENT_REVISION (but after committing, the
472
attribution will be correct).
474
basis = self.basis_tree()
477
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
478
require_versioned=True).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
500
def _get_ancestors(self, default_revision):
501
ancestors = set([default_revision])
502
for parent_id in self.get_parent_ids():
503
ancestors.update(self.branch.repository.get_ancestry(
504
parent_id, topo_sorted=False))
507
def get_parent_ids(self):
508
"""See Tree.get_parent_ids.
510
This implementation reads the pending merges list and last_revision
511
value and uses that to decide what the parents list should be.
513
last_rev = _mod_revision.ensure_null(self._last_revision())
514
if _mod_revision.NULL_REVISION == last_rev:
519
merges_file = self._transport.get('pending-merges')
520
except errors.NoSuchFile:
523
for l in merges_file.readlines():
524
revision_id = l.rstrip('\n')
525
parents.append(revision_id)
529
def get_root_id(self):
530
"""Return the id of this trees root"""
531
return self._inventory.root.file_id
533
def _get_store_filename(self, file_id):
534
## XXX: badly named; this is not in the store at all
535
return self.abspath(self.id2path(file_id))
538
def clone(self, to_bzrdir, revision_id=None):
539
"""Duplicate this working tree into to_bzr, including all state.
541
Specifically modified files are kept as modified, but
542
ignored and unknown files are discarded.
544
If you want to make a new line of development, see bzrdir.sprout()
547
If not None, the cloned tree will have its last revision set to
548
revision, and and difference between the source trees last revision
549
and this one merged in.
551
# assumes the target bzr dir format is compatible.
552
result = to_bzrdir.create_workingtree()
553
self.copy_content_into(result, revision_id)
557
def copy_content_into(self, tree, revision_id=None):
558
"""Copy the current content and user files of this tree into tree."""
559
tree.set_root_id(self.get_root_id())
560
if revision_id is None:
561
merge.transform_tree(tree, self)
563
# TODO now merge from tree.last_revision to revision (to preserve
564
# user local changes)
565
merge.transform_tree(tree, self)
566
tree.set_parent_ids([revision_id])
568
def id2abspath(self, file_id):
569
return self.abspath(self.id2path(file_id))
571
def has_id(self, file_id):
572
# files that have been deleted are excluded
574
if not inv.has_id(file_id):
576
path = inv.id2path(file_id)
577
return osutils.lexists(self.abspath(path))
579
def has_or_had_id(self, file_id):
580
if file_id == self.inventory.root.file_id:
582
return self.inventory.has_id(file_id)
584
__contains__ = has_id
586
def get_file_size(self, file_id):
587
"""See Tree.get_file_size"""
589
return os.path.getsize(self.id2abspath(file_id))
591
if e.errno != errno.ENOENT:
597
def get_file_sha1(self, file_id, path=None, stat_value=None):
599
path = self._inventory.id2path(file_id)
600
return self._hashcache.get_sha1(path, stat_value)
602
def get_file_mtime(self, file_id, path=None):
604
path = self.inventory.id2path(file_id)
605
return os.lstat(self.abspath(path)).st_mtime
607
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
608
file_id = self.path2id(path)
609
return self._inventory[file_id].executable
611
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
612
mode = stat_result.st_mode
613
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
615
if not supports_executable():
616
def is_executable(self, file_id, path=None):
617
return self._inventory[file_id].executable
619
_is_executable_from_path_and_stat = \
620
_is_executable_from_path_and_stat_from_basis
622
def is_executable(self, file_id, path=None):
624
path = self.id2path(file_id)
625
mode = os.lstat(self.abspath(path)).st_mode
626
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
628
_is_executable_from_path_and_stat = \
629
_is_executable_from_path_and_stat_from_stat
631
@needs_tree_write_lock
632
def _add(self, files, ids, kinds):
633
"""See MutableTree._add."""
634
# TODO: Re-adding a file that is removed in the working copy
635
# should probably put it back with the previous ID.
636
# the read and write working inventory should not occur in this
637
# function - they should be part of lock_write and unlock.
639
for f, file_id, kind in zip(files, ids, kinds):
641
inv.add_path(f, kind=kind)
643
inv.add_path(f, kind=kind, file_id=file_id)
644
self._inventory_is_modified = True
646
@needs_tree_write_lock
647
def _gather_kinds(self, files, kinds):
648
"""See MutableTree._gather_kinds."""
649
for pos, f in enumerate(files):
650
if kinds[pos] is None:
651
fullpath = normpath(self.abspath(f))
653
kinds[pos] = file_kind(fullpath)
655
if e.errno == errno.ENOENT:
656
raise errors.NoSuchFile(fullpath)
659
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
660
"""Add revision_id as a parent.
662
This is equivalent to retrieving the current list of parent ids
663
and setting the list to its value plus revision_id.
665
:param revision_id: The revision id to add to the parent list. It may
666
be a ghost revision as long as its not the first parent to be added,
667
or the allow_leftmost_as_ghost parameter is set True.
668
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
parents = self.get_parent_ids() + [revision_id]
671
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
672
or allow_leftmost_as_ghost)
674
@needs_tree_write_lock
675
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
676
"""Add revision_id, tree tuple as a parent.
678
This is equivalent to retrieving the current list of parent trees
679
and setting the list to its value plus parent_tuple. See also
680
add_parent_tree_id - if you only have a parent id available it will be
681
simpler to use that api. If you have the parent already available, using
682
this api is preferred.
684
:param parent_tuple: The (revision id, tree) to add to the parent list.
685
If the revision_id is a ghost, pass None for the tree.
686
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
688
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
689
if len(parent_ids) > 1:
690
# the leftmost may have already been a ghost, preserve that if it
692
allow_leftmost_as_ghost = True
693
self.set_parent_ids(parent_ids,
694
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
696
@needs_tree_write_lock
697
def add_pending_merge(self, *revision_ids):
698
# TODO: Perhaps should check at this point that the
699
# history of the revision is actually present?
700
parents = self.get_parent_ids()
702
for rev_id in revision_ids:
703
if rev_id in parents:
705
parents.append(rev_id)
708
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
710
def path_content_summary(self, path, _lstat=os.lstat,
711
_mapper=osutils.file_kind_from_stat_mode):
712
"""See Tree.path_content_summary."""
713
abspath = self.abspath(path)
715
stat_result = _lstat(abspath)
717
if getattr(e, 'errno', None) == errno.ENOENT:
719
return ('missing', None, None, None)
720
# propagate other errors
722
kind = _mapper(stat_result.st_mode)
724
size = stat_result.st_size
725
# try for a stat cache lookup
726
executable = self._is_executable_from_path_and_stat(path, stat_result)
727
return (kind, size, executable, self._sha_from_stat(
729
elif kind == 'directory':
730
# perhaps it looks like a plain directory, but it's really a
732
if self._directory_is_tree_reference(path):
733
kind = 'tree-reference'
734
return kind, None, None, None
735
elif kind == 'symlink':
736
return ('symlink', None, None, os.readlink(abspath))
738
return (kind, None, None, None)
740
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
741
"""Common ghost checking functionality from set_parent_*.
743
This checks that the left hand-parent exists if there are any
746
if len(revision_ids) > 0:
747
leftmost_id = revision_ids[0]
748
if (not allow_leftmost_as_ghost and not
749
self.branch.repository.has_revision(leftmost_id)):
750
raise errors.GhostRevisionUnusableHere(leftmost_id)
752
def _set_merges_from_parent_ids(self, parent_ids):
753
merges = parent_ids[1:]
754
self._transport.put_bytes('pending-merges', '\n'.join(merges),
755
mode=self._control_files._file_mode)
757
def _filter_parent_ids_by_ancestry(self, revision_ids):
758
"""Check that all merged revisions are proper 'heads'.
760
This will always return the first revision_id, and any merged revisions
763
if len(revision_ids) == 0:
765
graph = self.branch.repository.get_graph()
766
heads = graph.heads(revision_ids)
767
new_revision_ids = revision_ids[:1]
768
for revision_id in revision_ids[1:]:
769
if revision_id in heads and revision_id not in new_revision_ids:
770
new_revision_ids.append(revision_id)
771
if new_revision_ids != revision_ids:
772
trace.mutter('requested to set revision_ids = %s,'
773
' but filtered to %s', revision_ids, new_revision_ids)
774
return new_revision_ids
776
@needs_tree_write_lock
777
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
778
"""Set the parent ids to revision_ids.
780
See also set_parent_trees. This api will try to retrieve the tree data
781
for each element of revision_ids from the trees repository. If you have
782
tree data already available, it is more efficient to use
783
set_parent_trees rather than set_parent_ids. set_parent_ids is however
784
an easier API to use.
786
:param revision_ids: The revision_ids to set as the parent ids of this
787
working tree. Any of these may be ghosts.
789
self._check_parents_for_ghosts(revision_ids,
790
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
791
for revision_id in revision_ids:
792
_mod_revision.check_not_reserved_id(revision_id)
794
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
796
if len(revision_ids) > 0:
797
self.set_last_revision(revision_ids[0])
799
self.set_last_revision(_mod_revision.NULL_REVISION)
801
self._set_merges_from_parent_ids(revision_ids)
803
@needs_tree_write_lock
804
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
805
"""See MutableTree.set_parent_trees."""
806
parent_ids = [rev for (rev, tree) in parents_list]
807
for revision_id in parent_ids:
808
_mod_revision.check_not_reserved_id(revision_id)
810
self._check_parents_for_ghosts(parent_ids,
811
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
813
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
815
if len(parent_ids) == 0:
816
leftmost_parent_id = _mod_revision.NULL_REVISION
817
leftmost_parent_tree = None
819
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
821
if self._change_last_revision(leftmost_parent_id):
822
if leftmost_parent_tree is None:
823
# If we don't have a tree, fall back to reading the
824
# parent tree from the repository.
825
self._cache_basis_inventory(leftmost_parent_id)
827
inv = leftmost_parent_tree.inventory
828
xml = self._create_basis_xml_from_inventory(
829
leftmost_parent_id, inv)
830
self._write_basis_inventory(xml)
831
self._set_merges_from_parent_ids(parent_ids)
833
@needs_tree_write_lock
834
def set_pending_merges(self, rev_list):
835
parents = self.get_parent_ids()
836
leftmost = parents[:1]
837
new_parents = leftmost + rev_list
838
self.set_parent_ids(new_parents)
840
@needs_tree_write_lock
841
def set_merge_modified(self, modified_hashes):
843
for file_id, hash in modified_hashes.iteritems():
844
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
845
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
847
def _sha_from_stat(self, path, stat_result):
848
"""Get a sha digest from the tree's stat cache.
850
The default implementation assumes no stat cache is present.
852
:param path: The path.
853
:param stat_result: The stat result being looked up.
857
def _put_rio(self, filename, stanzas, header):
858
self._must_be_locked()
859
my_file = rio_file(stanzas, header)
860
self._transport.put_file(filename, my_file,
861
mode=self._control_files._file_mode)
863
@needs_write_lock # because merge pulls data into the branch.
864
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
866
"""Merge from a branch into this working tree.
868
:param branch: The branch to merge from.
869
:param to_revision: If non-None, the merge will merge to to_revision,
870
but not beyond it. to_revision does not need to be in the history
871
of the branch when it is supplied. If None, to_revision defaults to
872
branch.last_revision().
874
from bzrlib.merge import Merger, Merge3Merger
875
pb = bzrlib.ui.ui_factory.nested_progress_bar()
877
merger = Merger(self.branch, this_tree=self, pb=pb)
878
merger.pp = ProgressPhase("Merge phase", 5, pb)
879
merger.pp.next_phase()
880
# check that there are no
882
merger.check_basis(check_clean=True, require_commits=False)
883
if to_revision is None:
884
to_revision = _mod_revision.ensure_null(branch.last_revision())
885
merger.other_rev_id = to_revision
886
if _mod_revision.is_null(merger.other_rev_id):
887
raise errors.NoCommits(branch)
888
self.branch.fetch(branch, last_revision=merger.other_rev_id)
889
merger.other_basis = merger.other_rev_id
890
merger.other_tree = self.branch.repository.revision_tree(
892
merger.other_branch = branch
893
merger.pp.next_phase()
894
if from_revision is None:
897
merger.set_base_revision(from_revision, branch)
898
if merger.base_rev_id == merger.other_rev_id:
899
raise errors.PointlessMerge
900
merger.backup_files = False
901
if merge_type is None:
902
merger.merge_type = Merge3Merger
904
merger.merge_type = merge_type
905
merger.set_interesting_files(None)
906
merger.show_base = False
907
merger.reprocess = False
908
conflicts = merger.do_merge()
915
def merge_modified(self):
916
"""Return a dictionary of files modified by a merge.
918
The list is initialized by WorkingTree.set_merge_modified, which is
919
typically called after we make some automatic updates to the tree
922
This returns a map of file_id->sha1, containing only files which are
923
still in the working inventory and have that text hash.
926
hashfile = self._transport.get('merge-hashes')
927
except errors.NoSuchFile:
932
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
933
raise errors.MergeModifiedFormatError()
934
except StopIteration:
935
raise errors.MergeModifiedFormatError()
936
for s in RioReader(hashfile):
937
# RioReader reads in Unicode, so convert file_ids back to utf8
938
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
939
if file_id not in self.inventory:
941
text_hash = s.get("hash")
942
if text_hash == self.get_file_sha1(file_id):
943
merge_hashes[file_id] = text_hash
949
def mkdir(self, path, file_id=None):
950
"""See MutableTree.mkdir()."""
952
file_id = generate_ids.gen_file_id(os.path.basename(path))
953
os.mkdir(self.abspath(path))
954
self.add(path, file_id, 'directory')
957
def get_symlink_target(self, file_id):
958
return os.readlink(self.id2abspath(file_id))
961
def subsume(self, other_tree):
962
def add_children(inventory, entry):
963
for child_entry in entry.children.values():
964
inventory._byid[child_entry.file_id] = child_entry
965
if child_entry.kind == 'directory':
966
add_children(inventory, child_entry)
967
if other_tree.get_root_id() == self.get_root_id():
968
raise errors.BadSubsumeSource(self, other_tree,
969
'Trees have the same root')
971
other_tree_path = self.relpath(other_tree.basedir)
972
except errors.PathNotChild:
973
raise errors.BadSubsumeSource(self, other_tree,
974
'Tree is not contained by the other')
975
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
976
if new_root_parent is None:
977
raise errors.BadSubsumeSource(self, other_tree,
978
'Parent directory is not versioned.')
979
# We need to ensure that the result of a fetch will have a
980
# versionedfile for the other_tree root, and only fetching into
981
# RepositoryKnit2 guarantees that.
982
if not self.branch.repository.supports_rich_root():
983
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
984
other_tree.lock_tree_write()
986
new_parents = other_tree.get_parent_ids()
987
other_root = other_tree.inventory.root
988
other_root.parent_id = new_root_parent
989
other_root.name = osutils.basename(other_tree_path)
990
self.inventory.add(other_root)
991
add_children(self.inventory, other_root)
992
self._write_inventory(self.inventory)
993
# normally we don't want to fetch whole repositories, but i think
994
# here we really do want to consolidate the whole thing.
995
for parent_id in other_tree.get_parent_ids():
996
self.branch.fetch(other_tree.branch, parent_id)
997
self.add_parent_tree_id(parent_id)
1000
other_tree.bzrdir.retire_bzrdir()
1002
def _setup_directory_is_tree_reference(self):
1003
if self._branch.repository._format.supports_tree_reference:
1004
self._directory_is_tree_reference = \
1005
self._directory_may_be_tree_reference
1007
self._directory_is_tree_reference = \
1008
self._directory_is_never_tree_reference
1010
def _directory_is_never_tree_reference(self, relpath):
1013
def _directory_may_be_tree_reference(self, relpath):
1014
# as a special case, if a directory contains control files then
1015
# it's a tree reference, except that the root of the tree is not
1016
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1017
# TODO: We could ask all the control formats whether they
1018
# recognize this directory, but at the moment there's no cheap api
1019
# to do that. Since we probably can only nest bzr checkouts and
1020
# they always use this name it's ok for now. -- mbp 20060306
1022
# FIXME: There is an unhandled case here of a subdirectory
1023
# containing .bzr but not a branch; that will probably blow up
1024
# when you try to commit it. It might happen if there is a
1025
# checkout in a subdirectory. This can be avoided by not adding
1028
@needs_tree_write_lock
1029
def extract(self, file_id, format=None):
1030
"""Extract a subtree from this tree.
1032
A new branch will be created, relative to the path for this tree.
1036
segments = osutils.splitpath(path)
1037
transport = self.branch.bzrdir.root_transport
1038
for name in segments:
1039
transport = transport.clone(name)
1040
transport.ensure_base()
1043
sub_path = self.id2path(file_id)
1044
branch_transport = mkdirs(sub_path)
1046
format = self.bzrdir.cloning_metadir()
1047
branch_transport.ensure_base()
1048
branch_bzrdir = format.initialize_on_transport(branch_transport)
1050
repo = branch_bzrdir.find_repository()
1051
except errors.NoRepositoryPresent:
1052
repo = branch_bzrdir.create_repository()
1053
if not repo.supports_rich_root():
1054
raise errors.RootNotRich()
1055
new_branch = branch_bzrdir.create_branch()
1056
new_branch.pull(self.branch)
1057
for parent_id in self.get_parent_ids():
1058
new_branch.fetch(self.branch, parent_id)
1059
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1060
if tree_transport.base != branch_transport.base:
1061
tree_bzrdir = format.initialize_on_transport(tree_transport)
1062
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1064
tree_bzrdir = branch_bzrdir
1065
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1066
wt.set_parent_ids(self.get_parent_ids())
1067
my_inv = self.inventory
1068
child_inv = Inventory(root_id=None)
1069
new_root = my_inv[file_id]
1070
my_inv.remove_recursive_id(file_id)
1071
new_root.parent_id = None
1072
child_inv.add(new_root)
1073
self._write_inventory(my_inv)
1074
wt._write_inventory(child_inv)
1077
def _serialize(self, inventory, out_file):
1078
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1081
def _deserialize(selt, in_file):
1082
return xml5.serializer_v5.read_inventory(in_file)
1085
"""Write the in memory inventory to disk."""
1086
# TODO: Maybe this should only write on dirty ?
1087
if self._control_files._lock_mode != 'w':
1088
raise errors.NotWriteLocked(self)
1090
self._serialize(self._inventory, sio)
1092
self._transport.put_file('inventory', sio,
1093
mode=self._control_files._file_mode)
1094
self._inventory_is_modified = False
1096
def _kind(self, relpath):
1097
return osutils.file_kind(self.abspath(relpath))
1099
def list_files(self, include_root=False):
1100
"""Recursively list all files as (path, class, kind, id, entry).
1102
Lists, but does not descend into unversioned directories.
1104
This does not include files that have been deleted in this
1107
Skips the control directory.
1109
# list_files is an iterator, so @needs_read_lock doesn't work properly
1110
# with it. So callers should be careful to always read_lock the tree.
1111
if not self.is_locked():
1112
raise errors.ObjectNotLocked(self)
1114
inv = self.inventory
1115
if include_root is True:
1116
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1117
# Convert these into local objects to save lookup times
1118
pathjoin = osutils.pathjoin
1119
file_kind = self._kind
1121
# transport.base ends in a slash, we want the piece
1122
# between the last two slashes
1123
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1125
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1127
# directory file_id, relative path, absolute path, reverse sorted children
1128
children = os.listdir(self.basedir)
1130
# jam 20060527 The kernel sized tree seems equivalent whether we
1131
# use a deque and popleft to keep them sorted, or if we use a plain
1132
# list and just reverse() them.
1133
children = collections.deque(children)
1134
stack = [(inv.root.file_id, u'', self.basedir, children)]
1136
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1139
f = children.popleft()
1140
## TODO: If we find a subdirectory with its own .bzr
1141
## directory, then that is a separate tree and we
1142
## should exclude it.
1144
# the bzrdir for this tree
1145
if transport_base_dir == f:
1148
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1149
# and 'f' doesn't begin with one, we can do a string op, rather
1150
# than the checks of pathjoin(), all relative paths will have an extra slash
1152
fp = from_dir_relpath + '/' + f
1155
fap = from_dir_abspath + '/' + f
1157
f_ie = inv.get_child(from_dir_id, f)
1160
elif self.is_ignored(fp[1:]):
1163
# we may not have found this file, because of a unicode issue
1164
f_norm, can_access = osutils.normalized_filename(f)
1165
if f == f_norm or not can_access:
1166
# No change, so treat this file normally
1169
# this file can be accessed by a normalized path
1170
# check again if it is versioned
1171
# these lines are repeated here for performance
1173
fp = from_dir_relpath + '/' + f
1174
fap = from_dir_abspath + '/' + f
1175
f_ie = inv.get_child(from_dir_id, f)
1178
elif self.is_ignored(fp[1:]):
1185
# make a last minute entry
1187
yield fp[1:], c, fk, f_ie.file_id, f_ie
1190
yield fp[1:], c, fk, None, fk_entries[fk]()
1192
yield fp[1:], c, fk, None, TreeEntry()
1195
if fk != 'directory':
1198
# But do this child first
1199
new_children = os.listdir(fap)
1201
new_children = collections.deque(new_children)
1202
stack.append((f_ie.file_id, fp, fap, new_children))
1203
# Break out of inner loop,
1204
# so that we start outer loop with child
1207
# if we finished all children, pop it off the stack
1210
@needs_tree_write_lock
1211
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1214
to_dir must exist in the inventory.
1216
If to_dir exists and is a directory, the files are moved into
1217
it, keeping their old names.
1219
Note that to_dir is only the last component of the new name;
1220
this doesn't change the directory.
1222
For each entry in from_paths the move mode will be determined
1225
The first mode moves the file in the filesystem and updates the
1226
inventory. The second mode only updates the inventory without
1227
touching the file on the filesystem. This is the new mode introduced
1230
move uses the second mode if 'after == True' and the target is not
1231
versioned but present in the working tree.
1233
move uses the second mode if 'after == False' and the source is
1234
versioned but no longer in the working tree, and the target is not
1235
versioned but present in the working tree.
1237
move uses the first mode if 'after == False' and the source is
1238
versioned and present in the working tree, and the target is not
1239
versioned and not present in the working tree.
1241
Everything else results in an error.
1243
This returns a list of (from_path, to_path) pairs for each
1244
entry that is moved.
1249
# check for deprecated use of signature
1251
to_dir = kwargs.get('to_name', None)
1253
raise TypeError('You must supply a target directory')
1255
symbol_versioning.warn('The parameter to_name was deprecated'
1256
' in version 0.13. Use to_dir instead',
1259
# check destination directory
1260
if isinstance(from_paths, basestring):
1262
inv = self.inventory
1263
to_abs = self.abspath(to_dir)
1264
if not isdir(to_abs):
1265
raise errors.BzrMoveFailedError('',to_dir,
1266
errors.NotADirectory(to_abs))
1267
if not self.has_filename(to_dir):
1268
raise errors.BzrMoveFailedError('',to_dir,
1269
errors.NotInWorkingDirectory(to_dir))
1270
to_dir_id = inv.path2id(to_dir)
1271
if to_dir_id is None:
1272
raise errors.BzrMoveFailedError('',to_dir,
1273
errors.NotVersionedError(path=str(to_dir)))
1275
to_dir_ie = inv[to_dir_id]
1276
if to_dir_ie.kind != 'directory':
1277
raise errors.BzrMoveFailedError('',to_dir,
1278
errors.NotADirectory(to_abs))
1280
# create rename entries and tuples
1281
for from_rel in from_paths:
1282
from_tail = splitpath(from_rel)[-1]
1283
from_id = inv.path2id(from_rel)
1285
raise errors.BzrMoveFailedError(from_rel,to_dir,
1286
errors.NotVersionedError(path=str(from_rel)))
1288
from_entry = inv[from_id]
1289
from_parent_id = from_entry.parent_id
1290
to_rel = pathjoin(to_dir, from_tail)
1291
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1293
from_tail=from_tail,
1294
from_parent_id=from_parent_id,
1295
to_rel=to_rel, to_tail=from_tail,
1296
to_parent_id=to_dir_id)
1297
rename_entries.append(rename_entry)
1298
rename_tuples.append((from_rel, to_rel))
1300
# determine which move mode to use. checks also for movability
1301
rename_entries = self._determine_mv_mode(rename_entries, after)
1303
original_modified = self._inventory_is_modified
1306
self._inventory_is_modified = True
1307
self._move(rename_entries)
1309
# restore the inventory on error
1310
self._inventory_is_modified = original_modified
1312
self._write_inventory(inv)
1313
return rename_tuples
1315
def _determine_mv_mode(self, rename_entries, after=False):
1316
"""Determines for each from-to pair if both inventory and working tree
1317
or only the inventory has to be changed.
1319
Also does basic plausability tests.
1321
inv = self.inventory
1323
for rename_entry in rename_entries:
1324
# store to local variables for easier reference
1325
from_rel = rename_entry.from_rel
1326
from_id = rename_entry.from_id
1327
to_rel = rename_entry.to_rel
1328
to_id = inv.path2id(to_rel)
1329
only_change_inv = False
1331
# check the inventory for source and destination
1333
raise errors.BzrMoveFailedError(from_rel,to_rel,
1334
errors.NotVersionedError(path=str(from_rel)))
1335
if to_id is not None:
1336
raise errors.BzrMoveFailedError(from_rel,to_rel,
1337
errors.AlreadyVersionedError(path=str(to_rel)))
1339
# try to determine the mode for rename (only change inv or change
1340
# inv and file system)
1342
if not self.has_filename(to_rel):
1343
raise errors.BzrMoveFailedError(from_id,to_rel,
1344
errors.NoSuchFile(path=str(to_rel),
1345
extra="New file has not been created yet"))
1346
only_change_inv = True
1347
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1348
only_change_inv = True
1349
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1350
only_change_inv = False
1351
elif (not self.case_sensitive
1352
and from_rel.lower() == to_rel.lower()
1353
and self.has_filename(from_rel)):
1354
only_change_inv = False
1356
# something is wrong, so lets determine what exactly
1357
if not self.has_filename(from_rel) and \
1358
not self.has_filename(to_rel):
1359
raise errors.BzrRenameFailedError(from_rel,to_rel,
1360
errors.PathsDoNotExist(paths=(str(from_rel),
1363
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1364
rename_entry.only_change_inv = only_change_inv
1365
return rename_entries
1367
def _move(self, rename_entries):
1368
"""Moves a list of files.
1370
Depending on the value of the flag 'only_change_inv', the
1371
file will be moved on the file system or not.
1373
inv = self.inventory
1376
for entry in rename_entries:
1378
self._move_entry(entry)
1380
self._rollback_move(moved)
1384
def _rollback_move(self, moved):
1385
"""Try to rollback a previous move in case of an filesystem error."""
1386
inv = self.inventory
1389
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1390
entry.to_tail, entry.to_parent_id, entry.from_rel,
1391
entry.from_tail, entry.from_parent_id,
1392
entry.only_change_inv))
1393
except errors.BzrMoveFailedError, e:
1394
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1395
" The working tree is in an inconsistent state."
1396
" Please consider doing a 'bzr revert'."
1397
" Error message is: %s" % e)
1399
def _move_entry(self, entry):
1400
inv = self.inventory
1401
from_rel_abs = self.abspath(entry.from_rel)
1402
to_rel_abs = self.abspath(entry.to_rel)
1403
if from_rel_abs == to_rel_abs:
1404
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1405
"Source and target are identical.")
1407
if not entry.only_change_inv:
1409
osutils.rename(from_rel_abs, to_rel_abs)
1411
raise errors.BzrMoveFailedError(entry.from_rel,
1413
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1415
@needs_tree_write_lock
1416
def rename_one(self, from_rel, to_rel, after=False):
1419
This can change the directory or the filename or both.
1421
rename_one has several 'modes' to work. First, it can rename a physical
1422
file and change the file_id. That is the normal mode. Second, it can
1423
only change the file_id without touching any physical file. This is
1424
the new mode introduced in version 0.15.
1426
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1427
versioned but present in the working tree.
1429
rename_one uses the second mode if 'after == False' and 'from_rel' is
1430
versioned but no longer in the working tree, and 'to_rel' is not
1431
versioned but present in the working tree.
1433
rename_one uses the first mode if 'after == False' and 'from_rel' is
1434
versioned and present in the working tree, and 'to_rel' is not
1435
versioned and not present in the working tree.
1437
Everything else results in an error.
1439
inv = self.inventory
1442
# create rename entries and tuples
1443
from_tail = splitpath(from_rel)[-1]
1444
from_id = inv.path2id(from_rel)
1446
raise errors.BzrRenameFailedError(from_rel,to_rel,
1447
errors.NotVersionedError(path=str(from_rel)))
1448
from_entry = inv[from_id]
1449
from_parent_id = from_entry.parent_id
1450
to_dir, to_tail = os.path.split(to_rel)
1451
to_dir_id = inv.path2id(to_dir)
1452
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1454
from_tail=from_tail,
1455
from_parent_id=from_parent_id,
1456
to_rel=to_rel, to_tail=to_tail,
1457
to_parent_id=to_dir_id)
1458
rename_entries.append(rename_entry)
1460
# determine which move mode to use. checks also for movability
1461
rename_entries = self._determine_mv_mode(rename_entries, after)
1463
# check if the target changed directory and if the target directory is
1465
if to_dir_id is None:
1466
raise errors.BzrMoveFailedError(from_rel,to_rel,
1467
errors.NotVersionedError(path=str(to_dir)))
1469
# all checks done. now we can continue with our actual work
1470
mutter('rename_one:\n'
1475
' to_dir_id {%s}\n',
1476
from_id, from_rel, to_rel, to_dir, to_dir_id)
1478
self._move(rename_entries)
1479
self._write_inventory(inv)
1481
class _RenameEntry(object):
1482
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1483
to_rel, to_tail, to_parent_id, only_change_inv=False):
1484
self.from_rel = from_rel
1485
self.from_id = from_id
1486
self.from_tail = from_tail
1487
self.from_parent_id = from_parent_id
1488
self.to_rel = to_rel
1489
self.to_tail = to_tail
1490
self.to_parent_id = to_parent_id
1491
self.only_change_inv = only_change_inv
1495
"""Return all unknown files.
1497
These are files in the working directory that are not versioned or
1498
control files or ignored.
1500
# force the extras method to be fully executed before returning, to
1501
# prevent race conditions with the lock
1503
[subp for subp in self.extras() if not self.is_ignored(subp)])
1505
@needs_tree_write_lock
1506
def unversion(self, file_ids):
1507
"""Remove the file ids in file_ids from the current versioned set.
1509
When a file_id is unversioned, all of its children are automatically
1512
:param file_ids: The file ids to stop versioning.
1513
:raises: NoSuchId if any fileid is not currently versioned.
1515
for file_id in file_ids:
1516
if self._inventory.has_id(file_id):
1517
self._inventory.remove_recursive_id(file_id)
1519
raise errors.NoSuchId(self, file_id)
1521
# in the future this should just set a dirty bit to wait for the
1522
# final unlock. However, until all methods of workingtree start
1523
# with the current in -memory inventory rather than triggering
1524
# a read, it is more complex - we need to teach read_inventory
1525
# to know when to read, and when to not read first... and possibly
1526
# to save first when the in memory one may be corrupted.
1527
# so for now, we just only write it if it is indeed dirty.
1529
self._write_inventory(self._inventory)
1531
def _iter_conflicts(self):
1533
for info in self.list_files():
1535
stem = get_conflicted_stem(path)
1538
if stem not in conflicted:
1539
conflicted.add(stem)
1543
def pull(self, source, overwrite=False, stop_revision=None,
1544
change_reporter=None, possible_transports=None):
1545
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1548
pp = ProgressPhase("Pull phase", 2, top_pb)
1550
old_revision_info = self.branch.last_revision_info()
1551
basis_tree = self.basis_tree()
1552
count = self.branch.pull(source, overwrite, stop_revision,
1553
possible_transports=possible_transports)
1554
new_revision_info = self.branch.last_revision_info()
1555
if new_revision_info != old_revision_info:
1557
repository = self.branch.repository
1558
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1559
basis_tree.lock_read()
1561
new_basis_tree = self.branch.basis_tree()
1568
change_reporter=change_reporter)
1569
if (basis_tree.inventory.root is None and
1570
new_basis_tree.inventory.root is not None):
1571
self.set_root_id(new_basis_tree.get_root_id())
1575
# TODO - dedup parents list with things merged by pull ?
1576
# reuse the revisiontree we merged against to set the new
1578
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1579
# we have to pull the merge trees out again, because
1580
# merge_inner has set the ids. - this corner is not yet
1581
# layered well enough to prevent double handling.
1582
# XXX TODO: Fix the double handling: telling the tree about
1583
# the already known parent data is wasteful.
1584
merges = self.get_parent_ids()[1:]
1585
parent_trees.extend([
1586
(parent, repository.revision_tree(parent)) for
1588
self.set_parent_trees(parent_trees)
1595
def put_file_bytes_non_atomic(self, file_id, bytes):
1596
"""See MutableTree.put_file_bytes_non_atomic."""
1597
stream = file(self.id2abspath(file_id), 'wb')
1602
# TODO: update the hashcache here ?
1605
"""Yield all unversioned files in this WorkingTree.
1607
If there are any unversioned directories then only the directory is
1608
returned, not all its children. But if there are unversioned files
1609
under a versioned subdirectory, they are returned.
1611
Currently returned depth-first, sorted by name within directories.
1612
This is the same order used by 'osutils.walkdirs'.
1614
## TODO: Work from given directory downwards
1615
for path, dir_entry in self.inventory.directories():
1616
# mutter("search for unknowns in %r", path)
1617
dirabs = self.abspath(path)
1618
if not isdir(dirabs):
1619
# e.g. directory deleted
1623
for subf in os.listdir(dirabs):
1626
if subf not in dir_entry.children:
1629
can_access) = osutils.normalized_filename(subf)
1630
except UnicodeDecodeError:
1631
path_os_enc = path.encode(osutils._fs_enc)
1632
relpath = path_os_enc + '/' + subf
1633
raise errors.BadFilenameEncoding(relpath,
1635
if subf_norm != subf and can_access:
1636
if subf_norm not in dir_entry.children:
1637
fl.append(subf_norm)
1643
subp = pathjoin(path, subf)
1646
def ignored_files(self):
1647
"""Yield list of PATH, IGNORE_PATTERN"""
1648
for subp in self.extras():
1649
pat = self.is_ignored(subp)
1653
def get_ignore_list(self):
1654
"""Return list of ignore patterns.
1656
Cached in the Tree object after the first call.
1658
ignoreset = getattr(self, '_ignoreset', None)
1659
if ignoreset is not None:
1662
ignore_globs = set()
1663
ignore_globs.update(ignores.get_runtime_ignores())
1664
ignore_globs.update(ignores.get_user_ignores())
1665
if self.has_filename(bzrlib.IGNORE_FILENAME):
1666
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1668
ignore_globs.update(ignores.parse_ignore_file(f))
1671
self._ignoreset = ignore_globs
1674
def _flush_ignore_list_cache(self):
1675
"""Resets the cached ignore list to force a cache rebuild."""
1676
self._ignoreset = None
1677
self._ignoreglobster = None
1679
def is_ignored(self, filename):
1680
r"""Check whether the filename matches an ignore pattern.
1682
Patterns containing '/' or '\' need to match the whole path;
1683
others match against only the last component.
1685
If the file is ignored, returns the pattern which caused it to
1686
be ignored, otherwise None. So this can simply be used as a
1687
boolean if desired."""
1688
if getattr(self, '_ignoreglobster', None) is None:
1689
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1690
return self._ignoreglobster.match(filename)
1692
def kind(self, file_id):
1693
return file_kind(self.id2abspath(file_id))
1695
def stored_kind(self, file_id):
1696
"""See Tree.stored_kind"""
1697
return self.inventory[file_id].kind
1699
def _comparison_data(self, entry, path):
1700
abspath = self.abspath(path)
1702
stat_value = os.lstat(abspath)
1704
if getattr(e, 'errno', None) == errno.ENOENT:
1711
mode = stat_value.st_mode
1712
kind = osutils.file_kind_from_stat_mode(mode)
1713
if not supports_executable():
1714
executable = entry is not None and entry.executable
1716
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1717
return kind, executable, stat_value
1719
def _file_size(self, entry, stat_value):
1720
return stat_value.st_size
1722
def last_revision(self):
1723
"""Return the last revision of the branch for this tree.
1725
This format tree does not support a separate marker for last-revision
1726
compared to the branch.
1728
See MutableTree.last_revision
1730
return self._last_revision()
1733
def _last_revision(self):
1734
"""helper for get_parent_ids."""
1735
return _mod_revision.ensure_null(self.branch.last_revision())
1737
def is_locked(self):
1738
return self._control_files.is_locked()
1740
def _must_be_locked(self):
1741
if not self.is_locked():
1742
raise errors.ObjectNotLocked(self)
1744
def lock_read(self):
1745
"""See Branch.lock_read, and WorkingTree.unlock."""
1746
if not self.is_locked():
1748
self.branch.lock_read()
1750
return self._control_files.lock_read()
1752
self.branch.unlock()
1755
def lock_tree_write(self):
1756
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1757
if not self.is_locked():
1759
self.branch.lock_read()
1761
return self._control_files.lock_write()
1763
self.branch.unlock()
1766
def lock_write(self):
1767
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1768
if not self.is_locked():
1770
self.branch.lock_write()
1772
return self._control_files.lock_write()
1774
self.branch.unlock()
1777
def get_physical_lock_status(self):
1778
return self._control_files.get_physical_lock_status()
1780
def _basis_inventory_name(self):
1781
return 'basis-inventory-cache'
1783
def _reset_data(self):
1784
"""Reset transient data that cannot be revalidated."""
1785
self._inventory_is_modified = False
1786
result = self._deserialize(self._transport.get('inventory'))
1787
self._set_inventory(result, dirty=False)
1789
@needs_tree_write_lock
1790
def set_last_revision(self, new_revision):
1791
"""Change the last revision in the working tree."""
1792
if self._change_last_revision(new_revision):
1793
self._cache_basis_inventory(new_revision)
1795
def _change_last_revision(self, new_revision):
1796
"""Template method part of set_last_revision to perform the change.
1798
This is used to allow WorkingTree3 instances to not affect branch
1799
when their last revision is set.
1801
if _mod_revision.is_null(new_revision):
1802
self.branch.set_revision_history([])
1805
self.branch.generate_revision_history(new_revision)
1806
except errors.NoSuchRevision:
1807
# not present in the repo - dont try to set it deeper than the tip
1808
self.branch.set_revision_history([new_revision])
1811
def _write_basis_inventory(self, xml):
1812
"""Write the basis inventory XML to the basis-inventory file"""
1813
path = self._basis_inventory_name()
1815
self._transport.put_file(path, sio,
1816
mode=self._control_files._file_mode)
1818
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1819
"""Create the text that will be saved in basis-inventory"""
1820
inventory.revision_id = revision_id
1821
return xml7.serializer_v7.write_inventory_to_string(inventory)
1823
def _cache_basis_inventory(self, new_revision):
1824
"""Cache new_revision as the basis inventory."""
1825
# TODO: this should allow the ready-to-use inventory to be passed in,
1826
# as commit already has that ready-to-use [while the format is the
1829
# this double handles the inventory - unpack and repack -
1830
# but is easier to understand. We can/should put a conditional
1831
# in here based on whether the inventory is in the latest format
1832
# - perhaps we should repack all inventories on a repository
1834
# the fast path is to copy the raw xml from the repository. If the
1835
# xml contains 'revision_id="', then we assume the right
1836
# revision_id is set. We must check for this full string, because a
1837
# root node id can legitimately look like 'revision_id' but cannot
1839
xml = self.branch.repository.get_inventory_xml(new_revision)
1840
firstline = xml.split('\n', 1)[0]
1841
if (not 'revision_id="' in firstline or
1842
'format="7"' not in firstline):
1843
inv = self.branch.repository.deserialise_inventory(
1845
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1846
self._write_basis_inventory(xml)
1847
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1850
def read_basis_inventory(self):
1851
"""Read the cached basis inventory."""
1852
path = self._basis_inventory_name()
1853
return self._transport.get_bytes(path)
1856
def read_working_inventory(self):
1857
"""Read the working inventory.
1859
:raises errors.InventoryModified: read_working_inventory will fail
1860
when the current in memory inventory has been modified.
1862
# conceptually this should be an implementation detail of the tree.
1863
# XXX: Deprecate this.
1864
# ElementTree does its own conversion from UTF-8, so open in
1866
if self._inventory_is_modified:
1867
raise errors.InventoryModified(self)
1868
result = self._deserialize(self._transport.get('inventory'))
1869
self._set_inventory(result, dirty=False)
1872
@needs_tree_write_lock
1873
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1875
"""Remove nominated files from the working inventory.
1877
:files: File paths relative to the basedir.
1878
:keep_files: If true, the files will also be kept.
1879
:force: Delete files and directories, even if they are changed and
1880
even if the directories are not empty.
1882
if isinstance(files, basestring):
1888
unknown_nested_files=set()
1890
def recurse_directory_to_add_files(directory):
1891
# Recurse directory and add all files
1892
# so we can check if they have changed.
1893
for parent_info, file_infos in\
1894
self.walkdirs(directory):
1895
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1896
# Is it versioned or ignored?
1897
if self.path2id(relpath) or self.is_ignored(relpath):
1898
# Add nested content for deletion.
1899
new_files.add(relpath)
1901
# Files which are not versioned and not ignored
1902
# should be treated as unknown.
1903
unknown_nested_files.add((relpath, None, kind))
1905
for filename in files:
1906
# Get file name into canonical form.
1907
abspath = self.abspath(filename)
1908
filename = self.relpath(abspath)
1909
if len(filename) > 0:
1910
new_files.add(filename)
1911
recurse_directory_to_add_files(filename)
1913
files = list(new_files)
1916
return # nothing to do
1918
# Sort needed to first handle directory content before the directory
1919
files.sort(reverse=True)
1921
# Bail out if we are going to delete files we shouldn't
1922
if not keep_files and not force:
1923
has_changed_files = len(unknown_nested_files) > 0
1924
if not has_changed_files:
1925
for (file_id, path, content_change, versioned, parent_id, name,
1926
kind, executable) in self.iter_changes(self.basis_tree(),
1927
include_unchanged=True, require_versioned=False,
1928
want_unversioned=True, specific_files=files):
1929
if versioned == (False, False):
1930
# The record is unknown ...
1931
if not self.is_ignored(path[1]):
1932
# ... but not ignored
1933
has_changed_files = True
1935
elif content_change and (kind[1] is not None):
1936
# Versioned and changed, but not deleted
1937
has_changed_files = True
1940
if has_changed_files:
1941
# Make delta show ALL applicable changes in error message.
1942
tree_delta = self.changes_from(self.basis_tree(),
1943
require_versioned=False, want_unversioned=True,
1944
specific_files=files)
1945
for unknown_file in unknown_nested_files:
1946
if unknown_file not in tree_delta.unversioned:
1947
tree_delta.unversioned.extend((unknown_file,))
1948
raise errors.BzrRemoveChangedFilesError(tree_delta)
1950
# Build inv_delta and delete files where applicaple,
1951
# do this before any modifications to inventory.
1953
fid = self.path2id(f)
1956
message = "%s is not versioned." % (f,)
1959
# having removed it, it must be either ignored or unknown
1960
if self.is_ignored(f):
1964
textui.show_status(new_status, self.kind(fid), f,
1967
inv_delta.append((f, None, fid, None))
1968
message = "removed %s" % (f,)
1971
abs_path = self.abspath(f)
1972
if osutils.lexists(abs_path):
1973
if (osutils.isdir(abs_path) and
1974
len(os.listdir(abs_path)) > 0):
1976
osutils.rmtree(abs_path)
1978
message = "%s is not an empty directory "\
1979
"and won't be deleted." % (f,)
1981
osutils.delete_any(abs_path)
1982
message = "deleted %s" % (f,)
1983
elif message is not None:
1984
# Only care if we haven't done anything yet.
1985
message = "%s does not exist." % (f,)
1987
# Print only one message (if any) per file.
1988
if message is not None:
1990
self.apply_inventory_delta(inv_delta)
1992
@needs_tree_write_lock
1993
def revert(self, filenames=None, old_tree=None, backups=True,
1994
pb=DummyProgress(), report_changes=False):
1995
from bzrlib.conflicts import resolve
1998
symbol_versioning.warn('Using [] to revert all files is deprecated'
1999
' as of bzr 0.91. Please use None (the default) instead.',
2000
DeprecationWarning, stacklevel=2)
2001
if old_tree is None:
2002
basis_tree = self.basis_tree()
2003
basis_tree.lock_read()
2004
old_tree = basis_tree
2008
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2010
if filenames is None and len(self.get_parent_ids()) > 1:
2012
last_revision = self.last_revision()
2013
if last_revision != NULL_REVISION:
2014
if basis_tree is None:
2015
basis_tree = self.basis_tree()
2016
basis_tree.lock_read()
2017
parent_trees.append((last_revision, basis_tree))
2018
self.set_parent_trees(parent_trees)
2021
resolve(self, filenames, ignore_misses=True, recursive=True)
2023
if basis_tree is not None:
2027
def revision_tree(self, revision_id):
2028
"""See Tree.revision_tree.
2030
WorkingTree can supply revision_trees for the basis revision only
2031
because there is only one cached inventory in the bzr directory.
2033
if revision_id == self.last_revision():
2035
xml = self.read_basis_inventory()
2036
except errors.NoSuchFile:
2040
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2041
# dont use the repository revision_tree api because we want
2042
# to supply the inventory.
2043
if inv.revision_id == revision_id:
2044
return revisiontree.RevisionTree(self.branch.repository,
2046
except errors.BadInventoryFormat:
2048
# raise if there was no inventory, or if we read the wrong inventory.
2049
raise errors.NoSuchRevisionInTree(self, revision_id)
2051
# XXX: This method should be deprecated in favour of taking in a proper
2052
# new Inventory object.
2053
@needs_tree_write_lock
2054
def set_inventory(self, new_inventory_list):
2055
from bzrlib.inventory import (Inventory,
2060
inv = Inventory(self.get_root_id())
2061
for path, file_id, parent, kind in new_inventory_list:
2062
name = os.path.basename(path)
2065
# fixme, there should be a factory function inv,add_??
2066
if kind == 'directory':
2067
inv.add(InventoryDirectory(file_id, name, parent))
2068
elif kind == 'file':
2069
inv.add(InventoryFile(file_id, name, parent))
2070
elif kind == 'symlink':
2071
inv.add(InventoryLink(file_id, name, parent))
2073
raise errors.BzrError("unknown kind %r" % kind)
2074
self._write_inventory(inv)
2076
@needs_tree_write_lock
2077
def set_root_id(self, file_id):
2078
"""Set the root id for this tree."""
2082
'WorkingTree.set_root_id with fileid=None')
2083
file_id = osutils.safe_file_id(file_id)
2084
self._set_root_id(file_id)
2086
def _set_root_id(self, file_id):
2087
"""Set the root id for this tree, in a format specific manner.
2089
:param file_id: The file id to assign to the root. It must not be
2090
present in the current inventory or an error will occur. It must
2091
not be None, but rather a valid file id.
2093
inv = self._inventory
2094
orig_root_id = inv.root.file_id
2095
# TODO: it might be nice to exit early if there was nothing
2096
# to do, saving us from trigger a sync on unlock.
2097
self._inventory_is_modified = True
2098
# we preserve the root inventory entry object, but
2099
# unlinkit from the byid index
2100
del inv._byid[inv.root.file_id]
2101
inv.root.file_id = file_id
2102
# and link it into the index with the new changed id.
2103
inv._byid[inv.root.file_id] = inv.root
2104
# and finally update all children to reference the new id.
2105
# XXX: this should be safe to just look at the root.children
2106
# list, not the WHOLE INVENTORY.
2109
if entry.parent_id == orig_root_id:
2110
entry.parent_id = inv.root.file_id
2113
"""See Branch.unlock.
2115
WorkingTree locking just uses the Branch locking facilities.
2116
This is current because all working trees have an embedded branch
2117
within them. IF in the future, we were to make branch data shareable
2118
between multiple working trees, i.e. via shared storage, then we
2119
would probably want to lock both the local tree, and the branch.
2121
raise NotImplementedError(self.unlock)
2123
def update(self, change_reporter=None, possible_transports=None):
2124
"""Update a working tree along its branch.
2126
This will update the branch if its bound too, which means we have
2127
multiple trees involved:
2129
- The new basis tree of the master.
2130
- The old basis tree of the branch.
2131
- The old basis tree of the working tree.
2132
- The current working tree state.
2134
Pathologically, all three may be different, and non-ancestors of each
2135
other. Conceptually we want to:
2137
- Preserve the wt.basis->wt.state changes
2138
- Transform the wt.basis to the new master basis.
2139
- Apply a merge of the old branch basis to get any 'local' changes from
2141
- Restore the wt.basis->wt.state changes.
2143
There isn't a single operation at the moment to do that, so we:
2144
- Merge current state -> basis tree of the master w.r.t. the old tree
2146
- Do a 'normal' merge of the old branch basis if it is relevant.
2148
if self.branch.get_bound_location() is not None:
2150
update_branch = True
2152
self.lock_tree_write()
2153
update_branch = False
2156
old_tip = self.branch.update(possible_transports)
2159
return self._update_tree(old_tip, change_reporter)
2163
@needs_tree_write_lock
2164
def _update_tree(self, old_tip=None, change_reporter=None):
2165
"""Update a tree to the master branch.
2167
:param old_tip: if supplied, the previous tip revision the branch,
2168
before it was changed to the master branch's tip.
2170
# here if old_tip is not None, it is the old tip of the branch before
2171
# it was updated from the master branch. This should become a pending
2172
# merge in the working tree to preserve the user existing work. we
2173
# cant set that until we update the working trees last revision to be
2174
# one from the new branch, because it will just get absorbed by the
2175
# parent de-duplication logic.
2177
# We MUST save it even if an error occurs, because otherwise the users
2178
# local work is unreferenced and will appear to have been lost.
2182
last_rev = self.get_parent_ids()[0]
2184
last_rev = _mod_revision.NULL_REVISION
2185
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2186
# merge tree state up to new branch tip.
2187
basis = self.basis_tree()
2190
to_tree = self.branch.basis_tree()
2191
if basis.inventory.root is None:
2192
self.set_root_id(to_tree.get_root_id())
2194
result += merge.merge_inner(
2199
change_reporter=change_reporter)
2202
# TODO - dedup parents list with things merged by pull ?
2203
# reuse the tree we've updated to to set the basis:
2204
parent_trees = [(self.branch.last_revision(), to_tree)]
2205
merges = self.get_parent_ids()[1:]
2206
# Ideally we ask the tree for the trees here, that way the working
2207
# tree can decide whether to give us teh entire tree or give us a
2208
# lazy initialised tree. dirstate for instance will have the trees
2209
# in ram already, whereas a last-revision + basis-inventory tree
2210
# will not, but also does not need them when setting parents.
2211
for parent in merges:
2212
parent_trees.append(
2213
(parent, self.branch.repository.revision_tree(parent)))
2214
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2215
parent_trees.append(
2216
(old_tip, self.branch.repository.revision_tree(old_tip)))
2217
self.set_parent_trees(parent_trees)
2218
last_rev = parent_trees[0][0]
2220
# the working tree had the same last-revision as the master
2221
# branch did. We may still have pivot local work from the local
2222
# branch into old_tip:
2223
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2224
self.add_parent_tree_id(old_tip)
2225
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2226
and old_tip != last_rev):
2227
# our last revision was not the prior branch last revision
2228
# and we have converted that last revision to a pending merge.
2229
# base is somewhere between the branch tip now
2230
# and the now pending merge
2232
# Since we just modified the working tree and inventory, flush out
2233
# the current state, before we modify it again.
2234
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2235
# requires it only because TreeTransform directly munges the
2236
# inventory and calls tree._write_inventory(). Ultimately we
2237
# should be able to remove this extra flush.
2239
graph = self.branch.repository.get_graph()
2240
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2242
base_tree = self.branch.repository.revision_tree(base_rev_id)
2243
other_tree = self.branch.repository.revision_tree(old_tip)
2244
result += merge.merge_inner(
2249
change_reporter=change_reporter)
2252
def _write_hashcache_if_dirty(self):
2253
"""Write out the hashcache if it is dirty."""
2254
if self._hashcache.needs_write:
2256
self._hashcache.write()
2258
if e.errno not in (errno.EPERM, errno.EACCES):
2260
# TODO: jam 20061219 Should this be a warning? A single line
2261
# warning might be sufficient to let the user know what
2263
mutter('Could not write hashcache for %s\nError: %s',
2264
self._hashcache.cache_file_name(), e)
2266
@needs_tree_write_lock
2267
def _write_inventory(self, inv):
2268
"""Write inventory as the current inventory."""
2269
self._set_inventory(inv, dirty=True)
2272
def set_conflicts(self, arg):
2273
raise errors.UnsupportedOperation(self.set_conflicts, self)
2275
def add_conflicts(self, arg):
2276
raise errors.UnsupportedOperation(self.add_conflicts, self)
2279
def conflicts(self):
2280
conflicts = _mod_conflicts.ConflictList()
2281
for conflicted in self._iter_conflicts():
2284
if file_kind(self.abspath(conflicted)) != "file":
2286
except errors.NoSuchFile:
2289
for suffix in ('.THIS', '.OTHER'):
2291
kind = file_kind(self.abspath(conflicted+suffix))
2294
except errors.NoSuchFile:
2298
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2299
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2301
file_id=self.path2id(conflicted)))
2304
def walkdirs(self, prefix=""):
2305
"""Walk the directories of this tree.
2307
returns a generator which yields items in the form:
2308
((curren_directory_path, fileid),
2309
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2312
This API returns a generator, which is only valid during the current
2313
tree transaction - within a single lock_read or lock_write duration.
2315
If the tree is not locked, it may cause an error to be raised,
2316
depending on the tree implementation.
2318
disk_top = self.abspath(prefix)
2319
if disk_top.endswith('/'):
2320
disk_top = disk_top[:-1]
2321
top_strip_len = len(disk_top) + 1
2322
inventory_iterator = self._walkdirs(prefix)
2323
disk_iterator = osutils.walkdirs(disk_top, prefix)
2325
current_disk = disk_iterator.next()
2326
disk_finished = False
2328
if not (e.errno == errno.ENOENT or
2329
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2332
disk_finished = True
2334
current_inv = inventory_iterator.next()
2335
inv_finished = False
2336
except StopIteration:
2339
while not inv_finished or not disk_finished:
2341
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2342
cur_disk_dir_content) = current_disk
2344
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2345
cur_disk_dir_content) = ((None, None), None)
2346
if not disk_finished:
2347
# strip out .bzr dirs
2348
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2349
len(cur_disk_dir_content) > 0):
2350
# osutils.walkdirs can be made nicer -
2351
# yield the path-from-prefix rather than the pathjoined
2353
bzrdir_loc = bisect_left(cur_disk_dir_content,
2355
if (bzrdir_loc < len(cur_disk_dir_content)
2356
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2357
# we dont yield the contents of, or, .bzr itself.
2358
del cur_disk_dir_content[bzrdir_loc]
2360
# everything is unknown
2363
# everything is missing
2366
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2368
# disk is before inventory - unknown
2369
dirblock = [(relpath, basename, kind, stat, None, None) for
2370
relpath, basename, kind, stat, top_path in
2371
cur_disk_dir_content]
2372
yield (cur_disk_dir_relpath, None), dirblock
2374
current_disk = disk_iterator.next()
2375
except StopIteration:
2376
disk_finished = True
2378
# inventory is before disk - missing.
2379
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2380
for relpath, basename, dkind, stat, fileid, kind in
2382
yield (current_inv[0][0], current_inv[0][1]), dirblock
2384
current_inv = inventory_iterator.next()
2385
except StopIteration:
2388
# versioned present directory
2389
# merge the inventory and disk data together
2391
for relpath, subiterator in itertools.groupby(sorted(
2392
current_inv[1] + cur_disk_dir_content,
2393
key=operator.itemgetter(0)), operator.itemgetter(1)):
2394
path_elements = list(subiterator)
2395
if len(path_elements) == 2:
2396
inv_row, disk_row = path_elements
2397
# versioned, present file
2398
dirblock.append((inv_row[0],
2399
inv_row[1], disk_row[2],
2400
disk_row[3], inv_row[4],
2402
elif len(path_elements[0]) == 5:
2404
dirblock.append((path_elements[0][0],
2405
path_elements[0][1], path_elements[0][2],
2406
path_elements[0][3], None, None))
2407
elif len(path_elements[0]) == 6:
2408
# versioned, absent file.
2409
dirblock.append((path_elements[0][0],
2410
path_elements[0][1], 'unknown', None,
2411
path_elements[0][4], path_elements[0][5]))
2413
raise NotImplementedError('unreachable code')
2414
yield current_inv[0], dirblock
2416
current_inv = inventory_iterator.next()
2417
except StopIteration:
2420
current_disk = disk_iterator.next()
2421
except StopIteration:
2422
disk_finished = True
2424
def _walkdirs(self, prefix=""):
2425
"""Walk the directories of this tree.
2427
:prefix: is used as the directrory to start with.
2428
returns a generator which yields items in the form:
2429
((curren_directory_path, fileid),
2430
[(file1_path, file1_name, file1_kind, None, file1_id,
2433
_directory = 'directory'
2434
# get the root in the inventory
2435
inv = self.inventory
2436
top_id = inv.path2id(prefix)
2440
pending = [(prefix, '', _directory, None, top_id, None)]
2443
currentdir = pending.pop()
2444
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2445
top_id = currentdir[4]
2447
relroot = currentdir[0] + '/'
2450
# FIXME: stash the node in pending
2452
if entry.kind == 'directory':
2453
for name, child in entry.sorted_children():
2454
dirblock.append((relroot + name, name, child.kind, None,
2455
child.file_id, child.kind
2457
yield (currentdir[0], entry.file_id), dirblock
2458
# push the user specified dirs from dirblock
2459
for dir in reversed(dirblock):
2460
if dir[2] == _directory:
2463
@needs_tree_write_lock
2464
def auto_resolve(self):
2465
"""Automatically resolve text conflicts according to contents.
2467
Only text conflicts are auto_resolvable. Files with no conflict markers
2468
are considered 'resolved', because bzr always puts conflict markers
2469
into files that have text conflicts. The corresponding .THIS .BASE and
2470
.OTHER files are deleted, as per 'resolve'.
2471
:return: a tuple of ConflictLists: (un_resolved, resolved).
2473
un_resolved = _mod_conflicts.ConflictList()
2474
resolved = _mod_conflicts.ConflictList()
2475
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2476
for conflict in self.conflicts():
2477
if (conflict.typestring != 'text conflict' or
2478
self.kind(conflict.file_id) != 'file'):
2479
un_resolved.append(conflict)
2481
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2483
for line in my_file:
2484
if conflict_re.search(line):
2485
un_resolved.append(conflict)
2488
resolved.append(conflict)
2491
resolved.remove_files(self)
2492
self.set_conflicts(un_resolved)
2493
return un_resolved, resolved
2497
tree_basis = self.basis_tree()
2498
tree_basis.lock_read()
2500
repo_basis = self.branch.repository.revision_tree(
2501
self.last_revision())
2502
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2503
raise errors.BzrCheckError(
2504
"Mismatched basis inventory content.")
2509
def _validate(self):
2510
"""Validate internal structures.
2512
This is meant mostly for the test suite. To give it a chance to detect
2513
corruption after actions have occurred. The default implementation is a
2516
:return: None. An exception should be raised if there is an error.
2521
def _get_rules_searcher(self, default_searcher):
2522
"""See Tree._get_rules_searcher."""
2523
if self._rules_searcher is None:
2524
self._rules_searcher = super(WorkingTree,
2525
self)._get_rules_searcher(default_searcher)
2526
return self._rules_searcher
2528
def get_shelf_manager(self):
2529
"""Return the ShelfManager for this WorkingTree."""
2530
from bzrlib.shelf import ShelfManager
2531
return ShelfManager(self, self._transport)
2534
class WorkingTree2(WorkingTree):
2535
"""This is the Format 2 working tree.
2537
This was the first weave based working tree.
2538
- uses os locks for locking.
2539
- uses the branch last-revision.
2542
def __init__(self, *args, **kwargs):
2543
super(WorkingTree2, self).__init__(*args, **kwargs)
2544
# WorkingTree2 has more of a constraint that self._inventory must
2545
# exist. Because this is an older format, we don't mind the overhead
2546
# caused by the extra computation here.
2548
# Newer WorkingTree's should only have self._inventory set when they
2550
if self._inventory is None:
2551
self.read_working_inventory()
2553
def lock_tree_write(self):
2554
"""See WorkingTree.lock_tree_write().
2556
In Format2 WorkingTrees we have a single lock for the branch and tree
2557
so lock_tree_write() degrades to lock_write().
2559
self.branch.lock_write()
2561
return self._control_files.lock_write()
2563
self.branch.unlock()
2567
# do non-implementation specific cleanup
2570
# we share control files:
2571
if self._control_files._lock_count == 3:
2572
# _inventory_is_modified is always False during a read lock.
2573
if self._inventory_is_modified:
2575
self._write_hashcache_if_dirty()
2577
# reverse order of locking.
2579
return self._control_files.unlock()
2581
self.branch.unlock()
2584
class WorkingTree3(WorkingTree):
2585
"""This is the Format 3 working tree.
2587
This differs from the base WorkingTree by:
2588
- having its own file lock
2589
- having its own last-revision property.
2591
This is new in bzr 0.8
2595
def _last_revision(self):
2596
"""See Mutable.last_revision."""
2598
return self._transport.get_bytes('last-revision')
2599
except errors.NoSuchFile:
2600
return _mod_revision.NULL_REVISION
2602
def _change_last_revision(self, revision_id):
2603
"""See WorkingTree._change_last_revision."""
2604
if revision_id is None or revision_id == NULL_REVISION:
2606
self._transport.delete('last-revision')
2607
except errors.NoSuchFile:
2611
self._transport.put_bytes('last-revision', revision_id,
2612
mode=self._control_files._file_mode)
2615
@needs_tree_write_lock
2616
def set_conflicts(self, conflicts):
2617
self._put_rio('conflicts', conflicts.to_stanzas(),
2620
@needs_tree_write_lock
2621
def add_conflicts(self, new_conflicts):
2622
conflict_set = set(self.conflicts())
2623
conflict_set.update(set(list(new_conflicts)))
2624
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2625
key=_mod_conflicts.Conflict.sort_key)))
2628
def conflicts(self):
2630
confile = self._transport.get('conflicts')
2631
except errors.NoSuchFile:
2632
return _mod_conflicts.ConflictList()
2635
if confile.next() != CONFLICT_HEADER_1 + '\n':
2636
raise errors.ConflictFormatError()
2637
except StopIteration:
2638
raise errors.ConflictFormatError()
2639
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2644
# do non-implementation specific cleanup
2646
if self._control_files._lock_count == 1:
2647
# _inventory_is_modified is always False during a read lock.
2648
if self._inventory_is_modified:
2650
self._write_hashcache_if_dirty()
2651
# reverse order of locking.
2653
return self._control_files.unlock()
2655
self.branch.unlock()
2658
def get_conflicted_stem(path):
2659
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2660
if path.endswith(suffix):
2661
return path[:-len(suffix)]
2664
class WorkingTreeFormat(object):
2665
"""An encapsulation of the initialization and open routines for a format.
2667
Formats provide three things:
2668
* An initialization routine,
2672
Formats are placed in an dict by their format string for reference
2673
during workingtree opening. Its not required that these be instances, they
2674
can be classes themselves with class methods - it simply depends on
2675
whether state is needed for a given format or not.
2677
Once a format is deprecated, just deprecate the initialize and open
2678
methods on the format class. Do not deprecate the object, as the
2679
object will be created every time regardless.
2682
_default_format = None
2683
"""The default format used for new trees."""
2686
"""The known formats."""
2688
requires_rich_root = False
2690
upgrade_recommended = False
2693
def find_format(klass, a_bzrdir):
2694
"""Return the format for the working tree object in a_bzrdir."""
2696
transport = a_bzrdir.get_workingtree_transport(None)
2697
format_string = transport.get("format").read()
2698
return klass._formats[format_string]
2699
except errors.NoSuchFile:
2700
raise errors.NoWorkingTree(base=transport.base)
2702
raise errors.UnknownFormatError(format=format_string,
2703
kind="working tree")
2705
def __eq__(self, other):
2706
return self.__class__ is other.__class__
2708
def __ne__(self, other):
2709
return not (self == other)
2712
def get_default_format(klass):
2713
"""Return the current default format."""
2714
return klass._default_format
2716
def get_format_string(self):
2717
"""Return the ASCII format string that identifies this format."""
2718
raise NotImplementedError(self.get_format_string)
2720
def get_format_description(self):
2721
"""Return the short description for this format."""
2722
raise NotImplementedError(self.get_format_description)
2724
def is_supported(self):
2725
"""Is this format supported?
2727
Supported formats can be initialized and opened.
2728
Unsupported formats may not support initialization or committing or
2729
some other features depending on the reason for not being supported.
2734
def register_format(klass, format):
2735
klass._formats[format.get_format_string()] = format
2738
def set_default_format(klass, format):
2739
klass._default_format = format
2742
def unregister_format(klass, format):
2743
del klass._formats[format.get_format_string()]
2746
class WorkingTreeFormat2(WorkingTreeFormat):
2747
"""The second working tree format.
2749
This format modified the hash cache from the format 1 hash cache.
2752
upgrade_recommended = True
2754
def get_format_description(self):
2755
"""See WorkingTreeFormat.get_format_description()."""
2756
return "Working tree format 2"
2758
def _stub_initialize_on_transport(self, transport, file_mode):
2759
"""Workaround: create control files for a remote working tree.
2761
This ensures that it can later be updated and dealt with locally,
2762
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2763
no working tree. (See bug #43064).
2767
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2769
transport.put_file('inventory', sio, file_mode)
2770
transport.put_bytes('pending-merges', '', file_mode)
2772
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2773
accelerator_tree=None, hardlink=False):
2774
"""See WorkingTreeFormat.initialize()."""
2775
if not isinstance(a_bzrdir.transport, LocalTransport):
2776
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2777
if from_branch is not None:
2778
branch = from_branch
2780
branch = a_bzrdir.open_branch()
2781
if revision_id is None:
2782
revision_id = _mod_revision.ensure_null(branch.last_revision())
2785
branch.generate_revision_history(revision_id)
2789
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2795
basis_tree = branch.repository.revision_tree(revision_id)
2796
if basis_tree.inventory.root is not None:
2797
wt.set_root_id(basis_tree.get_root_id())
2798
# set the parent list and cache the basis tree.
2799
if _mod_revision.is_null(revision_id):
2802
parent_trees = [(revision_id, basis_tree)]
2803
wt.set_parent_trees(parent_trees)
2804
transform.build_tree(basis_tree, wt)
2808
super(WorkingTreeFormat2, self).__init__()
2809
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2811
def open(self, a_bzrdir, _found=False):
2812
"""Return the WorkingTree object for a_bzrdir
2814
_found is a private parameter, do not use it. It is used to indicate
2815
if format probing has already been done.
2818
# we are being called directly and must probe.
2819
raise NotImplementedError
2820
if not isinstance(a_bzrdir.transport, LocalTransport):
2821
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2822
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2828
class WorkingTreeFormat3(WorkingTreeFormat):
2829
"""The second working tree format updated to record a format marker.
2832
- exists within a metadir controlling .bzr
2833
- includes an explicit version marker for the workingtree control
2834
files, separate from the BzrDir format
2835
- modifies the hash cache format
2837
- uses a LockDir to guard access for writes.
2840
upgrade_recommended = True
2842
def get_format_string(self):
2843
"""See WorkingTreeFormat.get_format_string()."""
2844
return "Bazaar-NG Working Tree format 3"
2846
def get_format_description(self):
2847
"""See WorkingTreeFormat.get_format_description()."""
2848
return "Working tree format 3"
2850
_lock_file_name = 'lock'
2851
_lock_class = LockDir
2853
_tree_class = WorkingTree3
2855
def __get_matchingbzrdir(self):
2856
return bzrdir.BzrDirMetaFormat1()
2858
_matchingbzrdir = property(__get_matchingbzrdir)
2860
def _open_control_files(self, a_bzrdir):
2861
transport = a_bzrdir.get_workingtree_transport(None)
2862
return LockableFiles(transport, self._lock_file_name,
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2867
"""See WorkingTreeFormat.initialize().
2869
:param revision_id: if supplied, create a working tree at a different
2870
revision than the branch is at.
2871
:param accelerator_tree: A tree which can be used for retrieving file
2872
contents more quickly than the revision tree, i.e. a workingtree.
2873
The revision tree will be used for cases where accelerator_tree's
2874
content is different.
2875
:param hardlink: If true, hard-link files from accelerator_tree,
2878
if not isinstance(a_bzrdir.transport, LocalTransport):
2879
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2880
transport = a_bzrdir.get_workingtree_transport(self)
2881
control_files = self._open_control_files(a_bzrdir)
2882
control_files.create_lock()
2883
control_files.lock_write()
2884
transport.put_bytes('format', self.get_format_string(),
2885
mode=control_files._file_mode)
2886
if from_branch is not None:
2887
branch = from_branch
2889
branch = a_bzrdir.open_branch()
2890
if revision_id is None:
2891
revision_id = _mod_revision.ensure_null(branch.last_revision())
2892
# WorkingTree3 can handle an inventory which has a unique root id.
2893
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2894
# those trees. And because there isn't a format bump inbetween, we
2895
# are maintaining compatibility with older clients.
2896
# inv = Inventory(root_id=gen_root_id())
2897
inv = self._initial_inventory()
2898
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2904
_control_files=control_files)
2905
wt.lock_tree_write()
2907
basis_tree = branch.repository.revision_tree(revision_id)
2908
# only set an explicit root id if there is one to set.
2909
if basis_tree.inventory.root is not None:
2910
wt.set_root_id(basis_tree.get_root_id())
2911
if revision_id == NULL_REVISION:
2912
wt.set_parent_trees([])
2914
wt.set_parent_trees([(revision_id, basis_tree)])
2915
transform.build_tree(basis_tree, wt)
2917
# Unlock in this order so that the unlock-triggers-flush in
2918
# WorkingTree is given a chance to fire.
2919
control_files.unlock()
2923
def _initial_inventory(self):
2927
super(WorkingTreeFormat3, self).__init__()
2929
def open(self, a_bzrdir, _found=False):
2930
"""Return the WorkingTree object for a_bzrdir
2932
_found is a private parameter, do not use it. It is used to indicate
2933
if format probing has already been done.
2936
# we are being called directly and must probe.
2937
raise NotImplementedError
2938
if not isinstance(a_bzrdir.transport, LocalTransport):
2939
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2940
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2943
def _open(self, a_bzrdir, control_files):
2944
"""Open the tree itself.
2946
:param a_bzrdir: the dir for the tree.
2947
:param control_files: the control files for the tree.
2949
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2953
_control_files=control_files)
2956
return self.get_format_string()
2959
__default_format = WorkingTreeFormat4()
2960
WorkingTreeFormat.register_format(__default_format)
2961
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2962
WorkingTreeFormat.set_default_format(__default_format)
2963
# formats which have no format string are not discoverable
2964
# and not independently creatable, so are not registered.
2965
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
