1
# Copyright (C) 2005-2010 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).
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
51
conflicts as _mod_conflicts,
60
revision as _mod_revision,
70
from bzrlib.workingtree_4 import (
77
from bzrlib import symbol_versioning
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
79
from bzrlib.lock import LogicalLockResult
80
from bzrlib.lockable_files import LockableFiles
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
96
from bzrlib.trace import mutter, note
97
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
115
class TreeEntry(object):
116
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
119
InventoryEntries without ids - though that seems wrong. For now,
120
this is a parallel hierarchy to InventoryEntry, and needs to become
121
one of several things: decorates to that hierarchy, children of, or
123
Another note is that these objects are currently only used when there is
124
no InventoryEntry available - i.e. for unversioned objects.
125
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
128
def __eq__(self, other):
129
# yes, this us ugly, TODO: best practice __eq__ style.
130
return (isinstance(other, TreeEntry)
131
and other.__class__ == self.__class__)
133
def kind_character(self):
137
class TreeDirectory(TreeEntry):
138
"""See TreeEntry. This is a directory in a working tree."""
140
def __eq__(self, other):
141
return (isinstance(other, TreeDirectory)
142
and other.__class__ == self.__class__)
144
def kind_character(self):
148
class TreeFile(TreeEntry):
149
"""See TreeEntry. This is a regular file in a working tree."""
151
def __eq__(self, other):
152
return (isinstance(other, TreeFile)
153
and other.__class__ == self.__class__)
155
def kind_character(self):
159
class TreeLink(TreeEntry):
160
"""See TreeEntry. This is a symlink in a working tree."""
162
def __eq__(self, other):
163
return (isinstance(other, TreeLink)
164
and other.__class__ == self.__class__)
166
def kind_character(self):
170
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
bzrdir.ControlComponent):
172
"""Working copy tree.
174
The inventory is held in the `Branch` working-inventory, and the
175
files are in a directory on disk.
177
It is possible for a `WorkingTree` to have a filename which is
178
not listed in the Inventory and vice versa.
180
:ivar basedir: The root of the tree on disk. This is a unicode path object
181
(as opposed to a URL).
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()
254
def user_transport(self):
255
return self.bzrdir.user_transport
258
def control_transport(self):
259
return self._transport
261
def _detect_case_handling(self):
262
wt_trans = self.bzrdir.get_workingtree_transport(None)
264
wt_trans.stat("FoRMaT")
265
except errors.NoSuchFile:
266
self.case_sensitive = True
268
self.case_sensitive = False
270
self._setup_directory_is_tree_reference()
273
fget=lambda self: self._branch,
274
doc="""The branch this WorkingTree is connected to.
276
This cannot be set - it is reflective of the actual disk structure
277
the working tree has been constructed from.
280
def break_lock(self):
281
"""Break a lock if one is present from another instance.
283
Uses the ui factory to ask for confirmation if the lock may be from
286
This will probe the repository for its lock as well.
288
self._control_files.break_lock()
289
self.branch.break_lock()
291
def _get_check_refs(self):
292
"""Return the references needed to perform a check of this tree.
294
The default implementation returns no refs, and is only suitable for
295
trees that have no local caching and can commit on ghosts at any time.
297
:seealso: bzrlib.check for details about check_refs.
301
def requires_rich_root(self):
302
return self._format.requires_rich_root
304
def supports_tree_reference(self):
307
def supports_content_filtering(self):
308
return self._format.supports_content_filtering()
310
def supports_views(self):
311
return self.views.supports_views()
313
def _set_inventory(self, inv, dirty):
314
"""Set the internal cached inventory.
316
:param inv: The inventory to set.
317
:param dirty: A boolean indicating whether the inventory is the same
318
logical inventory as whats on disk. If True the inventory is not
319
the same and should be written to disk or data will be lost, if
320
False then the inventory is the same as that on disk and any
321
serialisation would be unneeded overhead.
323
self._inventory = inv
324
self._inventory_is_modified = dirty
327
def open(path=None, _unsupported=False):
328
"""Open an existing working tree at path.
332
path = osutils.getcwd()
333
control = bzrdir.BzrDir.open(path, _unsupported)
334
return control.open_workingtree(_unsupported)
337
def open_containing(path=None):
338
"""Open an existing working tree which has its root about path.
340
This probes for a working tree at path and searches upwards from there.
342
Basically we keep looking up until we find the control directory or
343
run into /. If there isn't one, raises NotBranchError.
344
TODO: give this a new exception.
345
If there is one, it is returned, along with the unused portion of path.
347
:return: The WorkingTree that contains 'path', and the rest of path
350
path = osutils.getcwd()
351
control, relpath = bzrdir.BzrDir.open_containing(path)
353
return control.open_workingtree(), relpath
356
def open_downlevel(path=None):
357
"""Open an unsupported working tree.
359
Only intended for advanced situations like upgrading part of a bzrdir.
361
return WorkingTree.open(path, _unsupported=True)
364
def find_trees(location):
365
def list_current(transport):
366
return [d for d in transport.list_dir('') if d != '.bzr']
367
def evaluate(bzrdir):
369
tree = bzrdir.open_workingtree()
370
except errors.NoWorkingTree:
374
t = transport.get_transport(location)
375
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
376
list_current=list_current)
377
return [tr for tr in iterator if tr is not None]
379
# should be deprecated - this is slow and in any case treating them as a
380
# container is (we now know) bad style -- mbp 20070302
381
## @deprecated_method(zero_fifteen)
383
"""Iterate through file_ids for this tree.
385
file_ids are in a WorkingTree if they are in the working inventory
386
and the working file exists.
388
inv = self._inventory
389
for path, ie in inv.iter_entries():
390
if osutils.lexists(self.abspath(path)):
393
def all_file_ids(self):
394
"""See Tree.iter_all_file_ids"""
395
return set(self.inventory)
398
return "<%s of %s>" % (self.__class__.__name__,
399
getattr(self, 'basedir', None))
401
def abspath(self, filename):
402
return pathjoin(self.basedir, filename)
404
def basis_tree(self):
405
"""Return RevisionTree for the current last revision.
407
If the left most parent is a ghost then the returned tree will be an
408
empty tree - one obtained by calling
409
repository.revision_tree(NULL_REVISION).
412
revision_id = self.get_parent_ids()[0]
414
# no parents, return an empty revision tree.
415
# in the future this should return the tree for
416
# 'empty:' - the implicit root empty tree.
417
return self.branch.repository.revision_tree(
418
_mod_revision.NULL_REVISION)
420
return self.revision_tree(revision_id)
421
except errors.NoSuchRevision:
423
# No cached copy available, retrieve from the repository.
424
# FIXME? RBC 20060403 should we cache the inventory locally
427
return self.branch.repository.revision_tree(revision_id)
428
except (errors.RevisionNotPresent, errors.NoSuchRevision):
429
# the basis tree *may* be a ghost or a low level error may have
430
# occurred. If the revision is present, its a problem, if its not
432
if self.branch.repository.has_revision(revision_id):
434
# the basis tree is a ghost so return an empty tree.
435
return self.branch.repository.revision_tree(
436
_mod_revision.NULL_REVISION)
439
self._flush_ignore_list_cache()
441
def relpath(self, path):
442
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
445
interpreted relative to the python current working directory.
447
return osutils.relpath(self.basedir, path)
449
def has_filename(self, filename):
450
return osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id, path=None, filtered=True):
453
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
455
def get_file_with_stat(self, file_id, path=None, filtered=True,
457
"""See Tree.get_file_with_stat."""
459
path = self.id2path(file_id)
460
file_obj = self.get_file_byname(path, filtered=False)
461
stat_value = _fstat(file_obj.fileno())
462
if filtered and self.supports_content_filtering():
463
filters = self._content_filter_stack(path)
464
file_obj = filtered_input_file(file_obj, filters)
465
return (file_obj, stat_value)
467
def get_file_text(self, file_id, path=None, filtered=True):
468
my_file = self.get_file(file_id, path=path, filtered=filtered)
470
return my_file.read()
474
def get_file_byname(self, filename, filtered=True):
475
path = self.abspath(filename)
477
if filtered and self.supports_content_filtering():
478
filters = self._content_filter_stack(filename)
479
return filtered_input_file(f, filters)
483
def get_file_lines(self, file_id, path=None, filtered=True):
484
"""See Tree.get_file_lines()"""
485
file = self.get_file(file_id, path, filtered=filtered)
487
return file.readlines()
492
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
"""See Tree.annotate_iter
495
This implementation will use the basis tree implementation if possible.
496
Lines not in the basis are attributed to CURRENT_REVISION
498
If there are pending merges, lines added by those merges will be
499
incorrectly attributed to CURRENT_REVISION (but after committing, the
500
attribution will be correct).
502
maybe_file_parent_keys = []
503
for parent_id in self.get_parent_ids():
505
parent_tree = self.revision_tree(parent_id)
506
except errors.NoSuchRevisionInTree:
507
parent_tree = self.branch.repository.revision_tree(parent_id)
508
parent_tree.lock_read()
510
if file_id not in parent_tree:
512
ie = parent_tree.inventory[file_id]
513
if ie.kind != 'file':
514
# Note: this is slightly unnecessary, because symlinks and
515
# directories have a "text" which is the empty text, and we
516
# know that won't mess up annotations. But it seems cleaner
518
parent_text_key = (file_id, ie.revision)
519
if parent_text_key not in maybe_file_parent_keys:
520
maybe_file_parent_keys.append(parent_text_key)
523
graph = _mod_graph.Graph(self.branch.repository.texts)
524
heads = graph.heads(maybe_file_parent_keys)
525
file_parent_keys = []
526
for key in maybe_file_parent_keys:
528
file_parent_keys.append(key)
530
# Now we have the parents of this content
531
annotator = self.branch.repository.texts.get_annotator()
532
text = self.get_file_text(file_id)
533
this_key =(file_id, default_revision)
534
annotator.add_special_text(this_key, file_parent_keys, text)
535
annotations = [(key[-1], line)
536
for key, line in annotator.annotate_flat(this_key)]
539
def _get_ancestors(self, default_revision):
540
ancestors = set([default_revision])
541
for parent_id in self.get_parent_ids():
542
ancestors.update(self.branch.repository.get_ancestry(
543
parent_id, topo_sorted=False))
546
def get_parent_ids(self):
547
"""See Tree.get_parent_ids.
549
This implementation reads the pending merges list and last_revision
550
value and uses that to decide what the parents list should be.
552
last_rev = _mod_revision.ensure_null(self._last_revision())
553
if _mod_revision.NULL_REVISION == last_rev:
558
merges_bytes = self._transport.get_bytes('pending-merges')
559
except errors.NoSuchFile:
562
for l in osutils.split_lines(merges_bytes):
563
revision_id = l.rstrip('\n')
564
parents.append(revision_id)
568
def get_root_id(self):
569
"""Return the id of this trees root"""
570
return self._inventory.root.file_id
572
def _get_store_filename(self, file_id):
573
## XXX: badly named; this is not in the store at all
574
return self.abspath(self.id2path(file_id))
577
def clone(self, to_bzrdir, revision_id=None):
578
"""Duplicate this working tree into to_bzr, including all state.
580
Specifically modified files are kept as modified, but
581
ignored and unknown files are discarded.
583
If you want to make a new line of development, see bzrdir.sprout()
586
If not None, the cloned tree will have its last revision set to
587
revision, and difference between the source trees last revision
588
and this one merged in.
590
# assumes the target bzr dir format is compatible.
591
result = to_bzrdir.create_workingtree()
592
self.copy_content_into(result, revision_id)
596
def copy_content_into(self, tree, revision_id=None):
597
"""Copy the current content and user files of this tree into tree."""
598
tree.set_root_id(self.get_root_id())
599
if revision_id is None:
600
merge.transform_tree(tree, self)
602
# TODO now merge from tree.last_revision to revision (to preserve
603
# user local changes)
604
merge.transform_tree(tree, self)
605
tree.set_parent_ids([revision_id])
607
def id2abspath(self, file_id):
608
return self.abspath(self.id2path(file_id))
610
def has_id(self, file_id):
611
# files that have been deleted are excluded
613
if not inv.has_id(file_id):
615
path = inv.id2path(file_id)
616
return osutils.lexists(self.abspath(path))
618
def has_or_had_id(self, file_id):
619
if file_id == self.inventory.root.file_id:
621
return self.inventory.has_id(file_id)
623
__contains__ = has_id
625
def get_file_size(self, file_id):
626
"""See Tree.get_file_size"""
627
# XXX: this returns the on-disk size; it should probably return the
630
return os.path.getsize(self.id2abspath(file_id))
632
if e.errno != errno.ENOENT:
638
def get_file_sha1(self, file_id, path=None, stat_value=None):
640
path = self._inventory.id2path(file_id)
641
return self._hashcache.get_sha1(path, stat_value)
643
def get_file_mtime(self, file_id, path=None):
645
path = self.inventory.id2path(file_id)
646
return os.lstat(self.abspath(path)).st_mtime
648
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
649
file_id = self.path2id(path)
651
# For unversioned files on win32, we just assume they are not
654
return self._inventory[file_id].executable
656
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
657
mode = stat_result.st_mode
658
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
660
if not supports_executable():
661
def is_executable(self, file_id, path=None):
662
return self._inventory[file_id].executable
664
_is_executable_from_path_and_stat = \
665
_is_executable_from_path_and_stat_from_basis
667
def is_executable(self, file_id, path=None):
669
path = self.id2path(file_id)
670
mode = os.lstat(self.abspath(path)).st_mode
671
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
673
_is_executable_from_path_and_stat = \
674
_is_executable_from_path_and_stat_from_stat
676
@needs_tree_write_lock
677
def _add(self, files, ids, kinds):
678
"""See MutableTree._add."""
679
# TODO: Re-adding a file that is removed in the working copy
680
# should probably put it back with the previous ID.
681
# the read and write working inventory should not occur in this
682
# function - they should be part of lock_write and unlock.
684
for f, file_id, kind in zip(files, ids, kinds):
686
inv.add_path(f, kind=kind)
688
inv.add_path(f, kind=kind, file_id=file_id)
689
self._inventory_is_modified = True
691
@needs_tree_write_lock
692
def _gather_kinds(self, files, kinds):
693
"""See MutableTree._gather_kinds."""
694
for pos, f in enumerate(files):
695
if kinds[pos] is None:
696
fullpath = normpath(self.abspath(f))
698
kinds[pos] = file_kind(fullpath)
700
if e.errno == errno.ENOENT:
701
raise errors.NoSuchFile(fullpath)
704
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
705
"""Add revision_id as a parent.
707
This is equivalent to retrieving the current list of parent ids
708
and setting the list to its value plus revision_id.
710
:param revision_id: The revision id to add to the parent list. It may
711
be a ghost revision as long as its not the first parent to be added,
712
or the allow_leftmost_as_ghost parameter is set True.
713
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
715
parents = self.get_parent_ids() + [revision_id]
716
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
717
or allow_leftmost_as_ghost)
719
@needs_tree_write_lock
720
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
721
"""Add revision_id, tree tuple as a parent.
723
This is equivalent to retrieving the current list of parent trees
724
and setting the list to its value plus parent_tuple. See also
725
add_parent_tree_id - if you only have a parent id available it will be
726
simpler to use that api. If you have the parent already available, using
727
this api is preferred.
729
:param parent_tuple: The (revision id, tree) to add to the parent list.
730
If the revision_id is a ghost, pass None for the tree.
731
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
733
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
734
if len(parent_ids) > 1:
735
# the leftmost may have already been a ghost, preserve that if it
737
allow_leftmost_as_ghost = True
738
self.set_parent_ids(parent_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
@needs_tree_write_lock
742
def add_pending_merge(self, *revision_ids):
743
# TODO: Perhaps should check at this point that the
744
# history of the revision is actually present?
745
parents = self.get_parent_ids()
747
for rev_id in revision_ids:
748
if rev_id in parents:
750
parents.append(rev_id)
753
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
755
def path_content_summary(self, path, _lstat=os.lstat,
756
_mapper=osutils.file_kind_from_stat_mode):
757
"""See Tree.path_content_summary."""
758
abspath = self.abspath(path)
760
stat_result = _lstat(abspath)
762
if getattr(e, 'errno', None) == errno.ENOENT:
764
return ('missing', None, None, None)
765
# propagate other errors
767
kind = _mapper(stat_result.st_mode)
769
return self._file_content_summary(path, stat_result)
770
elif kind == 'directory':
771
# perhaps it looks like a plain directory, but it's really a
773
if self._directory_is_tree_reference(path):
774
kind = 'tree-reference'
775
return kind, None, None, None
776
elif kind == 'symlink':
777
target = osutils.readlink(abspath)
778
return ('symlink', None, None, target)
780
return (kind, None, None, None)
782
def _file_content_summary(self, path, stat_result):
783
size = stat_result.st_size
784
executable = self._is_executable_from_path_and_stat(path, stat_result)
785
# try for a stat cache lookup
786
return ('file', size, executable, self._sha_from_stat(
789
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
790
"""Common ghost checking functionality from set_parent_*.
792
This checks that the left hand-parent exists if there are any
795
if len(revision_ids) > 0:
796
leftmost_id = revision_ids[0]
797
if (not allow_leftmost_as_ghost and not
798
self.branch.repository.has_revision(leftmost_id)):
799
raise errors.GhostRevisionUnusableHere(leftmost_id)
801
def _set_merges_from_parent_ids(self, parent_ids):
802
merges = parent_ids[1:]
803
self._transport.put_bytes('pending-merges', '\n'.join(merges),
804
mode=self.bzrdir._get_file_mode())
806
def _filter_parent_ids_by_ancestry(self, revision_ids):
807
"""Check that all merged revisions are proper 'heads'.
809
This will always return the first revision_id, and any merged revisions
812
if len(revision_ids) == 0:
814
graph = self.branch.repository.get_graph()
815
heads = graph.heads(revision_ids)
816
new_revision_ids = revision_ids[:1]
817
for revision_id in revision_ids[1:]:
818
if revision_id in heads and revision_id not in new_revision_ids:
819
new_revision_ids.append(revision_id)
820
if new_revision_ids != revision_ids:
821
trace.mutter('requested to set revision_ids = %s,'
822
' but filtered to %s', revision_ids, new_revision_ids)
823
return new_revision_ids
825
@needs_tree_write_lock
826
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
827
"""Set the parent ids to revision_ids.
829
See also set_parent_trees. This api will try to retrieve the tree data
830
for each element of revision_ids from the trees repository. If you have
831
tree data already available, it is more efficient to use
832
set_parent_trees rather than set_parent_ids. set_parent_ids is however
833
an easier API to use.
835
:param revision_ids: The revision_ids to set as the parent ids of this
836
working tree. Any of these may be ghosts.
838
self._check_parents_for_ghosts(revision_ids,
839
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
840
for revision_id in revision_ids:
841
_mod_revision.check_not_reserved_id(revision_id)
843
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
845
if len(revision_ids) > 0:
846
self.set_last_revision(revision_ids[0])
848
self.set_last_revision(_mod_revision.NULL_REVISION)
850
self._set_merges_from_parent_ids(revision_ids)
852
@needs_tree_write_lock
853
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
854
"""See MutableTree.set_parent_trees."""
855
parent_ids = [rev for (rev, tree) in parents_list]
856
for revision_id in parent_ids:
857
_mod_revision.check_not_reserved_id(revision_id)
859
self._check_parents_for_ghosts(parent_ids,
860
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
862
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
864
if len(parent_ids) == 0:
865
leftmost_parent_id = _mod_revision.NULL_REVISION
866
leftmost_parent_tree = None
868
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
870
if self._change_last_revision(leftmost_parent_id):
871
if leftmost_parent_tree is None:
872
# If we don't have a tree, fall back to reading the
873
# parent tree from the repository.
874
self._cache_basis_inventory(leftmost_parent_id)
876
inv = leftmost_parent_tree.inventory
877
xml = self._create_basis_xml_from_inventory(
878
leftmost_parent_id, inv)
879
self._write_basis_inventory(xml)
880
self._set_merges_from_parent_ids(parent_ids)
882
@needs_tree_write_lock
883
def set_pending_merges(self, rev_list):
884
parents = self.get_parent_ids()
885
leftmost = parents[:1]
886
new_parents = leftmost + rev_list
887
self.set_parent_ids(new_parents)
889
@needs_tree_write_lock
890
def set_merge_modified(self, modified_hashes):
892
for file_id, hash in modified_hashes.iteritems():
893
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
894
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
896
def _sha_from_stat(self, path, stat_result):
897
"""Get a sha digest from the tree's stat cache.
899
The default implementation assumes no stat cache is present.
901
:param path: The path.
902
:param stat_result: The stat result being looked up.
906
def _put_rio(self, filename, stanzas, header):
907
self._must_be_locked()
908
my_file = rio_file(stanzas, header)
909
self._transport.put_file(filename, my_file,
910
mode=self.bzrdir._get_file_mode())
912
@needs_write_lock # because merge pulls data into the branch.
913
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
914
merge_type=None, force=False):
915
"""Merge from a branch into this working tree.
917
:param branch: The branch to merge from.
918
:param to_revision: If non-None, the merge will merge to to_revision,
919
but not beyond it. to_revision does not need to be in the history
920
of the branch when it is supplied. If None, to_revision defaults to
921
branch.last_revision().
923
from bzrlib.merge import Merger, Merge3Merger
924
merger = Merger(self.branch, this_tree=self)
925
# check that there are no local alterations
926
if not force and self.has_changes():
927
raise errors.UncommittedChanges(self)
928
if to_revision is None:
929
to_revision = _mod_revision.ensure_null(branch.last_revision())
930
merger.other_rev_id = to_revision
931
if _mod_revision.is_null(merger.other_rev_id):
932
raise errors.NoCommits(branch)
933
self.branch.fetch(branch, last_revision=merger.other_rev_id)
934
merger.other_basis = merger.other_rev_id
935
merger.other_tree = self.branch.repository.revision_tree(
937
merger.other_branch = branch
938
if from_revision is None:
941
merger.set_base_revision(from_revision, branch)
942
if merger.base_rev_id == merger.other_rev_id:
943
raise errors.PointlessMerge
944
merger.backup_files = False
945
if merge_type is None:
946
merger.merge_type = Merge3Merger
948
merger.merge_type = merge_type
949
merger.set_interesting_files(None)
950
merger.show_base = False
951
merger.reprocess = False
952
conflicts = merger.do_merge()
957
def merge_modified(self):
958
"""Return a dictionary of files modified by a merge.
960
The list is initialized by WorkingTree.set_merge_modified, which is
961
typically called after we make some automatic updates to the tree
964
This returns a map of file_id->sha1, containing only files which are
965
still in the working inventory and have that text hash.
968
hashfile = self._transport.get('merge-hashes')
969
except errors.NoSuchFile:
974
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
975
raise errors.MergeModifiedFormatError()
976
except StopIteration:
977
raise errors.MergeModifiedFormatError()
978
for s in RioReader(hashfile):
979
# RioReader reads in Unicode, so convert file_ids back to utf8
980
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
981
if file_id not in self.inventory:
983
text_hash = s.get("hash")
984
if text_hash == self.get_file_sha1(file_id):
985
merge_hashes[file_id] = text_hash
991
def mkdir(self, path, file_id=None):
992
"""See MutableTree.mkdir()."""
994
file_id = generate_ids.gen_file_id(os.path.basename(path))
995
os.mkdir(self.abspath(path))
996
self.add(path, file_id, 'directory')
999
def get_symlink_target(self, file_id):
1000
abspath = self.id2abspath(file_id)
1001
target = osutils.readlink(abspath)
1005
def subsume(self, other_tree):
1006
def add_children(inventory, entry):
1007
for child_entry in entry.children.values():
1008
inventory._byid[child_entry.file_id] = child_entry
1009
if child_entry.kind == 'directory':
1010
add_children(inventory, child_entry)
1011
if other_tree.get_root_id() == self.get_root_id():
1012
raise errors.BadSubsumeSource(self, other_tree,
1013
'Trees have the same root')
1015
other_tree_path = self.relpath(other_tree.basedir)
1016
except errors.PathNotChild:
1017
raise errors.BadSubsumeSource(self, other_tree,
1018
'Tree is not contained by the other')
1019
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1020
if new_root_parent is None:
1021
raise errors.BadSubsumeSource(self, other_tree,
1022
'Parent directory is not versioned.')
1023
# We need to ensure that the result of a fetch will have a
1024
# versionedfile for the other_tree root, and only fetching into
1025
# RepositoryKnit2 guarantees that.
1026
if not self.branch.repository.supports_rich_root():
1027
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1028
other_tree.lock_tree_write()
1030
new_parents = other_tree.get_parent_ids()
1031
other_root = other_tree.inventory.root
1032
other_root.parent_id = new_root_parent
1033
other_root.name = osutils.basename(other_tree_path)
1034
self.inventory.add(other_root)
1035
add_children(self.inventory, other_root)
1036
self._write_inventory(self.inventory)
1037
# normally we don't want to fetch whole repositories, but i think
1038
# here we really do want to consolidate the whole thing.
1039
for parent_id in other_tree.get_parent_ids():
1040
self.branch.fetch(other_tree.branch, parent_id)
1041
self.add_parent_tree_id(parent_id)
1044
other_tree.bzrdir.retire_bzrdir()
1046
def _setup_directory_is_tree_reference(self):
1047
if self._branch.repository._format.supports_tree_reference:
1048
self._directory_is_tree_reference = \
1049
self._directory_may_be_tree_reference
1051
self._directory_is_tree_reference = \
1052
self._directory_is_never_tree_reference
1054
def _directory_is_never_tree_reference(self, relpath):
1057
def _directory_may_be_tree_reference(self, relpath):
1058
# as a special case, if a directory contains control files then
1059
# it's a tree reference, except that the root of the tree is not
1060
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1061
# TODO: We could ask all the control formats whether they
1062
# recognize this directory, but at the moment there's no cheap api
1063
# to do that. Since we probably can only nest bzr checkouts and
1064
# they always use this name it's ok for now. -- mbp 20060306
1066
# FIXME: There is an unhandled case here of a subdirectory
1067
# containing .bzr but not a branch; that will probably blow up
1068
# when you try to commit it. It might happen if there is a
1069
# checkout in a subdirectory. This can be avoided by not adding
1072
@needs_tree_write_lock
1073
def extract(self, file_id, format=None):
1074
"""Extract a subtree from this tree.
1076
A new branch will be created, relative to the path for this tree.
1080
segments = osutils.splitpath(path)
1081
transport = self.branch.bzrdir.root_transport
1082
for name in segments:
1083
transport = transport.clone(name)
1084
transport.ensure_base()
1087
sub_path = self.id2path(file_id)
1088
branch_transport = mkdirs(sub_path)
1090
format = self.bzrdir.cloning_metadir()
1091
branch_transport.ensure_base()
1092
branch_bzrdir = format.initialize_on_transport(branch_transport)
1094
repo = branch_bzrdir.find_repository()
1095
except errors.NoRepositoryPresent:
1096
repo = branch_bzrdir.create_repository()
1097
if not repo.supports_rich_root():
1098
raise errors.RootNotRich()
1099
new_branch = branch_bzrdir.create_branch()
1100
new_branch.pull(self.branch)
1101
for parent_id in self.get_parent_ids():
1102
new_branch.fetch(self.branch, parent_id)
1103
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1104
if tree_transport.base != branch_transport.base:
1105
tree_bzrdir = format.initialize_on_transport(tree_transport)
1106
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1107
target_branch=new_branch)
1109
tree_bzrdir = branch_bzrdir
1110
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1111
wt.set_parent_ids(self.get_parent_ids())
1112
my_inv = self.inventory
1113
child_inv = inventory.Inventory(root_id=None)
1114
new_root = my_inv[file_id]
1115
my_inv.remove_recursive_id(file_id)
1116
new_root.parent_id = None
1117
child_inv.add(new_root)
1118
self._write_inventory(my_inv)
1119
wt._write_inventory(child_inv)
1122
def _serialize(self, inventory, out_file):
1123
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1126
def _deserialize(selt, in_file):
1127
return xml5.serializer_v5.read_inventory(in_file)
1130
"""Write the in memory inventory to disk."""
1131
# TODO: Maybe this should only write on dirty ?
1132
if self._control_files._lock_mode != 'w':
1133
raise errors.NotWriteLocked(self)
1135
self._serialize(self._inventory, sio)
1137
self._transport.put_file('inventory', sio,
1138
mode=self.bzrdir._get_file_mode())
1139
self._inventory_is_modified = False
1141
def _kind(self, relpath):
1142
return osutils.file_kind(self.abspath(relpath))
1144
def list_files(self, include_root=False, from_dir=None, recursive=True):
1145
"""List all files as (path, class, kind, id, entry).
1147
Lists, but does not descend into unversioned directories.
1148
This does not include files that have been deleted in this
1149
tree. Skips the control directory.
1151
:param include_root: if True, return an entry for the root
1152
:param from_dir: start from this directory or None for the root
1153
:param recursive: whether to recurse into subdirectories or not
1155
# list_files is an iterator, so @needs_read_lock doesn't work properly
1156
# with it. So callers should be careful to always read_lock the tree.
1157
if not self.is_locked():
1158
raise errors.ObjectNotLocked(self)
1160
inv = self.inventory
1161
if from_dir is None and include_root is True:
1162
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1163
# Convert these into local objects to save lookup times
1164
pathjoin = osutils.pathjoin
1165
file_kind = self._kind
1167
# transport.base ends in a slash, we want the piece
1168
# between the last two slashes
1169
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1171
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1173
# directory file_id, relative path, absolute path, reverse sorted children
1174
if from_dir is not None:
1175
from_dir_id = inv.path2id(from_dir)
1176
if from_dir_id is None:
1177
# Directory not versioned
1179
from_dir_abspath = pathjoin(self.basedir, from_dir)
1181
from_dir_id = inv.root.file_id
1182
from_dir_abspath = self.basedir
1183
children = os.listdir(from_dir_abspath)
1185
# jam 20060527 The kernel sized tree seems equivalent whether we
1186
# use a deque and popleft to keep them sorted, or if we use a plain
1187
# list and just reverse() them.
1188
children = collections.deque(children)
1189
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1191
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1194
f = children.popleft()
1195
## TODO: If we find a subdirectory with its own .bzr
1196
## directory, then that is a separate tree and we
1197
## should exclude it.
1199
# the bzrdir for this tree
1200
if transport_base_dir == f:
1203
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1204
# and 'f' doesn't begin with one, we can do a string op, rather
1205
# than the checks of pathjoin(), all relative paths will have an extra slash
1207
fp = from_dir_relpath + '/' + f
1210
fap = from_dir_abspath + '/' + f
1212
f_ie = inv.get_child(from_dir_id, f)
1215
elif self.is_ignored(fp[1:]):
1218
# we may not have found this file, because of a unicode issue
1219
f_norm, can_access = osutils.normalized_filename(f)
1220
if f == f_norm or not can_access:
1221
# No change, so treat this file normally
1224
# this file can be accessed by a normalized path
1225
# check again if it is versioned
1226
# these lines are repeated here for performance
1228
fp = from_dir_relpath + '/' + f
1229
fap = from_dir_abspath + '/' + f
1230
f_ie = inv.get_child(from_dir_id, f)
1233
elif self.is_ignored(fp[1:]):
1240
# make a last minute entry
1242
yield fp[1:], c, fk, f_ie.file_id, f_ie
1245
yield fp[1:], c, fk, None, fk_entries[fk]()
1247
yield fp[1:], c, fk, None, TreeEntry()
1250
if fk != 'directory':
1253
# But do this child first if recursing down
1255
new_children = os.listdir(fap)
1257
new_children = collections.deque(new_children)
1258
stack.append((f_ie.file_id, fp, fap, new_children))
1259
# Break out of inner loop,
1260
# so that we start outer loop with child
1263
# if we finished all children, pop it off the stack
1266
@needs_tree_write_lock
1267
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1270
to_dir must exist in the inventory.
1272
If to_dir exists and is a directory, the files are moved into
1273
it, keeping their old names.
1275
Note that to_dir is only the last component of the new name;
1276
this doesn't change the directory.
1278
For each entry in from_paths the move mode will be determined
1281
The first mode moves the file in the filesystem and updates the
1282
inventory. The second mode only updates the inventory without
1283
touching the file on the filesystem. This is the new mode introduced
1286
move uses the second mode if 'after == True' and the target is not
1287
versioned but present in the working tree.
1289
move uses the second mode if 'after == False' and the source is
1290
versioned but no longer in the working tree, and the target is not
1291
versioned but present in the working tree.
1293
move uses the first mode if 'after == False' and the source is
1294
versioned and present in the working tree, and the target is not
1295
versioned and not present in the working tree.
1297
Everything else results in an error.
1299
This returns a list of (from_path, to_path) pairs for each
1300
entry that is moved.
1305
# check for deprecated use of signature
1307
to_dir = kwargs.get('to_name', None)
1309
raise TypeError('You must supply a target directory')
1311
symbol_versioning.warn('The parameter to_name was deprecated'
1312
' in version 0.13. Use to_dir instead',
1315
# check destination directory
1316
if isinstance(from_paths, basestring):
1318
inv = self.inventory
1319
to_abs = self.abspath(to_dir)
1320
if not isdir(to_abs):
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotADirectory(to_abs))
1323
if not self.has_filename(to_dir):
1324
raise errors.BzrMoveFailedError('',to_dir,
1325
errors.NotInWorkingDirectory(to_dir))
1326
to_dir_id = inv.path2id(to_dir)
1327
if to_dir_id is None:
1328
raise errors.BzrMoveFailedError('',to_dir,
1329
errors.NotVersionedError(path=str(to_dir)))
1331
to_dir_ie = inv[to_dir_id]
1332
if to_dir_ie.kind != 'directory':
1333
raise errors.BzrMoveFailedError('',to_dir,
1334
errors.NotADirectory(to_abs))
1336
# create rename entries and tuples
1337
for from_rel in from_paths:
1338
from_tail = splitpath(from_rel)[-1]
1339
from_id = inv.path2id(from_rel)
1341
raise errors.BzrMoveFailedError(from_rel,to_dir,
1342
errors.NotVersionedError(path=str(from_rel)))
1344
from_entry = inv[from_id]
1345
from_parent_id = from_entry.parent_id
1346
to_rel = pathjoin(to_dir, from_tail)
1347
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1349
from_tail=from_tail,
1350
from_parent_id=from_parent_id,
1351
to_rel=to_rel, to_tail=from_tail,
1352
to_parent_id=to_dir_id)
1353
rename_entries.append(rename_entry)
1354
rename_tuples.append((from_rel, to_rel))
1356
# determine which move mode to use. checks also for movability
1357
rename_entries = self._determine_mv_mode(rename_entries, after)
1359
original_modified = self._inventory_is_modified
1362
self._inventory_is_modified = True
1363
self._move(rename_entries)
1365
# restore the inventory on error
1366
self._inventory_is_modified = original_modified
1368
self._write_inventory(inv)
1369
return rename_tuples
1371
def _determine_mv_mode(self, rename_entries, after=False):
1372
"""Determines for each from-to pair if both inventory and working tree
1373
or only the inventory has to be changed.
1375
Also does basic plausability tests.
1377
inv = self.inventory
1379
for rename_entry in rename_entries:
1380
# store to local variables for easier reference
1381
from_rel = rename_entry.from_rel
1382
from_id = rename_entry.from_id
1383
to_rel = rename_entry.to_rel
1384
to_id = inv.path2id(to_rel)
1385
only_change_inv = False
1387
# check the inventory for source and destination
1389
raise errors.BzrMoveFailedError(from_rel,to_rel,
1390
errors.NotVersionedError(path=str(from_rel)))
1391
if to_id is not None:
1392
raise errors.BzrMoveFailedError(from_rel,to_rel,
1393
errors.AlreadyVersionedError(path=str(to_rel)))
1395
# try to determine the mode for rename (only change inv or change
1396
# inv and file system)
1398
if not self.has_filename(to_rel):
1399
raise errors.BzrMoveFailedError(from_id,to_rel,
1400
errors.NoSuchFile(path=str(to_rel),
1401
extra="New file has not been created yet"))
1402
only_change_inv = True
1403
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1404
only_change_inv = True
1405
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1406
only_change_inv = False
1407
elif (not self.case_sensitive
1408
and from_rel.lower() == to_rel.lower()
1409
and self.has_filename(from_rel)):
1410
only_change_inv = False
1412
# something is wrong, so lets determine what exactly
1413
if not self.has_filename(from_rel) and \
1414
not self.has_filename(to_rel):
1415
raise errors.BzrRenameFailedError(from_rel,to_rel,
1416
errors.PathsDoNotExist(paths=(str(from_rel),
1419
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1420
rename_entry.only_change_inv = only_change_inv
1421
return rename_entries
1423
def _move(self, rename_entries):
1424
"""Moves a list of files.
1426
Depending on the value of the flag 'only_change_inv', the
1427
file will be moved on the file system or not.
1429
inv = self.inventory
1432
for entry in rename_entries:
1434
self._move_entry(entry)
1436
self._rollback_move(moved)
1440
def _rollback_move(self, moved):
1441
"""Try to rollback a previous move in case of an filesystem error."""
1442
inv = self.inventory
1445
self._move_entry(WorkingTree._RenameEntry(
1446
entry.to_rel, entry.from_id,
1447
entry.to_tail, entry.to_parent_id, entry.from_rel,
1448
entry.from_tail, entry.from_parent_id,
1449
entry.only_change_inv))
1450
except errors.BzrMoveFailedError, e:
1451
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1452
" The working tree is in an inconsistent state."
1453
" Please consider doing a 'bzr revert'."
1454
" Error message is: %s" % e)
1456
def _move_entry(self, entry):
1457
inv = self.inventory
1458
from_rel_abs = self.abspath(entry.from_rel)
1459
to_rel_abs = self.abspath(entry.to_rel)
1460
if from_rel_abs == to_rel_abs:
1461
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1462
"Source and target are identical.")
1464
if not entry.only_change_inv:
1466
osutils.rename(from_rel_abs, to_rel_abs)
1468
raise errors.BzrMoveFailedError(entry.from_rel,
1470
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1472
@needs_tree_write_lock
1473
def rename_one(self, from_rel, to_rel, after=False):
1476
This can change the directory or the filename or both.
1478
rename_one has several 'modes' to work. First, it can rename a physical
1479
file and change the file_id. That is the normal mode. Second, it can
1480
only change the file_id without touching any physical file. This is
1481
the new mode introduced in version 0.15.
1483
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1484
versioned but present in the working tree.
1486
rename_one uses the second mode if 'after == False' and 'from_rel' is
1487
versioned but no longer in the working tree, and 'to_rel' is not
1488
versioned but present in the working tree.
1490
rename_one uses the first mode if 'after == False' and 'from_rel' is
1491
versioned and present in the working tree, and 'to_rel' is not
1492
versioned and not present in the working tree.
1494
Everything else results in an error.
1496
inv = self.inventory
1499
# create rename entries and tuples
1500
from_tail = splitpath(from_rel)[-1]
1501
from_id = inv.path2id(from_rel)
1503
# if file is missing in the inventory maybe it's in the basis_tree
1504
basis_tree = self.branch.basis_tree()
1505
from_id = basis_tree.path2id(from_rel)
1507
raise errors.BzrRenameFailedError(from_rel,to_rel,
1508
errors.NotVersionedError(path=str(from_rel)))
1509
# put entry back in the inventory so we can rename it
1510
from_entry = basis_tree.inventory[from_id].copy()
1513
from_entry = inv[from_id]
1514
from_parent_id = from_entry.parent_id
1515
to_dir, to_tail = os.path.split(to_rel)
1516
to_dir_id = inv.path2id(to_dir)
1517
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1519
from_tail=from_tail,
1520
from_parent_id=from_parent_id,
1521
to_rel=to_rel, to_tail=to_tail,
1522
to_parent_id=to_dir_id)
1523
rename_entries.append(rename_entry)
1525
# determine which move mode to use. checks also for movability
1526
rename_entries = self._determine_mv_mode(rename_entries, after)
1528
# check if the target changed directory and if the target directory is
1530
if to_dir_id is None:
1531
raise errors.BzrMoveFailedError(from_rel,to_rel,
1532
errors.NotVersionedError(path=str(to_dir)))
1534
# all checks done. now we can continue with our actual work
1535
mutter('rename_one:\n'
1540
' to_dir_id {%s}\n',
1541
from_id, from_rel, to_rel, to_dir, to_dir_id)
1543
self._move(rename_entries)
1544
self._write_inventory(inv)
1546
class _RenameEntry(object):
1547
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1548
to_rel, to_tail, to_parent_id, only_change_inv=False):
1549
self.from_rel = from_rel
1550
self.from_id = from_id
1551
self.from_tail = from_tail
1552
self.from_parent_id = from_parent_id
1553
self.to_rel = to_rel
1554
self.to_tail = to_tail
1555
self.to_parent_id = to_parent_id
1556
self.only_change_inv = only_change_inv
1560
"""Return all unknown files.
1562
These are files in the working directory that are not versioned or
1563
control files or ignored.
1565
# force the extras method to be fully executed before returning, to
1566
# prevent race conditions with the lock
1568
[subp for subp in self.extras() if not self.is_ignored(subp)])
1570
@needs_tree_write_lock
1571
def unversion(self, file_ids):
1572
"""Remove the file ids in file_ids from the current versioned set.
1574
When a file_id is unversioned, all of its children are automatically
1577
:param file_ids: The file ids to stop versioning.
1578
:raises: NoSuchId if any fileid is not currently versioned.
1580
for file_id in file_ids:
1581
if file_id not in self._inventory:
1582
raise errors.NoSuchId(self, file_id)
1583
for file_id in file_ids:
1584
if self._inventory.has_id(file_id):
1585
self._inventory.remove_recursive_id(file_id)
1587
# in the future this should just set a dirty bit to wait for the
1588
# final unlock. However, until all methods of workingtree start
1589
# with the current in -memory inventory rather than triggering
1590
# a read, it is more complex - we need to teach read_inventory
1591
# to know when to read, and when to not read first... and possibly
1592
# to save first when the in memory one may be corrupted.
1593
# so for now, we just only write it if it is indeed dirty.
1595
self._write_inventory(self._inventory)
1597
def _iter_conflicts(self):
1599
for info in self.list_files():
1601
stem = get_conflicted_stem(path)
1604
if stem not in conflicted:
1605
conflicted.add(stem)
1609
def pull(self, source, overwrite=False, stop_revision=None,
1610
change_reporter=None, possible_transports=None, local=False):
1613
old_revision_info = self.branch.last_revision_info()
1614
basis_tree = self.basis_tree()
1615
count = self.branch.pull(source, overwrite, stop_revision,
1616
possible_transports=possible_transports,
1618
new_revision_info = self.branch.last_revision_info()
1619
if new_revision_info != old_revision_info:
1620
repository = self.branch.repository
1621
basis_tree.lock_read()
1623
new_basis_tree = self.branch.basis_tree()
1630
change_reporter=change_reporter)
1631
basis_root_id = basis_tree.get_root_id()
1632
new_root_id = new_basis_tree.get_root_id()
1633
if basis_root_id != new_root_id:
1634
self.set_root_id(new_root_id)
1637
# TODO - dedup parents list with things merged by pull ?
1638
# reuse the revisiontree we merged against to set the new
1640
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1641
# we have to pull the merge trees out again, because
1642
# merge_inner has set the ids. - this corner is not yet
1643
# layered well enough to prevent double handling.
1644
# XXX TODO: Fix the double handling: telling the tree about
1645
# the already known parent data is wasteful.
1646
merges = self.get_parent_ids()[1:]
1647
parent_trees.extend([
1648
(parent, repository.revision_tree(parent)) for
1650
self.set_parent_trees(parent_trees)
1656
def put_file_bytes_non_atomic(self, file_id, bytes):
1657
"""See MutableTree.put_file_bytes_non_atomic."""
1658
stream = file(self.id2abspath(file_id), 'wb')
1663
# TODO: update the hashcache here ?
1666
"""Yield all unversioned files in this WorkingTree.
1668
If there are any unversioned directories then only the directory is
1669
returned, not all its children. But if there are unversioned files
1670
under a versioned subdirectory, they are returned.
1672
Currently returned depth-first, sorted by name within directories.
1673
This is the same order used by 'osutils.walkdirs'.
1675
## TODO: Work from given directory downwards
1676
for path, dir_entry in self.inventory.directories():
1677
# mutter("search for unknowns in %r", path)
1678
dirabs = self.abspath(path)
1679
if not isdir(dirabs):
1680
# e.g. directory deleted
1684
for subf in os.listdir(dirabs):
1685
if self.bzrdir.is_control_filename(subf):
1687
if subf not in dir_entry.children:
1690
can_access) = osutils.normalized_filename(subf)
1691
except UnicodeDecodeError:
1692
path_os_enc = path.encode(osutils._fs_enc)
1693
relpath = path_os_enc + '/' + subf
1694
raise errors.BadFilenameEncoding(relpath,
1696
if subf_norm != subf and can_access:
1697
if subf_norm not in dir_entry.children:
1698
fl.append(subf_norm)
1704
subp = pathjoin(path, subf)
1707
def ignored_files(self):
1708
"""Yield list of PATH, IGNORE_PATTERN"""
1709
for subp in self.extras():
1710
pat = self.is_ignored(subp)
1714
def get_ignore_list(self):
1715
"""Return list of ignore patterns.
1717
Cached in the Tree object after the first call.
1719
ignoreset = getattr(self, '_ignoreset', None)
1720
if ignoreset is not None:
1723
ignore_globs = set()
1724
ignore_globs.update(ignores.get_runtime_ignores())
1725
ignore_globs.update(ignores.get_user_ignores())
1726
if self.has_filename(bzrlib.IGNORE_FILENAME):
1727
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1729
ignore_globs.update(ignores.parse_ignore_file(f))
1732
self._ignoreset = ignore_globs
1735
def _flush_ignore_list_cache(self):
1736
"""Resets the cached ignore list to force a cache rebuild."""
1737
self._ignoreset = None
1738
self._ignoreglobster = None
1740
def is_ignored(self, filename):
1741
r"""Check whether the filename matches an ignore pattern.
1743
Patterns containing '/' or '\' need to match the whole path;
1744
others match against only the last component. Patterns starting
1745
with '!' are ignore exceptions. Exceptions take precedence
1746
over regular patterns and cause the filename to not be ignored.
1748
If the file is ignored, returns the pattern which caused it to
1749
be ignored, otherwise None. So this can simply be used as a
1750
boolean if desired."""
1751
if getattr(self, '_ignoreglobster', None) is None:
1752
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1753
return self._ignoreglobster.match(filename)
1755
def kind(self, file_id):
1756
return file_kind(self.id2abspath(file_id))
1758
def stored_kind(self, file_id):
1759
"""See Tree.stored_kind"""
1760
return self.inventory[file_id].kind
1762
def _comparison_data(self, entry, path):
1763
abspath = self.abspath(path)
1765
stat_value = os.lstat(abspath)
1767
if getattr(e, 'errno', None) == errno.ENOENT:
1774
mode = stat_value.st_mode
1775
kind = osutils.file_kind_from_stat_mode(mode)
1776
if not supports_executable():
1777
executable = entry is not None and entry.executable
1779
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1780
return kind, executable, stat_value
1782
def _file_size(self, entry, stat_value):
1783
return stat_value.st_size
1785
def last_revision(self):
1786
"""Return the last revision of the branch for this tree.
1788
This format tree does not support a separate marker for last-revision
1789
compared to the branch.
1791
See MutableTree.last_revision
1793
return self._last_revision()
1796
def _last_revision(self):
1797
"""helper for get_parent_ids."""
1798
return _mod_revision.ensure_null(self.branch.last_revision())
1800
def is_locked(self):
1801
return self._control_files.is_locked()
1803
def _must_be_locked(self):
1804
if not self.is_locked():
1805
raise errors.ObjectNotLocked(self)
1807
def lock_read(self):
1808
"""Lock the tree for reading.
1810
This also locks the branch, and can be unlocked via self.unlock().
1812
:return: A bzrlib.lock.LogicalLockResult.
1814
if not self.is_locked():
1816
self.branch.lock_read()
1818
self._control_files.lock_read()
1819
return LogicalLockResult(self.unlock)
1821
self.branch.unlock()
1824
def lock_tree_write(self):
1825
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1827
:return: A bzrlib.lock.LogicalLockResult.
1829
if not self.is_locked():
1831
self.branch.lock_read()
1833
self._control_files.lock_write()
1834
return LogicalLockResult(self.unlock)
1836
self.branch.unlock()
1839
def lock_write(self):
1840
"""See MutableTree.lock_write, and WorkingTree.unlock.
1842
:return: A bzrlib.lock.LogicalLockResult.
1844
if not self.is_locked():
1846
self.branch.lock_write()
1848
self._control_files.lock_write()
1849
return LogicalLockResult(self.unlock)
1851
self.branch.unlock()
1854
def get_physical_lock_status(self):
1855
return self._control_files.get_physical_lock_status()
1857
def _basis_inventory_name(self):
1858
return 'basis-inventory-cache'
1860
def _reset_data(self):
1861
"""Reset transient data that cannot be revalidated."""
1862
self._inventory_is_modified = False
1863
f = self._transport.get('inventory')
1865
result = self._deserialize(f)
1868
self._set_inventory(result, dirty=False)
1870
@needs_tree_write_lock
1871
def set_last_revision(self, new_revision):
1872
"""Change the last revision in the working tree."""
1873
if self._change_last_revision(new_revision):
1874
self._cache_basis_inventory(new_revision)
1876
def _change_last_revision(self, new_revision):
1877
"""Template method part of set_last_revision to perform the change.
1879
This is used to allow WorkingTree3 instances to not affect branch
1880
when their last revision is set.
1882
if _mod_revision.is_null(new_revision):
1883
self.branch.set_revision_history([])
1886
self.branch.generate_revision_history(new_revision)
1887
except errors.NoSuchRevision:
1888
# not present in the repo - dont try to set it deeper than the tip
1889
self.branch.set_revision_history([new_revision])
1892
def _write_basis_inventory(self, xml):
1893
"""Write the basis inventory XML to the basis-inventory file"""
1894
path = self._basis_inventory_name()
1896
self._transport.put_file(path, sio,
1897
mode=self.bzrdir._get_file_mode())
1899
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1900
"""Create the text that will be saved in basis-inventory"""
1901
inventory.revision_id = revision_id
1902
return xml7.serializer_v7.write_inventory_to_string(inventory)
1904
def _cache_basis_inventory(self, new_revision):
1905
"""Cache new_revision as the basis inventory."""
1906
# TODO: this should allow the ready-to-use inventory to be passed in,
1907
# as commit already has that ready-to-use [while the format is the
1910
# this double handles the inventory - unpack and repack -
1911
# but is easier to understand. We can/should put a conditional
1912
# in here based on whether the inventory is in the latest format
1913
# - perhaps we should repack all inventories on a repository
1915
# the fast path is to copy the raw xml from the repository. If the
1916
# xml contains 'revision_id="', then we assume the right
1917
# revision_id is set. We must check for this full string, because a
1918
# root node id can legitimately look like 'revision_id' but cannot
1920
xml = self.branch.repository._get_inventory_xml(new_revision)
1921
firstline = xml.split('\n', 1)[0]
1922
if (not 'revision_id="' in firstline or
1923
'format="7"' not in firstline):
1924
inv = self.branch.repository._serializer.read_inventory_from_string(
1926
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1927
self._write_basis_inventory(xml)
1928
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1931
def read_basis_inventory(self):
1932
"""Read the cached basis inventory."""
1933
path = self._basis_inventory_name()
1934
return self._transport.get_bytes(path)
1937
def read_working_inventory(self):
1938
"""Read the working inventory.
1940
:raises errors.InventoryModified: read_working_inventory will fail
1941
when the current in memory inventory has been modified.
1943
# conceptually this should be an implementation detail of the tree.
1944
# XXX: Deprecate this.
1945
# ElementTree does its own conversion from UTF-8, so open in
1947
if self._inventory_is_modified:
1948
raise errors.InventoryModified(self)
1949
f = self._transport.get('inventory')
1951
result = self._deserialize(f)
1954
self._set_inventory(result, dirty=False)
1957
@needs_tree_write_lock
1958
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1960
"""Remove nominated files from the working inventory.
1962
:files: File paths relative to the basedir.
1963
:keep_files: If true, the files will also be kept.
1964
:force: Delete files and directories, even if they are changed and
1965
even if the directories are not empty.
1967
if isinstance(files, basestring):
1973
unknown_nested_files=set()
1975
to_file = sys.stdout
1977
def recurse_directory_to_add_files(directory):
1978
# Recurse directory and add all files
1979
# so we can check if they have changed.
1980
for parent_info, file_infos in self.walkdirs(directory):
1981
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1982
# Is it versioned or ignored?
1983
if self.path2id(relpath) or self.is_ignored(relpath):
1984
# Add nested content for deletion.
1985
new_files.add(relpath)
1987
# Files which are not versioned and not ignored
1988
# should be treated as unknown.
1989
unknown_nested_files.add((relpath, None, kind))
1991
for filename in files:
1992
# Get file name into canonical form.
1993
abspath = self.abspath(filename)
1994
filename = self.relpath(abspath)
1995
if len(filename) > 0:
1996
new_files.add(filename)
1997
recurse_directory_to_add_files(filename)
1999
files = list(new_files)
2002
return # nothing to do
2004
# Sort needed to first handle directory content before the directory
2005
files.sort(reverse=True)
2007
# Bail out if we are going to delete files we shouldn't
2008
if not keep_files and not force:
2009
has_changed_files = len(unknown_nested_files) > 0
2010
if not has_changed_files:
2011
for (file_id, path, content_change, versioned, parent_id, name,
2012
kind, executable) in self.iter_changes(self.basis_tree(),
2013
include_unchanged=True, require_versioned=False,
2014
want_unversioned=True, specific_files=files):
2015
if versioned == (False, False):
2016
# The record is unknown ...
2017
if not self.is_ignored(path[1]):
2018
# ... but not ignored
2019
has_changed_files = True
2021
elif (content_change and (kind[1] is not None) and
2022
osutils.is_inside_any(files, path[1])):
2023
# Versioned and changed, but not deleted, and still
2024
# in one of the dirs to be deleted.
2025
has_changed_files = True
2028
if has_changed_files:
2029
# Make delta show ALL applicable changes in error message.
2030
tree_delta = self.changes_from(self.basis_tree(),
2031
require_versioned=False, want_unversioned=True,
2032
specific_files=files)
2033
for unknown_file in unknown_nested_files:
2034
if unknown_file not in tree_delta.unversioned:
2035
tree_delta.unversioned.extend((unknown_file,))
2036
raise errors.BzrRemoveChangedFilesError(tree_delta)
2038
# Build inv_delta and delete files where applicable,
2039
# do this before any modifications to inventory.
2041
fid = self.path2id(f)
2044
message = "%s is not versioned." % (f,)
2047
# having removed it, it must be either ignored or unknown
2048
if self.is_ignored(f):
2052
# XXX: Really should be a more abstract reporter interface
2053
kind_ch = osutils.kind_marker(self.kind(fid))
2054
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2056
inv_delta.append((f, None, fid, None))
2057
message = "removed %s" % (f,)
2060
abs_path = self.abspath(f)
2061
if osutils.lexists(abs_path):
2062
if (osutils.isdir(abs_path) and
2063
len(os.listdir(abs_path)) > 0):
2065
osutils.rmtree(abs_path)
2067
message = "%s is not an empty directory "\
2068
"and won't be deleted." % (f,)
2070
osutils.delete_any(abs_path)
2071
message = "deleted %s" % (f,)
2072
elif message is not None:
2073
# Only care if we haven't done anything yet.
2074
message = "%s does not exist." % (f,)
2076
# Print only one message (if any) per file.
2077
if message is not None:
2079
self.apply_inventory_delta(inv_delta)
2081
@needs_tree_write_lock
2082
def revert(self, filenames=None, old_tree=None, backups=True,
2083
pb=None, report_changes=False):
2084
from bzrlib.conflicts import resolve
2087
symbol_versioning.warn('Using [] to revert all files is deprecated'
2088
' as of bzr 0.91. Please use None (the default) instead.',
2089
DeprecationWarning, stacklevel=2)
2090
if old_tree is None:
2091
basis_tree = self.basis_tree()
2092
basis_tree.lock_read()
2093
old_tree = basis_tree
2097
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2099
if filenames is None and len(self.get_parent_ids()) > 1:
2101
last_revision = self.last_revision()
2102
if last_revision != _mod_revision.NULL_REVISION:
2103
if basis_tree is None:
2104
basis_tree = self.basis_tree()
2105
basis_tree.lock_read()
2106
parent_trees.append((last_revision, basis_tree))
2107
self.set_parent_trees(parent_trees)
2110
resolve(self, filenames, ignore_misses=True, recursive=True)
2112
if basis_tree is not None:
2116
def revision_tree(self, revision_id):
2117
"""See Tree.revision_tree.
2119
WorkingTree can supply revision_trees for the basis revision only
2120
because there is only one cached inventory in the bzr directory.
2122
if revision_id == self.last_revision():
2124
xml = self.read_basis_inventory()
2125
except errors.NoSuchFile:
2129
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2130
# dont use the repository revision_tree api because we want
2131
# to supply the inventory.
2132
if inv.revision_id == revision_id:
2133
return revisiontree.RevisionTree(self.branch.repository,
2135
except errors.BadInventoryFormat:
2137
# raise if there was no inventory, or if we read the wrong inventory.
2138
raise errors.NoSuchRevisionInTree(self, revision_id)
2140
# XXX: This method should be deprecated in favour of taking in a proper
2141
# new Inventory object.
2142
@needs_tree_write_lock
2143
def set_inventory(self, new_inventory_list):
2144
from bzrlib.inventory import (Inventory,
2148
inv = Inventory(self.get_root_id())
2149
for path, file_id, parent, kind in new_inventory_list:
2150
name = os.path.basename(path)
2153
# fixme, there should be a factory function inv,add_??
2154
if kind == 'directory':
2155
inv.add(InventoryDirectory(file_id, name, parent))
2156
elif kind == 'file':
2157
inv.add(InventoryFile(file_id, name, parent))
2158
elif kind == 'symlink':
2159
inv.add(InventoryLink(file_id, name, parent))
2161
raise errors.BzrError("unknown kind %r" % kind)
2162
self._write_inventory(inv)
2164
@needs_tree_write_lock
2165
def set_root_id(self, file_id):
2166
"""Set the root id for this tree."""
2170
'WorkingTree.set_root_id with fileid=None')
2171
file_id = osutils.safe_file_id(file_id)
2172
self._set_root_id(file_id)
2174
def _set_root_id(self, file_id):
2175
"""Set the root id for this tree, in a format specific manner.
2177
:param file_id: The file id to assign to the root. It must not be
2178
present in the current inventory or an error will occur. It must
2179
not be None, but rather a valid file id.
2181
inv = self._inventory
2182
orig_root_id = inv.root.file_id
2183
# TODO: it might be nice to exit early if there was nothing
2184
# to do, saving us from trigger a sync on unlock.
2185
self._inventory_is_modified = True
2186
# we preserve the root inventory entry object, but
2187
# unlinkit from the byid index
2188
del inv._byid[inv.root.file_id]
2189
inv.root.file_id = file_id
2190
# and link it into the index with the new changed id.
2191
inv._byid[inv.root.file_id] = inv.root
2192
# and finally update all children to reference the new id.
2193
# XXX: this should be safe to just look at the root.children
2194
# list, not the WHOLE INVENTORY.
2197
if entry.parent_id == orig_root_id:
2198
entry.parent_id = inv.root.file_id
2201
"""See Branch.unlock.
2203
WorkingTree locking just uses the Branch locking facilities.
2204
This is current because all working trees have an embedded branch
2205
within them. IF in the future, we were to make branch data shareable
2206
between multiple working trees, i.e. via shared storage, then we
2207
would probably want to lock both the local tree, and the branch.
2209
raise NotImplementedError(self.unlock)
2213
def update(self, change_reporter=None, possible_transports=None,
2214
revision=None, old_tip=_marker):
2215
"""Update a working tree along its branch.
2217
This will update the branch if its bound too, which means we have
2218
multiple trees involved:
2220
- The new basis tree of the master.
2221
- The old basis tree of the branch.
2222
- The old basis tree of the working tree.
2223
- The current working tree state.
2225
Pathologically, all three may be different, and non-ancestors of each
2226
other. Conceptually we want to:
2228
- Preserve the wt.basis->wt.state changes
2229
- Transform the wt.basis to the new master basis.
2230
- Apply a merge of the old branch basis to get any 'local' changes from
2232
- Restore the wt.basis->wt.state changes.
2234
There isn't a single operation at the moment to do that, so we:
2235
- Merge current state -> basis tree of the master w.r.t. the old tree
2237
- Do a 'normal' merge of the old branch basis if it is relevant.
2239
:param revision: The target revision to update to. Must be in the
2241
:param old_tip: If branch.update() has already been run, the value it
2242
returned (old tip of the branch or None). _marker is used
2245
if self.branch.get_bound_location() is not None:
2247
update_branch = (old_tip is self._marker)
2249
self.lock_tree_write()
2250
update_branch = False
2253
old_tip = self.branch.update(possible_transports)
2255
if old_tip is self._marker:
2257
return self._update_tree(old_tip, change_reporter, revision)
2261
@needs_tree_write_lock
2262
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2263
"""Update a tree to the master branch.
2265
:param old_tip: if supplied, the previous tip revision the branch,
2266
before it was changed to the master branch's tip.
2268
# here if old_tip is not None, it is the old tip of the branch before
2269
# it was updated from the master branch. This should become a pending
2270
# merge in the working tree to preserve the user existing work. we
2271
# cant set that until we update the working trees last revision to be
2272
# one from the new branch, because it will just get absorbed by the
2273
# parent de-duplication logic.
2275
# We MUST save it even if an error occurs, because otherwise the users
2276
# local work is unreferenced and will appear to have been lost.
2280
last_rev = self.get_parent_ids()[0]
2282
last_rev = _mod_revision.NULL_REVISION
2283
if revision is None:
2284
revision = self.branch.last_revision()
2286
old_tip = old_tip or _mod_revision.NULL_REVISION
2288
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2289
# the branch we are bound to was updated
2290
# merge those changes in first
2291
base_tree = self.basis_tree()
2292
other_tree = self.branch.repository.revision_tree(old_tip)
2293
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2294
base_tree, this_tree=self,
2295
change_reporter=change_reporter)
2297
self.add_parent_tree((old_tip, other_tree))
2298
trace.note('Rerun update after fixing the conflicts.')
2301
if last_rev != _mod_revision.ensure_null(revision):
2302
# the working tree is up to date with the branch
2303
# we can merge the specified revision from master
2304
to_tree = self.branch.repository.revision_tree(revision)
2305
to_root_id = to_tree.get_root_id()
2307
basis = self.basis_tree()
2310
if (basis.inventory.root is None
2311
or basis.inventory.root.file_id != to_root_id):
2312
self.set_root_id(to_root_id)
2317
# determine the branch point
2318
graph = self.branch.repository.get_graph()
2319
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2321
base_tree = self.branch.repository.revision_tree(base_rev_id)
2323
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2325
change_reporter=change_reporter)
2326
self.set_last_revision(revision)
2327
# TODO - dedup parents list with things merged by pull ?
2328
# reuse the tree we've updated to to set the basis:
2329
parent_trees = [(revision, to_tree)]
2330
merges = self.get_parent_ids()[1:]
2331
# Ideally we ask the tree for the trees here, that way the working
2332
# tree can decide whether to give us the entire tree or give us a
2333
# lazy initialised tree. dirstate for instance will have the trees
2334
# in ram already, whereas a last-revision + basis-inventory tree
2335
# will not, but also does not need them when setting parents.
2336
for parent in merges:
2337
parent_trees.append(
2338
(parent, self.branch.repository.revision_tree(parent)))
2339
if not _mod_revision.is_null(old_tip):
2340
parent_trees.append(
2341
(old_tip, self.branch.repository.revision_tree(old_tip)))
2342
self.set_parent_trees(parent_trees)
2343
last_rev = parent_trees[0][0]
2346
def _write_hashcache_if_dirty(self):
2347
"""Write out the hashcache if it is dirty."""
2348
if self._hashcache.needs_write:
2350
self._hashcache.write()
2352
if e.errno not in (errno.EPERM, errno.EACCES):
2354
# TODO: jam 20061219 Should this be a warning? A single line
2355
# warning might be sufficient to let the user know what
2357
mutter('Could not write hashcache for %s\nError: %s',
2358
self._hashcache.cache_file_name(), e)
2360
@needs_tree_write_lock
2361
def _write_inventory(self, inv):
2362
"""Write inventory as the current inventory."""
2363
self._set_inventory(inv, dirty=True)
2366
def set_conflicts(self, arg):
2367
raise errors.UnsupportedOperation(self.set_conflicts, self)
2369
def add_conflicts(self, arg):
2370
raise errors.UnsupportedOperation(self.add_conflicts, self)
2373
def conflicts(self):
2374
conflicts = _mod_conflicts.ConflictList()
2375
for conflicted in self._iter_conflicts():
2378
if file_kind(self.abspath(conflicted)) != "file":
2380
except errors.NoSuchFile:
2383
for suffix in ('.THIS', '.OTHER'):
2385
kind = file_kind(self.abspath(conflicted+suffix))
2388
except errors.NoSuchFile:
2392
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2393
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2395
file_id=self.path2id(conflicted)))
2398
def walkdirs(self, prefix=""):
2399
"""Walk the directories of this tree.
2401
returns a generator which yields items in the form:
2402
((curren_directory_path, fileid),
2403
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2406
This API returns a generator, which is only valid during the current
2407
tree transaction - within a single lock_read or lock_write duration.
2409
If the tree is not locked, it may cause an error to be raised,
2410
depending on the tree implementation.
2412
disk_top = self.abspath(prefix)
2413
if disk_top.endswith('/'):
2414
disk_top = disk_top[:-1]
2415
top_strip_len = len(disk_top) + 1
2416
inventory_iterator = self._walkdirs(prefix)
2417
disk_iterator = osutils.walkdirs(disk_top, prefix)
2419
current_disk = disk_iterator.next()
2420
disk_finished = False
2422
if not (e.errno == errno.ENOENT or
2423
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2426
disk_finished = True
2428
current_inv = inventory_iterator.next()
2429
inv_finished = False
2430
except StopIteration:
2433
while not inv_finished or not disk_finished:
2435
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2436
cur_disk_dir_content) = current_disk
2438
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2439
cur_disk_dir_content) = ((None, None), None)
2440
if not disk_finished:
2441
# strip out .bzr dirs
2442
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2443
len(cur_disk_dir_content) > 0):
2444
# osutils.walkdirs can be made nicer -
2445
# yield the path-from-prefix rather than the pathjoined
2447
bzrdir_loc = bisect_left(cur_disk_dir_content,
2449
if (bzrdir_loc < len(cur_disk_dir_content)
2450
and self.bzrdir.is_control_filename(
2451
cur_disk_dir_content[bzrdir_loc][0])):
2452
# we dont yield the contents of, or, .bzr itself.
2453
del cur_disk_dir_content[bzrdir_loc]
2455
# everything is unknown
2458
# everything is missing
2461
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2463
# disk is before inventory - unknown
2464
dirblock = [(relpath, basename, kind, stat, None, None) for
2465
relpath, basename, kind, stat, top_path in
2466
cur_disk_dir_content]
2467
yield (cur_disk_dir_relpath, None), dirblock
2469
current_disk = disk_iterator.next()
2470
except StopIteration:
2471
disk_finished = True
2473
# inventory is before disk - missing.
2474
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2475
for relpath, basename, dkind, stat, fileid, kind in
2477
yield (current_inv[0][0], current_inv[0][1]), dirblock
2479
current_inv = inventory_iterator.next()
2480
except StopIteration:
2483
# versioned present directory
2484
# merge the inventory and disk data together
2486
for relpath, subiterator in itertools.groupby(sorted(
2487
current_inv[1] + cur_disk_dir_content,
2488
key=operator.itemgetter(0)), operator.itemgetter(1)):
2489
path_elements = list(subiterator)
2490
if len(path_elements) == 2:
2491
inv_row, disk_row = path_elements
2492
# versioned, present file
2493
dirblock.append((inv_row[0],
2494
inv_row[1], disk_row[2],
2495
disk_row[3], inv_row[4],
2497
elif len(path_elements[0]) == 5:
2499
dirblock.append((path_elements[0][0],
2500
path_elements[0][1], path_elements[0][2],
2501
path_elements[0][3], None, None))
2502
elif len(path_elements[0]) == 6:
2503
# versioned, absent file.
2504
dirblock.append((path_elements[0][0],
2505
path_elements[0][1], 'unknown', None,
2506
path_elements[0][4], path_elements[0][5]))
2508
raise NotImplementedError('unreachable code')
2509
yield current_inv[0], dirblock
2511
current_inv = inventory_iterator.next()
2512
except StopIteration:
2515
current_disk = disk_iterator.next()
2516
except StopIteration:
2517
disk_finished = True
2519
def _walkdirs(self, prefix=""):
2520
"""Walk the directories of this tree.
2522
:prefix: is used as the directrory to start with.
2523
returns a generator which yields items in the form:
2524
((curren_directory_path, fileid),
2525
[(file1_path, file1_name, file1_kind, None, file1_id,
2528
_directory = 'directory'
2529
# get the root in the inventory
2530
inv = self.inventory
2531
top_id = inv.path2id(prefix)
2535
pending = [(prefix, '', _directory, None, top_id, None)]
2538
currentdir = pending.pop()
2539
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2540
top_id = currentdir[4]
2542
relroot = currentdir[0] + '/'
2545
# FIXME: stash the node in pending
2547
if entry.kind == 'directory':
2548
for name, child in entry.sorted_children():
2549
dirblock.append((relroot + name, name, child.kind, None,
2550
child.file_id, child.kind
2552
yield (currentdir[0], entry.file_id), dirblock
2553
# push the user specified dirs from dirblock
2554
for dir in reversed(dirblock):
2555
if dir[2] == _directory:
2558
@needs_tree_write_lock
2559
def auto_resolve(self):
2560
"""Automatically resolve text conflicts according to contents.
2562
Only text conflicts are auto_resolvable. Files with no conflict markers
2563
are considered 'resolved', because bzr always puts conflict markers
2564
into files that have text conflicts. The corresponding .THIS .BASE and
2565
.OTHER files are deleted, as per 'resolve'.
2566
:return: a tuple of ConflictLists: (un_resolved, resolved).
2568
un_resolved = _mod_conflicts.ConflictList()
2569
resolved = _mod_conflicts.ConflictList()
2570
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2571
for conflict in self.conflicts():
2572
if (conflict.typestring != 'text conflict' or
2573
self.kind(conflict.file_id) != 'file'):
2574
un_resolved.append(conflict)
2576
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2578
for line in my_file:
2579
if conflict_re.search(line):
2580
un_resolved.append(conflict)
2583
resolved.append(conflict)
2586
resolved.remove_files(self)
2587
self.set_conflicts(un_resolved)
2588
return un_resolved, resolved
2591
def _check(self, references):
2592
"""Check the tree for consistency.
2594
:param references: A dict with keys matching the items returned by
2595
self._get_check_refs(), and values from looking those keys up in
2598
tree_basis = self.basis_tree()
2599
tree_basis.lock_read()
2601
repo_basis = references[('trees', self.last_revision())]
2602
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2603
raise errors.BzrCheckError(
2604
"Mismatched basis inventory content.")
2609
def _validate(self):
2610
"""Validate internal structures.
2612
This is meant mostly for the test suite. To give it a chance to detect
2613
corruption after actions have occurred. The default implementation is a
2616
:return: None. An exception should be raised if there is an error.
2620
def _get_rules_searcher(self, default_searcher):
2621
"""See Tree._get_rules_searcher."""
2622
if self._rules_searcher is None:
2623
self._rules_searcher = super(WorkingTree,
2624
self)._get_rules_searcher(default_searcher)
2625
return self._rules_searcher
2627
def get_shelf_manager(self):
2628
"""Return the ShelfManager for this WorkingTree."""
2629
from bzrlib.shelf import ShelfManager
2630
return ShelfManager(self, self._transport)
2633
class WorkingTree2(WorkingTree):
2634
"""This is the Format 2 working tree.
2636
This was the first weave based working tree.
2637
- uses os locks for locking.
2638
- uses the branch last-revision.
2641
def __init__(self, *args, **kwargs):
2642
super(WorkingTree2, self).__init__(*args, **kwargs)
2643
# WorkingTree2 has more of a constraint that self._inventory must
2644
# exist. Because this is an older format, we don't mind the overhead
2645
# caused by the extra computation here.
2647
# Newer WorkingTree's should only have self._inventory set when they
2649
if self._inventory is None:
2650
self.read_working_inventory()
2652
def _get_check_refs(self):
2653
"""Return the references needed to perform a check of this tree."""
2654
return [('trees', self.last_revision())]
2656
def lock_tree_write(self):
2657
"""See WorkingTree.lock_tree_write().
2659
In Format2 WorkingTrees we have a single lock for the branch and tree
2660
so lock_tree_write() degrades to lock_write().
2662
:return: An object with an unlock method which will release the lock
2665
self.branch.lock_write()
2667
self._control_files.lock_write()
2670
self.branch.unlock()
2674
# do non-implementation specific cleanup
2677
# we share control files:
2678
if self._control_files._lock_count == 3:
2679
# _inventory_is_modified is always False during a read lock.
2680
if self._inventory_is_modified:
2682
self._write_hashcache_if_dirty()
2684
# reverse order of locking.
2686
return self._control_files.unlock()
2688
self.branch.unlock()
2691
class WorkingTree3(WorkingTree):
2692
"""This is the Format 3 working tree.
2694
This differs from the base WorkingTree by:
2695
- having its own file lock
2696
- having its own last-revision property.
2698
This is new in bzr 0.8
2702
def _last_revision(self):
2703
"""See Mutable.last_revision."""
2705
return self._transport.get_bytes('last-revision')
2706
except errors.NoSuchFile:
2707
return _mod_revision.NULL_REVISION
2709
def _change_last_revision(self, revision_id):
2710
"""See WorkingTree._change_last_revision."""
2711
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2713
self._transport.delete('last-revision')
2714
except errors.NoSuchFile:
2718
self._transport.put_bytes('last-revision', revision_id,
2719
mode=self.bzrdir._get_file_mode())
2722
def _get_check_refs(self):
2723
"""Return the references needed to perform a check of this tree."""
2724
return [('trees', self.last_revision())]
2726
@needs_tree_write_lock
2727
def set_conflicts(self, conflicts):
2728
self._put_rio('conflicts', conflicts.to_stanzas(),
2731
@needs_tree_write_lock
2732
def add_conflicts(self, new_conflicts):
2733
conflict_set = set(self.conflicts())
2734
conflict_set.update(set(list(new_conflicts)))
2735
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2736
key=_mod_conflicts.Conflict.sort_key)))
2739
def conflicts(self):
2741
confile = self._transport.get('conflicts')
2742
except errors.NoSuchFile:
2743
return _mod_conflicts.ConflictList()
2746
if confile.next() != CONFLICT_HEADER_1 + '\n':
2747
raise errors.ConflictFormatError()
2748
except StopIteration:
2749
raise errors.ConflictFormatError()
2750
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2755
# do non-implementation specific cleanup
2757
if self._control_files._lock_count == 1:
2758
# _inventory_is_modified is always False during a read lock.
2759
if self._inventory_is_modified:
2761
self._write_hashcache_if_dirty()
2762
# reverse order of locking.
2764
return self._control_files.unlock()
2766
self.branch.unlock()
2769
def get_conflicted_stem(path):
2770
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2771
if path.endswith(suffix):
2772
return path[:-len(suffix)]
2775
class WorkingTreeFormat(object):
2776
"""An encapsulation of the initialization and open routines for a format.
2778
Formats provide three things:
2779
* An initialization routine,
2783
Formats are placed in an dict by their format string for reference
2784
during workingtree opening. Its not required that these be instances, they
2785
can be classes themselves with class methods - it simply depends on
2786
whether state is needed for a given format or not.
2788
Once a format is deprecated, just deprecate the initialize and open
2789
methods on the format class. Do not deprecate the object, as the
2790
object will be created every time regardless.
2793
_default_format = None
2794
"""The default format used for new trees."""
2797
"""The known formats."""
2799
requires_rich_root = False
2801
upgrade_recommended = False
2804
def find_format(klass, a_bzrdir):
2805
"""Return the format for the working tree object in a_bzrdir."""
2807
transport = a_bzrdir.get_workingtree_transport(None)
2808
format_string = transport.get_bytes("format")
2809
return klass._formats[format_string]
2810
except errors.NoSuchFile:
2811
raise errors.NoWorkingTree(base=transport.base)
2813
raise errors.UnknownFormatError(format=format_string,
2814
kind="working tree")
2816
def __eq__(self, other):
2817
return self.__class__ is other.__class__
2819
def __ne__(self, other):
2820
return not (self == other)
2823
def get_default_format(klass):
2824
"""Return the current default format."""
2825
return klass._default_format
2827
def get_format_string(self):
2828
"""Return the ASCII format string that identifies this format."""
2829
raise NotImplementedError(self.get_format_string)
2831
def get_format_description(self):
2832
"""Return the short description for this format."""
2833
raise NotImplementedError(self.get_format_description)
2835
def is_supported(self):
2836
"""Is this format supported?
2838
Supported formats can be initialized and opened.
2839
Unsupported formats may not support initialization or committing or
2840
some other features depending on the reason for not being supported.
2844
def supports_content_filtering(self):
2845
"""True if this format supports content filtering."""
2848
def supports_views(self):
2849
"""True if this format supports stored views."""
2853
def register_format(klass, format):
2854
klass._formats[format.get_format_string()] = format
2857
def set_default_format(klass, format):
2858
klass._default_format = format
2861
def unregister_format(klass, format):
2862
del klass._formats[format.get_format_string()]
2865
class WorkingTreeFormat2(WorkingTreeFormat):
2866
"""The second working tree format.
2868
This format modified the hash cache from the format 1 hash cache.
2871
upgrade_recommended = True
2873
def get_format_description(self):
2874
"""See WorkingTreeFormat.get_format_description()."""
2875
return "Working tree format 2"
2877
def _stub_initialize_on_transport(self, transport, file_mode):
2878
"""Workaround: create control files for a remote working tree.
2880
This ensures that it can later be updated and dealt with locally,
2881
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2882
no working tree. (See bug #43064).
2885
inv = inventory.Inventory()
2886
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2888
transport.put_file('inventory', sio, file_mode)
2889
transport.put_bytes('pending-merges', '', file_mode)
2891
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2892
accelerator_tree=None, hardlink=False):
2893
"""See WorkingTreeFormat.initialize()."""
2894
if not isinstance(a_bzrdir.transport, LocalTransport):
2895
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2896
if from_branch is not None:
2897
branch = from_branch
2899
branch = a_bzrdir.open_branch()
2900
if revision_id is None:
2901
revision_id = _mod_revision.ensure_null(branch.last_revision())
2904
branch.generate_revision_history(revision_id)
2907
inv = inventory.Inventory()
2908
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2914
basis_tree = branch.repository.revision_tree(revision_id)
2915
if basis_tree.inventory.root is not None:
2916
wt.set_root_id(basis_tree.get_root_id())
2917
# set the parent list and cache the basis tree.
2918
if _mod_revision.is_null(revision_id):
2921
parent_trees = [(revision_id, basis_tree)]
2922
wt.set_parent_trees(parent_trees)
2923
transform.build_tree(basis_tree, wt)
2927
super(WorkingTreeFormat2, self).__init__()
2928
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2930
def open(self, a_bzrdir, _found=False):
2931
"""Return the WorkingTree object for a_bzrdir
2933
_found is a private parameter, do not use it. It is used to indicate
2934
if format probing has already been done.
2937
# we are being called directly and must probe.
2938
raise NotImplementedError
2939
if not isinstance(a_bzrdir.transport, LocalTransport):
2940
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2941
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2947
class WorkingTreeFormat3(WorkingTreeFormat):
2948
"""The second working tree format updated to record a format marker.
2951
- exists within a metadir controlling .bzr
2952
- includes an explicit version marker for the workingtree control
2953
files, separate from the BzrDir format
2954
- modifies the hash cache format
2956
- uses a LockDir to guard access for writes.
2959
upgrade_recommended = True
2961
def get_format_string(self):
2962
"""See WorkingTreeFormat.get_format_string()."""
2963
return "Bazaar-NG Working Tree format 3"
2965
def get_format_description(self):
2966
"""See WorkingTreeFormat.get_format_description()."""
2967
return "Working tree format 3"
2969
_lock_file_name = 'lock'
2970
_lock_class = LockDir
2972
_tree_class = WorkingTree3
2974
def __get_matchingbzrdir(self):
2975
return bzrdir.BzrDirMetaFormat1()
2977
_matchingbzrdir = property(__get_matchingbzrdir)
2979
def _open_control_files(self, a_bzrdir):
2980
transport = a_bzrdir.get_workingtree_transport(None)
2981
return LockableFiles(transport, self._lock_file_name,
2984
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2985
accelerator_tree=None, hardlink=False):
2986
"""See WorkingTreeFormat.initialize().
2988
:param revision_id: if supplied, create a working tree at a different
2989
revision than the branch is at.
2990
:param accelerator_tree: A tree which can be used for retrieving file
2991
contents more quickly than the revision tree, i.e. a workingtree.
2992
The revision tree will be used for cases where accelerator_tree's
2993
content is different.
2994
:param hardlink: If true, hard-link files from accelerator_tree,
2997
if not isinstance(a_bzrdir.transport, LocalTransport):
2998
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2999
transport = a_bzrdir.get_workingtree_transport(self)
3000
control_files = self._open_control_files(a_bzrdir)
3001
control_files.create_lock()
3002
control_files.lock_write()
3003
transport.put_bytes('format', self.get_format_string(),
3004
mode=a_bzrdir._get_file_mode())
3005
if from_branch is not None:
3006
branch = from_branch
3008
branch = a_bzrdir.open_branch()
3009
if revision_id is None:
3010
revision_id = _mod_revision.ensure_null(branch.last_revision())
3011
# WorkingTree3 can handle an inventory which has a unique root id.
3012
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3013
# those trees. And because there isn't a format bump inbetween, we
3014
# are maintaining compatibility with older clients.
3015
# inv = Inventory(root_id=gen_root_id())
3016
inv = self._initial_inventory()
3017
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3023
_control_files=control_files)
3024
wt.lock_tree_write()
3026
basis_tree = branch.repository.revision_tree(revision_id)
3027
# only set an explicit root id if there is one to set.
3028
if basis_tree.inventory.root is not None:
3029
wt.set_root_id(basis_tree.get_root_id())
3030
if revision_id == _mod_revision.NULL_REVISION:
3031
wt.set_parent_trees([])
3033
wt.set_parent_trees([(revision_id, basis_tree)])
3034
transform.build_tree(basis_tree, wt)
3036
# Unlock in this order so that the unlock-triggers-flush in
3037
# WorkingTree is given a chance to fire.
3038
control_files.unlock()
3042
def _initial_inventory(self):
3043
return inventory.Inventory()
3046
super(WorkingTreeFormat3, self).__init__()
3048
def open(self, a_bzrdir, _found=False):
3049
"""Return the WorkingTree object for a_bzrdir
3051
_found is a private parameter, do not use it. It is used to indicate
3052
if format probing has already been done.
3055
# we are being called directly and must probe.
3056
raise NotImplementedError
3057
if not isinstance(a_bzrdir.transport, LocalTransport):
3058
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3059
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3062
def _open(self, a_bzrdir, control_files):
3063
"""Open the tree itself.
3065
:param a_bzrdir: the dir for the tree.
3066
:param control_files: the control files for the tree.
3068
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3072
_control_files=control_files)
3075
return self.get_format_string()
3078
__default_format = WorkingTreeFormat6()
3079
WorkingTreeFormat.register_format(__default_format)
3080
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3081
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3082
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3083
WorkingTreeFormat.set_default_format(__default_format)
3084
# formats which have no format string are not discoverable
3085
# and not independently creatable, so are not registered.
3086
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
