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.
181
# override this to set the strategy for storing views
182
def _make_views(self):
183
return views.DisabledViews(self)
185
def __init__(self, basedir='.',
186
branch=DEPRECATED_PARAMETER,
192
"""Construct a WorkingTree instance. This is not a public API.
194
:param branch: A branch to override probing for the branch.
196
self._format = _format
197
self.bzrdir = _bzrdir
199
raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
"WorkingTree.open() to obtain a WorkingTree.")
201
basedir = safe_unicode(basedir)
202
mutter("opening working tree %r", basedir)
203
if deprecated_passed(branch):
204
self._branch = branch
206
self._branch = self.bzrdir.open_branch()
207
self.basedir = realpath(basedir)
208
# if branch is at our basedir and is a format 6 or less
209
if isinstance(self._format, WorkingTreeFormat2):
210
# share control object
211
self._control_files = self.branch.control_files
213
# assume all other formats have their own control files.
214
self._control_files = _control_files
215
self._transport = self._control_files._transport
216
# update the whole cache up front and write to disk if anything changed;
217
# in the future we might want to do this more selectively
218
# two possible ways offer themselves : in self._unlock, write the cache
219
# if needed, or, when the cache sees a change, append it to the hash
220
# cache file, and have the parser take the most recent entry for a
222
wt_trans = self.bzrdir.get_workingtree_transport(None)
223
cache_filename = wt_trans.local_abspath('stat-cache')
224
self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
self.bzrdir._get_file_mode(),
226
self._content_filter_stack_provider())
229
# is this scan needed ? it makes things kinda slow.
236
if _inventory is None:
237
# This will be acquired on lock_read() or lock_write()
238
self._inventory_is_modified = False
239
self._inventory = None
241
# the caller of __init__ has provided an inventory,
242
# we assume they know what they are doing - as its only
243
# the Format factory and creation methods that are
244
# permitted to do this.
245
self._set_inventory(_inventory, dirty=False)
246
self._detect_case_handling()
247
self._rules_searcher = None
248
self.views = self._make_views()
251
def user_transport(self):
252
return self.bzrdir.user_transport
255
def control_transport(self):
256
return self._transport
258
def _detect_case_handling(self):
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
261
wt_trans.stat("FoRMaT")
262
except errors.NoSuchFile:
263
self.case_sensitive = True
265
self.case_sensitive = False
267
self._setup_directory_is_tree_reference()
270
fget=lambda self: self._branch,
271
doc="""The branch this WorkingTree is connected to.
273
This cannot be set - it is reflective of the actual disk structure
274
the working tree has been constructed from.
277
def break_lock(self):
278
"""Break a lock if one is present from another instance.
280
Uses the ui factory to ask for confirmation if the lock may be from
283
This will probe the repository for its lock as well.
285
self._control_files.break_lock()
286
self.branch.break_lock()
288
def _get_check_refs(self):
289
"""Return the references needed to perform a check of this tree.
291
The default implementation returns no refs, and is only suitable for
292
trees that have no local caching and can commit on ghosts at any time.
294
:seealso: bzrlib.check for details about check_refs.
298
def requires_rich_root(self):
299
return self._format.requires_rich_root
301
def supports_tree_reference(self):
304
def supports_content_filtering(self):
305
return self._format.supports_content_filtering()
307
def supports_views(self):
308
return self.views.supports_views()
310
def _set_inventory(self, inv, dirty):
311
"""Set the internal cached inventory.
313
:param inv: The inventory to set.
314
:param dirty: A boolean indicating whether the inventory is the same
315
logical inventory as whats on disk. If True the inventory is not
316
the same and should be written to disk or data will be lost, if
317
False then the inventory is the same as that on disk and any
318
serialisation would be unneeded overhead.
320
self._inventory = inv
321
self._inventory_is_modified = dirty
324
def open(path=None, _unsupported=False):
325
"""Open an existing working tree at path.
329
path = osutils.getcwd()
330
control = bzrdir.BzrDir.open(path, _unsupported)
331
return control.open_workingtree(_unsupported)
334
def open_containing(path=None):
335
"""Open an existing working tree which has its root about path.
337
This probes for a working tree at path and searches upwards from there.
339
Basically we keep looking up until we find the control directory or
340
run into /. If there isn't one, raises NotBranchError.
341
TODO: give this a new exception.
342
If there is one, it is returned, along with the unused portion of path.
344
:return: The WorkingTree that contains 'path', and the rest of path
347
path = osutils.getcwd()
348
control, relpath = bzrdir.BzrDir.open_containing(path)
350
return control.open_workingtree(), relpath
353
def open_downlevel(path=None):
354
"""Open an unsupported working tree.
356
Only intended for advanced situations like upgrading part of a bzrdir.
358
return WorkingTree.open(path, _unsupported=True)
361
def find_trees(location):
362
def list_current(transport):
363
return [d for d in transport.list_dir('') if d != '.bzr']
364
def evaluate(bzrdir):
366
tree = bzrdir.open_workingtree()
367
except errors.NoWorkingTree:
371
t = transport.get_transport(location)
372
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
373
list_current=list_current)
374
return [tr for tr in iterator if tr is not None]
376
# should be deprecated - this is slow and in any case treating them as a
377
# container is (we now know) bad style -- mbp 20070302
378
## @deprecated_method(zero_fifteen)
380
"""Iterate through file_ids for this tree.
382
file_ids are in a WorkingTree if they are in the working inventory
383
and the working file exists.
385
inv = self._inventory
386
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
390
def all_file_ids(self):
391
"""See Tree.iter_all_file_ids"""
392
return set(self.inventory)
395
return "<%s of %s>" % (self.__class__.__name__,
396
getattr(self, 'basedir', None))
398
def abspath(self, filename):
399
return pathjoin(self.basedir, filename)
401
def basis_tree(self):
402
"""Return RevisionTree for the current last revision.
404
If the left most parent is a ghost then the returned tree will be an
405
empty tree - one obtained by calling
406
repository.revision_tree(NULL_REVISION).
409
revision_id = self.get_parent_ids()[0]
411
# no parents, return an empty revision tree.
412
# in the future this should return the tree for
413
# 'empty:' - the implicit root empty tree.
414
return self.branch.repository.revision_tree(
415
_mod_revision.NULL_REVISION)
417
return self.revision_tree(revision_id)
418
except errors.NoSuchRevision:
420
# No cached copy available, retrieve from the repository.
421
# FIXME? RBC 20060403 should we cache the inventory locally
424
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
429
if self.branch.repository.has_revision(revision_id):
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
438
def relpath(self, path):
439
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
442
interpreted relative to the python current working directory.
444
return osutils.relpath(self.basedir, path)
446
def has_filename(self, filename):
447
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
my_file = self.get_file(file_id, path=path, filtered=filtered)
467
return my_file.read()
471
def get_file_byname(self, filename, filtered=True):
472
path = self.abspath(filename)
474
if filtered and self.supports_content_filtering():
475
filters = self._content_filter_stack(filename)
476
return filtered_input_file(f, filters)
480
def get_file_lines(self, file_id, path=None, filtered=True):
481
"""See Tree.get_file_lines()"""
482
file = self.get_file(file_id, path, filtered=filtered)
484
return file.readlines()
489
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
490
"""See Tree.annotate_iter
492
This implementation will use the basis tree implementation if possible.
493
Lines not in the basis are attributed to CURRENT_REVISION
495
If there are pending merges, lines added by those merges will be
496
incorrectly attributed to CURRENT_REVISION (but after committing, the
497
attribution will be correct).
499
maybe_file_parent_keys = []
500
for parent_id in self.get_parent_ids():
502
parent_tree = self.revision_tree(parent_id)
503
except errors.NoSuchRevisionInTree:
504
parent_tree = self.branch.repository.revision_tree(parent_id)
505
parent_tree.lock_read()
507
if file_id not in parent_tree:
509
ie = parent_tree.inventory[file_id]
510
if ie.kind != 'file':
511
# Note: this is slightly unnecessary, because symlinks and
512
# directories have a "text" which is the empty text, and we
513
# know that won't mess up annotations. But it seems cleaner
515
parent_text_key = (file_id, ie.revision)
516
if parent_text_key not in maybe_file_parent_keys:
517
maybe_file_parent_keys.append(parent_text_key)
520
graph = _mod_graph.Graph(self.branch.repository.texts)
521
heads = graph.heads(maybe_file_parent_keys)
522
file_parent_keys = []
523
for key in maybe_file_parent_keys:
525
file_parent_keys.append(key)
527
# Now we have the parents of this content
528
annotator = self.branch.repository.texts.get_annotator()
529
text = self.get_file_text(file_id)
530
this_key =(file_id, default_revision)
531
annotator.add_special_text(this_key, file_parent_keys, text)
532
annotations = [(key[-1], line)
533
for key, line in annotator.annotate_flat(this_key)]
536
def _get_ancestors(self, default_revision):
537
ancestors = set([default_revision])
538
for parent_id in self.get_parent_ids():
539
ancestors.update(self.branch.repository.get_ancestry(
540
parent_id, topo_sorted=False))
543
def get_parent_ids(self):
544
"""See Tree.get_parent_ids.
546
This implementation reads the pending merges list and last_revision
547
value and uses that to decide what the parents list should be.
549
last_rev = _mod_revision.ensure_null(self._last_revision())
550
if _mod_revision.NULL_REVISION == last_rev:
555
merges_bytes = self._transport.get_bytes('pending-merges')
556
except errors.NoSuchFile:
559
for l in osutils.split_lines(merges_bytes):
560
revision_id = l.rstrip('\n')
561
parents.append(revision_id)
565
def get_root_id(self):
566
"""Return the id of this trees root"""
567
return self._inventory.root.file_id
569
def _get_store_filename(self, file_id):
570
## XXX: badly named; this is not in the store at all
571
return self.abspath(self.id2path(file_id))
574
def clone(self, to_bzrdir, revision_id=None):
575
"""Duplicate this working tree into to_bzr, including all state.
577
Specifically modified files are kept as modified, but
578
ignored and unknown files are discarded.
580
If you want to make a new line of development, see bzrdir.sprout()
583
If not None, the cloned tree will have its last revision set to
584
revision, and difference between the source trees last revision
585
and this one merged in.
587
# assumes the target bzr dir format is compatible.
588
result = to_bzrdir.create_workingtree()
589
self.copy_content_into(result, revision_id)
593
def copy_content_into(self, tree, revision_id=None):
594
"""Copy the current content and user files of this tree into tree."""
595
tree.set_root_id(self.get_root_id())
596
if revision_id is None:
597
merge.transform_tree(tree, self)
599
# TODO now merge from tree.last_revision to revision (to preserve
600
# user local changes)
601
merge.transform_tree(tree, self)
602
tree.set_parent_ids([revision_id])
604
def id2abspath(self, file_id):
605
return self.abspath(self.id2path(file_id))
607
def has_id(self, file_id):
608
# files that have been deleted are excluded
610
if not inv.has_id(file_id):
612
path = inv.id2path(file_id)
613
return osutils.lexists(self.abspath(path))
615
def has_or_had_id(self, file_id):
616
if file_id == self.inventory.root.file_id:
618
return self.inventory.has_id(file_id)
620
__contains__ = has_id
622
def get_file_size(self, file_id):
623
"""See Tree.get_file_size"""
624
# XXX: this returns the on-disk size; it should probably return the
627
return os.path.getsize(self.id2abspath(file_id))
629
if e.errno != errno.ENOENT:
635
def get_file_sha1(self, file_id, path=None, stat_value=None):
637
path = self._inventory.id2path(file_id)
638
return self._hashcache.get_sha1(path, stat_value)
640
def get_file_mtime(self, file_id, path=None):
642
path = self.inventory.id2path(file_id)
643
return os.lstat(self.abspath(path)).st_mtime
645
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
646
file_id = self.path2id(path)
648
# For unversioned files on win32, we just assume they are not
651
return self._inventory[file_id].executable
653
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
654
mode = stat_result.st_mode
655
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
657
if not supports_executable():
658
def is_executable(self, file_id, path=None):
659
return self._inventory[file_id].executable
661
_is_executable_from_path_and_stat = \
662
_is_executable_from_path_and_stat_from_basis
664
def is_executable(self, file_id, path=None):
666
path = self.id2path(file_id)
667
mode = os.lstat(self.abspath(path)).st_mode
668
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
670
_is_executable_from_path_and_stat = \
671
_is_executable_from_path_and_stat_from_stat
673
@needs_tree_write_lock
674
def _add(self, files, ids, kinds):
675
"""See MutableTree._add."""
676
# TODO: Re-adding a file that is removed in the working copy
677
# should probably put it back with the previous ID.
678
# the read and write working inventory should not occur in this
679
# function - they should be part of lock_write and unlock.
681
for f, file_id, kind in zip(files, ids, kinds):
683
inv.add_path(f, kind=kind)
685
inv.add_path(f, kind=kind, file_id=file_id)
686
self._inventory_is_modified = True
688
@needs_tree_write_lock
689
def _gather_kinds(self, files, kinds):
690
"""See MutableTree._gather_kinds."""
691
for pos, f in enumerate(files):
692
if kinds[pos] is None:
693
fullpath = normpath(self.abspath(f))
695
kinds[pos] = file_kind(fullpath)
697
if e.errno == errno.ENOENT:
698
raise errors.NoSuchFile(fullpath)
701
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
702
"""Add revision_id as a parent.
704
This is equivalent to retrieving the current list of parent ids
705
and setting the list to its value plus revision_id.
707
:param revision_id: The revision id to add to the parent list. It may
708
be a ghost revision as long as its not the first parent to be added,
709
or the allow_leftmost_as_ghost parameter is set True.
710
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
712
parents = self.get_parent_ids() + [revision_id]
713
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
714
or allow_leftmost_as_ghost)
716
@needs_tree_write_lock
717
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
718
"""Add revision_id, tree tuple as a parent.
720
This is equivalent to retrieving the current list of parent trees
721
and setting the list to its value plus parent_tuple. See also
722
add_parent_tree_id - if you only have a parent id available it will be
723
simpler to use that api. If you have the parent already available, using
724
this api is preferred.
726
:param parent_tuple: The (revision id, tree) to add to the parent list.
727
If the revision_id is a ghost, pass None for the tree.
728
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
730
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
731
if len(parent_ids) > 1:
732
# the leftmost may have already been a ghost, preserve that if it
734
allow_leftmost_as_ghost = True
735
self.set_parent_ids(parent_ids,
736
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
738
@needs_tree_write_lock
739
def add_pending_merge(self, *revision_ids):
740
# TODO: Perhaps should check at this point that the
741
# history of the revision is actually present?
742
parents = self.get_parent_ids()
744
for rev_id in revision_ids:
745
if rev_id in parents:
747
parents.append(rev_id)
750
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
752
def path_content_summary(self, path, _lstat=os.lstat,
753
_mapper=osutils.file_kind_from_stat_mode):
754
"""See Tree.path_content_summary."""
755
abspath = self.abspath(path)
757
stat_result = _lstat(abspath)
759
if getattr(e, 'errno', None) == errno.ENOENT:
761
return ('missing', None, None, None)
762
# propagate other errors
764
kind = _mapper(stat_result.st_mode)
766
return self._file_content_summary(path, stat_result)
767
elif kind == 'directory':
768
# perhaps it looks like a plain directory, but it's really a
770
if self._directory_is_tree_reference(path):
771
kind = 'tree-reference'
772
return kind, None, None, None
773
elif kind == 'symlink':
774
target = osutils.readlink(abspath)
775
return ('symlink', None, None, target)
777
return (kind, None, None, None)
779
def _file_content_summary(self, path, stat_result):
780
size = stat_result.st_size
781
executable = self._is_executable_from_path_and_stat(path, stat_result)
782
# try for a stat cache lookup
783
return ('file', size, executable, self._sha_from_stat(
786
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
787
"""Common ghost checking functionality from set_parent_*.
789
This checks that the left hand-parent exists if there are any
792
if len(revision_ids) > 0:
793
leftmost_id = revision_ids[0]
794
if (not allow_leftmost_as_ghost and not
795
self.branch.repository.has_revision(leftmost_id)):
796
raise errors.GhostRevisionUnusableHere(leftmost_id)
798
def _set_merges_from_parent_ids(self, parent_ids):
799
merges = parent_ids[1:]
800
self._transport.put_bytes('pending-merges', '\n'.join(merges),
801
mode=self.bzrdir._get_file_mode())
803
def _filter_parent_ids_by_ancestry(self, revision_ids):
804
"""Check that all merged revisions are proper 'heads'.
806
This will always return the first revision_id, and any merged revisions
809
if len(revision_ids) == 0:
811
graph = self.branch.repository.get_graph()
812
heads = graph.heads(revision_ids)
813
new_revision_ids = revision_ids[:1]
814
for revision_id in revision_ids[1:]:
815
if revision_id in heads and revision_id not in new_revision_ids:
816
new_revision_ids.append(revision_id)
817
if new_revision_ids != revision_ids:
818
trace.mutter('requested to set revision_ids = %s,'
819
' but filtered to %s', revision_ids, new_revision_ids)
820
return new_revision_ids
822
@needs_tree_write_lock
823
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
824
"""Set the parent ids to revision_ids.
826
See also set_parent_trees. This api will try to retrieve the tree data
827
for each element of revision_ids from the trees repository. If you have
828
tree data already available, it is more efficient to use
829
set_parent_trees rather than set_parent_ids. set_parent_ids is however
830
an easier API to use.
832
:param revision_ids: The revision_ids to set as the parent ids of this
833
working tree. Any of these may be ghosts.
835
self._check_parents_for_ghosts(revision_ids,
836
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
837
for revision_id in revision_ids:
838
_mod_revision.check_not_reserved_id(revision_id)
840
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
842
if len(revision_ids) > 0:
843
self.set_last_revision(revision_ids[0])
845
self.set_last_revision(_mod_revision.NULL_REVISION)
847
self._set_merges_from_parent_ids(revision_ids)
849
@needs_tree_write_lock
850
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
851
"""See MutableTree.set_parent_trees."""
852
parent_ids = [rev for (rev, tree) in parents_list]
853
for revision_id in parent_ids:
854
_mod_revision.check_not_reserved_id(revision_id)
856
self._check_parents_for_ghosts(parent_ids,
857
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
859
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
861
if len(parent_ids) == 0:
862
leftmost_parent_id = _mod_revision.NULL_REVISION
863
leftmost_parent_tree = None
865
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
867
if self._change_last_revision(leftmost_parent_id):
868
if leftmost_parent_tree is None:
869
# If we don't have a tree, fall back to reading the
870
# parent tree from the repository.
871
self._cache_basis_inventory(leftmost_parent_id)
873
inv = leftmost_parent_tree.inventory
874
xml = self._create_basis_xml_from_inventory(
875
leftmost_parent_id, inv)
876
self._write_basis_inventory(xml)
877
self._set_merges_from_parent_ids(parent_ids)
879
@needs_tree_write_lock
880
def set_pending_merges(self, rev_list):
881
parents = self.get_parent_ids()
882
leftmost = parents[:1]
883
new_parents = leftmost + rev_list
884
self.set_parent_ids(new_parents)
886
@needs_tree_write_lock
887
def set_merge_modified(self, modified_hashes):
889
for file_id, hash in modified_hashes.iteritems():
890
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
891
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
893
def _sha_from_stat(self, path, stat_result):
894
"""Get a sha digest from the tree's stat cache.
896
The default implementation assumes no stat cache is present.
898
:param path: The path.
899
:param stat_result: The stat result being looked up.
903
def _put_rio(self, filename, stanzas, header):
904
self._must_be_locked()
905
my_file = rio_file(stanzas, header)
906
self._transport.put_file(filename, my_file,
907
mode=self.bzrdir._get_file_mode())
909
@needs_write_lock # because merge pulls data into the branch.
910
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
911
merge_type=None, force=False):
912
"""Merge from a branch into this working tree.
914
:param branch: The branch to merge from.
915
:param to_revision: If non-None, the merge will merge to to_revision,
916
but not beyond it. to_revision does not need to be in the history
917
of the branch when it is supplied. If None, to_revision defaults to
918
branch.last_revision().
920
from bzrlib.merge import Merger, Merge3Merger
921
merger = Merger(self.branch, this_tree=self)
922
# check that there are no local alterations
923
if not force and self.has_changes():
924
raise errors.UncommittedChanges(self)
925
if to_revision is None:
926
to_revision = _mod_revision.ensure_null(branch.last_revision())
927
merger.other_rev_id = to_revision
928
if _mod_revision.is_null(merger.other_rev_id):
929
raise errors.NoCommits(branch)
930
self.branch.fetch(branch, last_revision=merger.other_rev_id)
931
merger.other_basis = merger.other_rev_id
932
merger.other_tree = self.branch.repository.revision_tree(
934
merger.other_branch = branch
935
if from_revision is None:
938
merger.set_base_revision(from_revision, branch)
939
if merger.base_rev_id == merger.other_rev_id:
940
raise errors.PointlessMerge
941
merger.backup_files = False
942
if merge_type is None:
943
merger.merge_type = Merge3Merger
945
merger.merge_type = merge_type
946
merger.set_interesting_files(None)
947
merger.show_base = False
948
merger.reprocess = False
949
conflicts = merger.do_merge()
954
def merge_modified(self):
955
"""Return a dictionary of files modified by a merge.
957
The list is initialized by WorkingTree.set_merge_modified, which is
958
typically called after we make some automatic updates to the tree
961
This returns a map of file_id->sha1, containing only files which are
962
still in the working inventory and have that text hash.
965
hashfile = self._transport.get('merge-hashes')
966
except errors.NoSuchFile:
971
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
972
raise errors.MergeModifiedFormatError()
973
except StopIteration:
974
raise errors.MergeModifiedFormatError()
975
for s in RioReader(hashfile):
976
# RioReader reads in Unicode, so convert file_ids back to utf8
977
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
978
if file_id not in self.inventory:
980
text_hash = s.get("hash")
981
if text_hash == self.get_file_sha1(file_id):
982
merge_hashes[file_id] = text_hash
988
def mkdir(self, path, file_id=None):
989
"""See MutableTree.mkdir()."""
991
file_id = generate_ids.gen_file_id(os.path.basename(path))
992
os.mkdir(self.abspath(path))
993
self.add(path, file_id, 'directory')
996
def get_symlink_target(self, file_id):
997
abspath = self.id2abspath(file_id)
998
target = osutils.readlink(abspath)
1002
def subsume(self, other_tree):
1003
def add_children(inventory, entry):
1004
for child_entry in entry.children.values():
1005
inventory._byid[child_entry.file_id] = child_entry
1006
if child_entry.kind == 'directory':
1007
add_children(inventory, child_entry)
1008
if other_tree.get_root_id() == self.get_root_id():
1009
raise errors.BadSubsumeSource(self, other_tree,
1010
'Trees have the same root')
1012
other_tree_path = self.relpath(other_tree.basedir)
1013
except errors.PathNotChild:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Tree is not contained by the other')
1016
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1017
if new_root_parent is None:
1018
raise errors.BadSubsumeSource(self, other_tree,
1019
'Parent directory is not versioned.')
1020
# We need to ensure that the result of a fetch will have a
1021
# versionedfile for the other_tree root, and only fetching into
1022
# RepositoryKnit2 guarantees that.
1023
if not self.branch.repository.supports_rich_root():
1024
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1025
other_tree.lock_tree_write()
1027
new_parents = other_tree.get_parent_ids()
1028
other_root = other_tree.inventory.root
1029
other_root.parent_id = new_root_parent
1030
other_root.name = osutils.basename(other_tree_path)
1031
self.inventory.add(other_root)
1032
add_children(self.inventory, other_root)
1033
self._write_inventory(self.inventory)
1034
# normally we don't want to fetch whole repositories, but i think
1035
# here we really do want to consolidate the whole thing.
1036
for parent_id in other_tree.get_parent_ids():
1037
self.branch.fetch(other_tree.branch, parent_id)
1038
self.add_parent_tree_id(parent_id)
1041
other_tree.bzrdir.retire_bzrdir()
1043
def _setup_directory_is_tree_reference(self):
1044
if self._branch.repository._format.supports_tree_reference:
1045
self._directory_is_tree_reference = \
1046
self._directory_may_be_tree_reference
1048
self._directory_is_tree_reference = \
1049
self._directory_is_never_tree_reference
1051
def _directory_is_never_tree_reference(self, relpath):
1054
def _directory_may_be_tree_reference(self, relpath):
1055
# as a special case, if a directory contains control files then
1056
# it's a tree reference, except that the root of the tree is not
1057
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1058
# TODO: We could ask all the control formats whether they
1059
# recognize this directory, but at the moment there's no cheap api
1060
# to do that. Since we probably can only nest bzr checkouts and
1061
# they always use this name it's ok for now. -- mbp 20060306
1063
# FIXME: There is an unhandled case here of a subdirectory
1064
# containing .bzr but not a branch; that will probably blow up
1065
# when you try to commit it. It might happen if there is a
1066
# checkout in a subdirectory. This can be avoided by not adding
1069
@needs_tree_write_lock
1070
def extract(self, file_id, format=None):
1071
"""Extract a subtree from this tree.
1073
A new branch will be created, relative to the path for this tree.
1077
segments = osutils.splitpath(path)
1078
transport = self.branch.bzrdir.root_transport
1079
for name in segments:
1080
transport = transport.clone(name)
1081
transport.ensure_base()
1084
sub_path = self.id2path(file_id)
1085
branch_transport = mkdirs(sub_path)
1087
format = self.bzrdir.cloning_metadir()
1088
branch_transport.ensure_base()
1089
branch_bzrdir = format.initialize_on_transport(branch_transport)
1091
repo = branch_bzrdir.find_repository()
1092
except errors.NoRepositoryPresent:
1093
repo = branch_bzrdir.create_repository()
1094
if not repo.supports_rich_root():
1095
raise errors.RootNotRich()
1096
new_branch = branch_bzrdir.create_branch()
1097
new_branch.pull(self.branch)
1098
for parent_id in self.get_parent_ids():
1099
new_branch.fetch(self.branch, parent_id)
1100
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1101
if tree_transport.base != branch_transport.base:
1102
tree_bzrdir = format.initialize_on_transport(tree_transport)
1103
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1104
target_branch=new_branch)
1106
tree_bzrdir = branch_bzrdir
1107
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1108
wt.set_parent_ids(self.get_parent_ids())
1109
my_inv = self.inventory
1110
child_inv = inventory.Inventory(root_id=None)
1111
new_root = my_inv[file_id]
1112
my_inv.remove_recursive_id(file_id)
1113
new_root.parent_id = None
1114
child_inv.add(new_root)
1115
self._write_inventory(my_inv)
1116
wt._write_inventory(child_inv)
1119
def _serialize(self, inventory, out_file):
1120
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1123
def _deserialize(selt, in_file):
1124
return xml5.serializer_v5.read_inventory(in_file)
1127
"""Write the in memory inventory to disk."""
1128
# TODO: Maybe this should only write on dirty ?
1129
if self._control_files._lock_mode != 'w':
1130
raise errors.NotWriteLocked(self)
1132
self._serialize(self._inventory, sio)
1134
self._transport.put_file('inventory', sio,
1135
mode=self.bzrdir._get_file_mode())
1136
self._inventory_is_modified = False
1138
def _kind(self, relpath):
1139
return osutils.file_kind(self.abspath(relpath))
1141
def list_files(self, include_root=False, from_dir=None, recursive=True):
1142
"""List all files as (path, class, kind, id, entry).
1144
Lists, but does not descend into unversioned directories.
1145
This does not include files that have been deleted in this
1146
tree. Skips the control directory.
1148
:param include_root: if True, return an entry for the root
1149
:param from_dir: start from this directory or None for the root
1150
:param recursive: whether to recurse into subdirectories or not
1152
# list_files is an iterator, so @needs_read_lock doesn't work properly
1153
# with it. So callers should be careful to always read_lock the tree.
1154
if not self.is_locked():
1155
raise errors.ObjectNotLocked(self)
1157
inv = self.inventory
1158
if from_dir is None and include_root is True:
1159
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1160
# Convert these into local objects to save lookup times
1161
pathjoin = osutils.pathjoin
1162
file_kind = self._kind
1164
# transport.base ends in a slash, we want the piece
1165
# between the last two slashes
1166
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1168
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1170
# directory file_id, relative path, absolute path, reverse sorted children
1171
if from_dir is not None:
1172
from_dir_id = inv.path2id(from_dir)
1173
if from_dir_id is None:
1174
# Directory not versioned
1176
from_dir_abspath = pathjoin(self.basedir, from_dir)
1178
from_dir_id = inv.root.file_id
1179
from_dir_abspath = self.basedir
1180
children = os.listdir(from_dir_abspath)
1182
# jam 20060527 The kernel sized tree seems equivalent whether we
1183
# use a deque and popleft to keep them sorted, or if we use a plain
1184
# list and just reverse() them.
1185
children = collections.deque(children)
1186
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1188
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1191
f = children.popleft()
1192
## TODO: If we find a subdirectory with its own .bzr
1193
## directory, then that is a separate tree and we
1194
## should exclude it.
1196
# the bzrdir for this tree
1197
if transport_base_dir == f:
1200
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1201
# and 'f' doesn't begin with one, we can do a string op, rather
1202
# than the checks of pathjoin(), all relative paths will have an extra slash
1204
fp = from_dir_relpath + '/' + f
1207
fap = from_dir_abspath + '/' + f
1209
f_ie = inv.get_child(from_dir_id, f)
1212
elif self.is_ignored(fp[1:]):
1215
# we may not have found this file, because of a unicode issue
1216
f_norm, can_access = osutils.normalized_filename(f)
1217
if f == f_norm or not can_access:
1218
# No change, so treat this file normally
1221
# this file can be accessed by a normalized path
1222
# check again if it is versioned
1223
# these lines are repeated here for performance
1225
fp = from_dir_relpath + '/' + f
1226
fap = from_dir_abspath + '/' + f
1227
f_ie = inv.get_child(from_dir_id, f)
1230
elif self.is_ignored(fp[1:]):
1237
# make a last minute entry
1239
yield fp[1:], c, fk, f_ie.file_id, f_ie
1242
yield fp[1:], c, fk, None, fk_entries[fk]()
1244
yield fp[1:], c, fk, None, TreeEntry()
1247
if fk != 'directory':
1250
# But do this child first if recursing down
1252
new_children = os.listdir(fap)
1254
new_children = collections.deque(new_children)
1255
stack.append((f_ie.file_id, fp, fap, new_children))
1256
# Break out of inner loop,
1257
# so that we start outer loop with child
1260
# if we finished all children, pop it off the stack
1263
@needs_tree_write_lock
1264
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1267
to_dir must exist in the inventory.
1269
If to_dir exists and is a directory, the files are moved into
1270
it, keeping their old names.
1272
Note that to_dir is only the last component of the new name;
1273
this doesn't change the directory.
1275
For each entry in from_paths the move mode will be determined
1278
The first mode moves the file in the filesystem and updates the
1279
inventory. The second mode only updates the inventory without
1280
touching the file on the filesystem. This is the new mode introduced
1283
move uses the second mode if 'after == True' and the target is not
1284
versioned but present in the working tree.
1286
move uses the second mode if 'after == False' and the source is
1287
versioned but no longer in the working tree, and the target is not
1288
versioned but present in the working tree.
1290
move uses the first mode if 'after == False' and the source is
1291
versioned and present in the working tree, and the target is not
1292
versioned and not present in the working tree.
1294
Everything else results in an error.
1296
This returns a list of (from_path, to_path) pairs for each
1297
entry that is moved.
1302
# check for deprecated use of signature
1304
to_dir = kwargs.get('to_name', None)
1306
raise TypeError('You must supply a target directory')
1308
symbol_versioning.warn('The parameter to_name was deprecated'
1309
' in version 0.13. Use to_dir instead',
1312
# check destination directory
1313
if isinstance(from_paths, basestring):
1315
inv = self.inventory
1316
to_abs = self.abspath(to_dir)
1317
if not isdir(to_abs):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotADirectory(to_abs))
1320
if not self.has_filename(to_dir):
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotInWorkingDirectory(to_dir))
1323
to_dir_id = inv.path2id(to_dir)
1324
if to_dir_id is None:
1325
raise errors.BzrMoveFailedError('',to_dir,
1326
errors.NotVersionedError(path=str(to_dir)))
1328
to_dir_ie = inv[to_dir_id]
1329
if to_dir_ie.kind != 'directory':
1330
raise errors.BzrMoveFailedError('',to_dir,
1331
errors.NotADirectory(to_abs))
1333
# create rename entries and tuples
1334
for from_rel in from_paths:
1335
from_tail = splitpath(from_rel)[-1]
1336
from_id = inv.path2id(from_rel)
1338
raise errors.BzrMoveFailedError(from_rel,to_dir,
1339
errors.NotVersionedError(path=str(from_rel)))
1341
from_entry = inv[from_id]
1342
from_parent_id = from_entry.parent_id
1343
to_rel = pathjoin(to_dir, from_tail)
1344
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1346
from_tail=from_tail,
1347
from_parent_id=from_parent_id,
1348
to_rel=to_rel, to_tail=from_tail,
1349
to_parent_id=to_dir_id)
1350
rename_entries.append(rename_entry)
1351
rename_tuples.append((from_rel, to_rel))
1353
# determine which move mode to use. checks also for movability
1354
rename_entries = self._determine_mv_mode(rename_entries, after)
1356
original_modified = self._inventory_is_modified
1359
self._inventory_is_modified = True
1360
self._move(rename_entries)
1362
# restore the inventory on error
1363
self._inventory_is_modified = original_modified
1365
self._write_inventory(inv)
1366
return rename_tuples
1368
def _determine_mv_mode(self, rename_entries, after=False):
1369
"""Determines for each from-to pair if both inventory and working tree
1370
or only the inventory has to be changed.
1372
Also does basic plausability tests.
1374
inv = self.inventory
1376
for rename_entry in rename_entries:
1377
# store to local variables for easier reference
1378
from_rel = rename_entry.from_rel
1379
from_id = rename_entry.from_id
1380
to_rel = rename_entry.to_rel
1381
to_id = inv.path2id(to_rel)
1382
only_change_inv = False
1384
# check the inventory for source and destination
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.NotVersionedError(path=str(from_rel)))
1388
if to_id is not None:
1389
raise errors.BzrMoveFailedError(from_rel,to_rel,
1390
errors.AlreadyVersionedError(path=str(to_rel)))
1392
# try to determine the mode for rename (only change inv or change
1393
# inv and file system)
1395
if not self.has_filename(to_rel):
1396
raise errors.BzrMoveFailedError(from_id,to_rel,
1397
errors.NoSuchFile(path=str(to_rel),
1398
extra="New file has not been created yet"))
1399
only_change_inv = True
1400
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1401
only_change_inv = True
1402
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1403
only_change_inv = False
1404
elif (not self.case_sensitive
1405
and from_rel.lower() == to_rel.lower()
1406
and self.has_filename(from_rel)):
1407
only_change_inv = False
1409
# something is wrong, so lets determine what exactly
1410
if not self.has_filename(from_rel) and \
1411
not self.has_filename(to_rel):
1412
raise errors.BzrRenameFailedError(from_rel,to_rel,
1413
errors.PathsDoNotExist(paths=(str(from_rel),
1416
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1417
rename_entry.only_change_inv = only_change_inv
1418
return rename_entries
1420
def _move(self, rename_entries):
1421
"""Moves a list of files.
1423
Depending on the value of the flag 'only_change_inv', the
1424
file will be moved on the file system or not.
1426
inv = self.inventory
1429
for entry in rename_entries:
1431
self._move_entry(entry)
1433
self._rollback_move(moved)
1437
def _rollback_move(self, moved):
1438
"""Try to rollback a previous move in case of an filesystem error."""
1439
inv = self.inventory
1442
self._move_entry(WorkingTree._RenameEntry(
1443
entry.to_rel, entry.from_id,
1444
entry.to_tail, entry.to_parent_id, entry.from_rel,
1445
entry.from_tail, entry.from_parent_id,
1446
entry.only_change_inv))
1447
except errors.BzrMoveFailedError, e:
1448
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1449
" The working tree is in an inconsistent state."
1450
" Please consider doing a 'bzr revert'."
1451
" Error message is: %s" % e)
1453
def _move_entry(self, entry):
1454
inv = self.inventory
1455
from_rel_abs = self.abspath(entry.from_rel)
1456
to_rel_abs = self.abspath(entry.to_rel)
1457
if from_rel_abs == to_rel_abs:
1458
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1459
"Source and target are identical.")
1461
if not entry.only_change_inv:
1463
osutils.rename(from_rel_abs, to_rel_abs)
1465
raise errors.BzrMoveFailedError(entry.from_rel,
1467
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1469
@needs_tree_write_lock
1470
def rename_one(self, from_rel, to_rel, after=False):
1473
This can change the directory or the filename or both.
1475
rename_one has several 'modes' to work. First, it can rename a physical
1476
file and change the file_id. That is the normal mode. Second, it can
1477
only change the file_id without touching any physical file. This is
1478
the new mode introduced in version 0.15.
1480
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the second mode if 'after == False' and 'from_rel' is
1484
versioned but no longer in the working tree, and 'to_rel' is not
1485
versioned but present in the working tree.
1487
rename_one uses the first mode if 'after == False' and 'from_rel' is
1488
versioned and present in the working tree, and 'to_rel' is not
1489
versioned and not present in the working tree.
1491
Everything else results in an error.
1493
inv = self.inventory
1496
# create rename entries and tuples
1497
from_tail = splitpath(from_rel)[-1]
1498
from_id = inv.path2id(from_rel)
1500
# if file is missing in the inventory maybe it's in the basis_tree
1501
basis_tree = self.branch.basis_tree()
1502
from_id = basis_tree.path2id(from_rel)
1504
raise errors.BzrRenameFailedError(from_rel,to_rel,
1505
errors.NotVersionedError(path=str(from_rel)))
1506
# put entry back in the inventory so we can rename it
1507
from_entry = basis_tree.inventory[from_id].copy()
1510
from_entry = inv[from_id]
1511
from_parent_id = from_entry.parent_id
1512
to_dir, to_tail = os.path.split(to_rel)
1513
to_dir_id = inv.path2id(to_dir)
1514
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1516
from_tail=from_tail,
1517
from_parent_id=from_parent_id,
1518
to_rel=to_rel, to_tail=to_tail,
1519
to_parent_id=to_dir_id)
1520
rename_entries.append(rename_entry)
1522
# determine which move mode to use. checks also for movability
1523
rename_entries = self._determine_mv_mode(rename_entries, after)
1525
# check if the target changed directory and if the target directory is
1527
if to_dir_id is None:
1528
raise errors.BzrMoveFailedError(from_rel,to_rel,
1529
errors.NotVersionedError(path=str(to_dir)))
1531
# all checks done. now we can continue with our actual work
1532
mutter('rename_one:\n'
1537
' to_dir_id {%s}\n',
1538
from_id, from_rel, to_rel, to_dir, to_dir_id)
1540
self._move(rename_entries)
1541
self._write_inventory(inv)
1543
class _RenameEntry(object):
1544
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1545
to_rel, to_tail, to_parent_id, only_change_inv=False):
1546
self.from_rel = from_rel
1547
self.from_id = from_id
1548
self.from_tail = from_tail
1549
self.from_parent_id = from_parent_id
1550
self.to_rel = to_rel
1551
self.to_tail = to_tail
1552
self.to_parent_id = to_parent_id
1553
self.only_change_inv = only_change_inv
1557
"""Return all unknown files.
1559
These are files in the working directory that are not versioned or
1560
control files or ignored.
1562
# force the extras method to be fully executed before returning, to
1563
# prevent race conditions with the lock
1565
[subp for subp in self.extras() if not self.is_ignored(subp)])
1567
@needs_tree_write_lock
1568
def unversion(self, file_ids):
1569
"""Remove the file ids in file_ids from the current versioned set.
1571
When a file_id is unversioned, all of its children are automatically
1574
:param file_ids: The file ids to stop versioning.
1575
:raises: NoSuchId if any fileid is not currently versioned.
1577
for file_id in file_ids:
1578
if file_id not in self._inventory:
1579
raise errors.NoSuchId(self, file_id)
1580
for file_id in file_ids:
1581
if self._inventory.has_id(file_id):
1582
self._inventory.remove_recursive_id(file_id)
1584
# in the future this should just set a dirty bit to wait for the
1585
# final unlock. However, until all methods of workingtree start
1586
# with the current in -memory inventory rather than triggering
1587
# a read, it is more complex - we need to teach read_inventory
1588
# to know when to read, and when to not read first... and possibly
1589
# to save first when the in memory one may be corrupted.
1590
# so for now, we just only write it if it is indeed dirty.
1592
self._write_inventory(self._inventory)
1594
def _iter_conflicts(self):
1596
for info in self.list_files():
1598
stem = get_conflicted_stem(path)
1601
if stem not in conflicted:
1602
conflicted.add(stem)
1606
def pull(self, source, overwrite=False, stop_revision=None,
1607
change_reporter=None, possible_transports=None, local=False):
1610
old_revision_info = self.branch.last_revision_info()
1611
basis_tree = self.basis_tree()
1612
count = self.branch.pull(source, overwrite, stop_revision,
1613
possible_transports=possible_transports,
1615
new_revision_info = self.branch.last_revision_info()
1616
if new_revision_info != old_revision_info:
1617
repository = self.branch.repository
1618
basis_tree.lock_read()
1620
new_basis_tree = self.branch.basis_tree()
1627
change_reporter=change_reporter)
1628
basis_root_id = basis_tree.get_root_id()
1629
new_root_id = new_basis_tree.get_root_id()
1630
if basis_root_id != new_root_id:
1631
self.set_root_id(new_root_id)
1634
# TODO - dedup parents list with things merged by pull ?
1635
# reuse the revisiontree we merged against to set the new
1637
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1638
# we have to pull the merge trees out again, because
1639
# merge_inner has set the ids. - this corner is not yet
1640
# layered well enough to prevent double handling.
1641
# XXX TODO: Fix the double handling: telling the tree about
1642
# the already known parent data is wasteful.
1643
merges = self.get_parent_ids()[1:]
1644
parent_trees.extend([
1645
(parent, repository.revision_tree(parent)) for
1647
self.set_parent_trees(parent_trees)
1653
def put_file_bytes_non_atomic(self, file_id, bytes):
1654
"""See MutableTree.put_file_bytes_non_atomic."""
1655
stream = file(self.id2abspath(file_id), 'wb')
1660
# TODO: update the hashcache here ?
1663
"""Yield all unversioned files in this WorkingTree.
1665
If there are any unversioned directories then only the directory is
1666
returned, not all its children. But if there are unversioned files
1667
under a versioned subdirectory, they are returned.
1669
Currently returned depth-first, sorted by name within directories.
1670
This is the same order used by 'osutils.walkdirs'.
1672
## TODO: Work from given directory downwards
1673
for path, dir_entry in self.inventory.directories():
1674
# mutter("search for unknowns in %r", path)
1675
dirabs = self.abspath(path)
1676
if not isdir(dirabs):
1677
# e.g. directory deleted
1681
for subf in os.listdir(dirabs):
1682
if self.bzrdir.is_control_filename(subf):
1684
if subf not in dir_entry.children:
1687
can_access) = osutils.normalized_filename(subf)
1688
except UnicodeDecodeError:
1689
path_os_enc = path.encode(osutils._fs_enc)
1690
relpath = path_os_enc + '/' + subf
1691
raise errors.BadFilenameEncoding(relpath,
1693
if subf_norm != subf and can_access:
1694
if subf_norm not in dir_entry.children:
1695
fl.append(subf_norm)
1701
subp = pathjoin(path, subf)
1704
def ignored_files(self):
1705
"""Yield list of PATH, IGNORE_PATTERN"""
1706
for subp in self.extras():
1707
pat = self.is_ignored(subp)
1711
def get_ignore_list(self):
1712
"""Return list of ignore patterns.
1714
Cached in the Tree object after the first call.
1716
ignoreset = getattr(self, '_ignoreset', None)
1717
if ignoreset is not None:
1720
ignore_globs = set()
1721
ignore_globs.update(ignores.get_runtime_ignores())
1722
ignore_globs.update(ignores.get_user_ignores())
1723
if self.has_filename(bzrlib.IGNORE_FILENAME):
1724
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1726
ignore_globs.update(ignores.parse_ignore_file(f))
1729
self._ignoreset = ignore_globs
1732
def _flush_ignore_list_cache(self):
1733
"""Resets the cached ignore list to force a cache rebuild."""
1734
self._ignoreset = None
1735
self._ignoreglobster = None
1737
def is_ignored(self, filename):
1738
r"""Check whether the filename matches an ignore pattern.
1740
Patterns containing '/' or '\' need to match the whole path;
1741
others match against only the last component. Patterns starting
1742
with '!' are ignore exceptions. Exceptions take precedence
1743
over regular patterns and cause the filename to not be ignored.
1745
If the file is ignored, returns the pattern which caused it to
1746
be ignored, otherwise None. So this can simply be used as a
1747
boolean if desired."""
1748
if getattr(self, '_ignoreglobster', None) is None:
1749
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1750
return self._ignoreglobster.match(filename)
1752
def kind(self, file_id):
1753
return file_kind(self.id2abspath(file_id))
1755
def stored_kind(self, file_id):
1756
"""See Tree.stored_kind"""
1757
return self.inventory[file_id].kind
1759
def _comparison_data(self, entry, path):
1760
abspath = self.abspath(path)
1762
stat_value = os.lstat(abspath)
1764
if getattr(e, 'errno', None) == errno.ENOENT:
1771
mode = stat_value.st_mode
1772
kind = osutils.file_kind_from_stat_mode(mode)
1773
if not supports_executable():
1774
executable = entry is not None and entry.executable
1776
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1777
return kind, executable, stat_value
1779
def _file_size(self, entry, stat_value):
1780
return stat_value.st_size
1782
def last_revision(self):
1783
"""Return the last revision of the branch for this tree.
1785
This format tree does not support a separate marker for last-revision
1786
compared to the branch.
1788
See MutableTree.last_revision
1790
return self._last_revision()
1793
def _last_revision(self):
1794
"""helper for get_parent_ids."""
1795
return _mod_revision.ensure_null(self.branch.last_revision())
1797
def is_locked(self):
1798
return self._control_files.is_locked()
1800
def _must_be_locked(self):
1801
if not self.is_locked():
1802
raise errors.ObjectNotLocked(self)
1804
def lock_read(self):
1805
"""Lock the tree for reading.
1807
This also locks the branch, and can be unlocked via self.unlock().
1809
:return: A bzrlib.lock.LogicalLockResult.
1811
if not self.is_locked():
1813
self.branch.lock_read()
1815
self._control_files.lock_read()
1816
return LogicalLockResult(self.unlock)
1818
self.branch.unlock()
1821
def lock_tree_write(self):
1822
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1824
:return: A bzrlib.lock.LogicalLockResult.
1826
if not self.is_locked():
1828
self.branch.lock_read()
1830
self._control_files.lock_write()
1831
return LogicalLockResult(self.unlock)
1833
self.branch.unlock()
1836
def lock_write(self):
1837
"""See MutableTree.lock_write, and WorkingTree.unlock.
1839
:return: A bzrlib.lock.LogicalLockResult.
1841
if not self.is_locked():
1843
self.branch.lock_write()
1845
self._control_files.lock_write()
1846
return LogicalLockResult(self.unlock)
1848
self.branch.unlock()
1851
def get_physical_lock_status(self):
1852
return self._control_files.get_physical_lock_status()
1854
def _basis_inventory_name(self):
1855
return 'basis-inventory-cache'
1857
def _reset_data(self):
1858
"""Reset transient data that cannot be revalidated."""
1859
self._inventory_is_modified = False
1860
f = self._transport.get('inventory')
1862
result = self._deserialize(f)
1865
self._set_inventory(result, dirty=False)
1867
@needs_tree_write_lock
1868
def set_last_revision(self, new_revision):
1869
"""Change the last revision in the working tree."""
1870
if self._change_last_revision(new_revision):
1871
self._cache_basis_inventory(new_revision)
1873
def _change_last_revision(self, new_revision):
1874
"""Template method part of set_last_revision to perform the change.
1876
This is used to allow WorkingTree3 instances to not affect branch
1877
when their last revision is set.
1879
if _mod_revision.is_null(new_revision):
1880
self.branch.set_revision_history([])
1883
self.branch.generate_revision_history(new_revision)
1884
except errors.NoSuchRevision:
1885
# not present in the repo - dont try to set it deeper than the tip
1886
self.branch.set_revision_history([new_revision])
1889
def _write_basis_inventory(self, xml):
1890
"""Write the basis inventory XML to the basis-inventory file"""
1891
path = self._basis_inventory_name()
1893
self._transport.put_file(path, sio,
1894
mode=self.bzrdir._get_file_mode())
1896
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1897
"""Create the text that will be saved in basis-inventory"""
1898
inventory.revision_id = revision_id
1899
return xml7.serializer_v7.write_inventory_to_string(inventory)
1901
def _cache_basis_inventory(self, new_revision):
1902
"""Cache new_revision as the basis inventory."""
1903
# TODO: this should allow the ready-to-use inventory to be passed in,
1904
# as commit already has that ready-to-use [while the format is the
1907
# this double handles the inventory - unpack and repack -
1908
# but is easier to understand. We can/should put a conditional
1909
# in here based on whether the inventory is in the latest format
1910
# - perhaps we should repack all inventories on a repository
1912
# the fast path is to copy the raw xml from the repository. If the
1913
# xml contains 'revision_id="', then we assume the right
1914
# revision_id is set. We must check for this full string, because a
1915
# root node id can legitimately look like 'revision_id' but cannot
1917
xml = self.branch.repository._get_inventory_xml(new_revision)
1918
firstline = xml.split('\n', 1)[0]
1919
if (not 'revision_id="' in firstline or
1920
'format="7"' not in firstline):
1921
inv = self.branch.repository._serializer.read_inventory_from_string(
1923
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1924
self._write_basis_inventory(xml)
1925
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1928
def read_basis_inventory(self):
1929
"""Read the cached basis inventory."""
1930
path = self._basis_inventory_name()
1931
return self._transport.get_bytes(path)
1934
def read_working_inventory(self):
1935
"""Read the working inventory.
1937
:raises errors.InventoryModified: read_working_inventory will fail
1938
when the current in memory inventory has been modified.
1940
# conceptually this should be an implementation detail of the tree.
1941
# XXX: Deprecate this.
1942
# ElementTree does its own conversion from UTF-8, so open in
1944
if self._inventory_is_modified:
1945
raise errors.InventoryModified(self)
1946
f = self._transport.get('inventory')
1948
result = self._deserialize(f)
1951
self._set_inventory(result, dirty=False)
1954
@needs_tree_write_lock
1955
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1957
"""Remove nominated files from the working inventory.
1959
:files: File paths relative to the basedir.
1960
:keep_files: If true, the files will also be kept.
1961
:force: Delete files and directories, even if they are changed and
1962
even if the directories are not empty.
1964
if isinstance(files, basestring):
1970
unknown_nested_files=set()
1972
to_file = sys.stdout
1974
def recurse_directory_to_add_files(directory):
1975
# Recurse directory and add all files
1976
# so we can check if they have changed.
1977
for parent_info, file_infos in self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
# Is it versioned or ignored?
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1981
# Add nested content for deletion.
1982
new_files.add(relpath)
1984
# Files which are not versioned and not ignored
1985
# should be treated as unknown.
1986
unknown_nested_files.add((relpath, None, kind))
1988
for filename in files:
1989
# Get file name into canonical form.
1990
abspath = self.abspath(filename)
1991
filename = self.relpath(abspath)
1992
if len(filename) > 0:
1993
new_files.add(filename)
1994
recurse_directory_to_add_files(filename)
1996
files = list(new_files)
1999
return # nothing to do
2001
# Sort needed to first handle directory content before the directory
2002
files.sort(reverse=True)
2004
# Bail out if we are going to delete files we shouldn't
2005
if not keep_files and not force:
2006
has_changed_files = len(unknown_nested_files) > 0
2007
if not has_changed_files:
2008
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
2010
include_unchanged=True, require_versioned=False,
2011
want_unversioned=True, specific_files=files):
2012
if versioned == (False, False):
2013
# The record is unknown ...
2014
if not self.is_ignored(path[1]):
2015
# ... but not ignored
2016
has_changed_files = True
2018
elif (content_change and (kind[1] is not None) and
2019
osutils.is_inside_any(files, path[1])):
2020
# Versioned and changed, but not deleted, and still
2021
# in one of the dirs to be deleted.
2022
has_changed_files = True
2025
if has_changed_files:
2026
# Make delta show ALL applicable changes in error message.
2027
tree_delta = self.changes_from(self.basis_tree(),
2028
require_versioned=False, want_unversioned=True,
2029
specific_files=files)
2030
for unknown_file in unknown_nested_files:
2031
if unknown_file not in tree_delta.unversioned:
2032
tree_delta.unversioned.extend((unknown_file,))
2033
raise errors.BzrRemoveChangedFilesError(tree_delta)
2035
# Build inv_delta and delete files where applicable,
2036
# do this before any modifications to inventory.
2038
fid = self.path2id(f)
2041
message = "%s is not versioned." % (f,)
2044
# having removed it, it must be either ignored or unknown
2045
if self.is_ignored(f):
2049
# XXX: Really should be a more abstract reporter interface
2050
kind_ch = osutils.kind_marker(self.kind(fid))
2051
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2053
inv_delta.append((f, None, fid, None))
2054
message = "removed %s" % (f,)
2057
abs_path = self.abspath(f)
2058
if osutils.lexists(abs_path):
2059
if (osutils.isdir(abs_path) and
2060
len(os.listdir(abs_path)) > 0):
2062
osutils.rmtree(abs_path)
2064
message = "%s is not an empty directory "\
2065
"and won't be deleted." % (f,)
2067
osutils.delete_any(abs_path)
2068
message = "deleted %s" % (f,)
2069
elif message is not None:
2070
# Only care if we haven't done anything yet.
2071
message = "%s does not exist." % (f,)
2073
# Print only one message (if any) per file.
2074
if message is not None:
2076
self.apply_inventory_delta(inv_delta)
2078
@needs_tree_write_lock
2079
def revert(self, filenames=None, old_tree=None, backups=True,
2080
pb=None, report_changes=False):
2081
from bzrlib.conflicts import resolve
2084
symbol_versioning.warn('Using [] to revert all files is deprecated'
2085
' as of bzr 0.91. Please use None (the default) instead.',
2086
DeprecationWarning, stacklevel=2)
2087
if old_tree is None:
2088
basis_tree = self.basis_tree()
2089
basis_tree.lock_read()
2090
old_tree = basis_tree
2094
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2096
if filenames is None and len(self.get_parent_ids()) > 1:
2098
last_revision = self.last_revision()
2099
if last_revision != _mod_revision.NULL_REVISION:
2100
if basis_tree is None:
2101
basis_tree = self.basis_tree()
2102
basis_tree.lock_read()
2103
parent_trees.append((last_revision, basis_tree))
2104
self.set_parent_trees(parent_trees)
2107
resolve(self, filenames, ignore_misses=True, recursive=True)
2109
if basis_tree is not None:
2113
def revision_tree(self, revision_id):
2114
"""See Tree.revision_tree.
2116
WorkingTree can supply revision_trees for the basis revision only
2117
because there is only one cached inventory in the bzr directory.
2119
if revision_id == self.last_revision():
2121
xml = self.read_basis_inventory()
2122
except errors.NoSuchFile:
2126
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2127
# dont use the repository revision_tree api because we want
2128
# to supply the inventory.
2129
if inv.revision_id == revision_id:
2130
return revisiontree.RevisionTree(self.branch.repository,
2132
except errors.BadInventoryFormat:
2134
# raise if there was no inventory, or if we read the wrong inventory.
2135
raise errors.NoSuchRevisionInTree(self, revision_id)
2137
# XXX: This method should be deprecated in favour of taking in a proper
2138
# new Inventory object.
2139
@needs_tree_write_lock
2140
def set_inventory(self, new_inventory_list):
2141
from bzrlib.inventory import (Inventory,
2145
inv = Inventory(self.get_root_id())
2146
for path, file_id, parent, kind in new_inventory_list:
2147
name = os.path.basename(path)
2150
# fixme, there should be a factory function inv,add_??
2151
if kind == 'directory':
2152
inv.add(InventoryDirectory(file_id, name, parent))
2153
elif kind == 'file':
2154
inv.add(InventoryFile(file_id, name, parent))
2155
elif kind == 'symlink':
2156
inv.add(InventoryLink(file_id, name, parent))
2158
raise errors.BzrError("unknown kind %r" % kind)
2159
self._write_inventory(inv)
2161
@needs_tree_write_lock
2162
def set_root_id(self, file_id):
2163
"""Set the root id for this tree."""
2167
'WorkingTree.set_root_id with fileid=None')
2168
file_id = osutils.safe_file_id(file_id)
2169
self._set_root_id(file_id)
2171
def _set_root_id(self, file_id):
2172
"""Set the root id for this tree, in a format specific manner.
2174
:param file_id: The file id to assign to the root. It must not be
2175
present in the current inventory or an error will occur. It must
2176
not be None, but rather a valid file id.
2178
inv = self._inventory
2179
orig_root_id = inv.root.file_id
2180
# TODO: it might be nice to exit early if there was nothing
2181
# to do, saving us from trigger a sync on unlock.
2182
self._inventory_is_modified = True
2183
# we preserve the root inventory entry object, but
2184
# unlinkit from the byid index
2185
del inv._byid[inv.root.file_id]
2186
inv.root.file_id = file_id
2187
# and link it into the index with the new changed id.
2188
inv._byid[inv.root.file_id] = inv.root
2189
# and finally update all children to reference the new id.
2190
# XXX: this should be safe to just look at the root.children
2191
# list, not the WHOLE INVENTORY.
2194
if entry.parent_id == orig_root_id:
2195
entry.parent_id = inv.root.file_id
2198
"""See Branch.unlock.
2200
WorkingTree locking just uses the Branch locking facilities.
2201
This is current because all working trees have an embedded branch
2202
within them. IF in the future, we were to make branch data shareable
2203
between multiple working trees, i.e. via shared storage, then we
2204
would probably want to lock both the local tree, and the branch.
2206
raise NotImplementedError(self.unlock)
2210
def update(self, change_reporter=None, possible_transports=None,
2211
revision=None, old_tip=_marker):
2212
"""Update a working tree along its branch.
2214
This will update the branch if its bound too, which means we have
2215
multiple trees involved:
2217
- The new basis tree of the master.
2218
- The old basis tree of the branch.
2219
- The old basis tree of the working tree.
2220
- The current working tree state.
2222
Pathologically, all three may be different, and non-ancestors of each
2223
other. Conceptually we want to:
2225
- Preserve the wt.basis->wt.state changes
2226
- Transform the wt.basis to the new master basis.
2227
- Apply a merge of the old branch basis to get any 'local' changes from
2229
- Restore the wt.basis->wt.state changes.
2231
There isn't a single operation at the moment to do that, so we:
2232
- Merge current state -> basis tree of the master w.r.t. the old tree
2234
- Do a 'normal' merge of the old branch basis if it is relevant.
2236
:param revision: The target revision to update to. Must be in the
2238
:param old_tip: If branch.update() has already been run, the value it
2239
returned (old tip of the branch or None). _marker is used
2242
if self.branch.get_bound_location() is not None:
2244
update_branch = (old_tip is self._marker)
2246
self.lock_tree_write()
2247
update_branch = False
2250
old_tip = self.branch.update(possible_transports)
2252
if old_tip is self._marker:
2254
return self._update_tree(old_tip, change_reporter, revision)
2258
@needs_tree_write_lock
2259
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2260
"""Update a tree to the master branch.
2262
:param old_tip: if supplied, the previous tip revision the branch,
2263
before it was changed to the master branch's tip.
2265
# here if old_tip is not None, it is the old tip of the branch before
2266
# it was updated from the master branch. This should become a pending
2267
# merge in the working tree to preserve the user existing work. we
2268
# cant set that until we update the working trees last revision to be
2269
# one from the new branch, because it will just get absorbed by the
2270
# parent de-duplication logic.
2272
# We MUST save it even if an error occurs, because otherwise the users
2273
# local work is unreferenced and will appear to have been lost.
2277
last_rev = self.get_parent_ids()[0]
2279
last_rev = _mod_revision.NULL_REVISION
2280
if revision is None:
2281
revision = self.branch.last_revision()
2283
old_tip = old_tip or _mod_revision.NULL_REVISION
2285
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2286
# the branch we are bound to was updated
2287
# merge those changes in first
2288
base_tree = self.basis_tree()
2289
other_tree = self.branch.repository.revision_tree(old_tip)
2290
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2291
base_tree, this_tree=self,
2292
change_reporter=change_reporter)
2294
self.add_parent_tree((old_tip, other_tree))
2295
trace.note('Rerun update after fixing the conflicts.')
2298
if last_rev != _mod_revision.ensure_null(revision):
2299
# the working tree is up to date with the branch
2300
# we can merge the specified revision from master
2301
to_tree = self.branch.repository.revision_tree(revision)
2302
to_root_id = to_tree.get_root_id()
2304
basis = self.basis_tree()
2307
if (basis.inventory.root is None
2308
or basis.inventory.root.file_id != to_root_id):
2309
self.set_root_id(to_root_id)
2314
# determine the branch point
2315
graph = self.branch.repository.get_graph()
2316
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2318
base_tree = self.branch.repository.revision_tree(base_rev_id)
2320
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2322
change_reporter=change_reporter)
2323
self.set_last_revision(revision)
2324
# TODO - dedup parents list with things merged by pull ?
2325
# reuse the tree we've updated to to set the basis:
2326
parent_trees = [(revision, to_tree)]
2327
merges = self.get_parent_ids()[1:]
2328
# Ideally we ask the tree for the trees here, that way the working
2329
# tree can decide whether to give us the entire tree or give us a
2330
# lazy initialised tree. dirstate for instance will have the trees
2331
# in ram already, whereas a last-revision + basis-inventory tree
2332
# will not, but also does not need them when setting parents.
2333
for parent in merges:
2334
parent_trees.append(
2335
(parent, self.branch.repository.revision_tree(parent)))
2336
if not _mod_revision.is_null(old_tip):
2337
parent_trees.append(
2338
(old_tip, self.branch.repository.revision_tree(old_tip)))
2339
self.set_parent_trees(parent_trees)
2340
last_rev = parent_trees[0][0]
2343
def _write_hashcache_if_dirty(self):
2344
"""Write out the hashcache if it is dirty."""
2345
if self._hashcache.needs_write:
2347
self._hashcache.write()
2349
if e.errno not in (errno.EPERM, errno.EACCES):
2351
# TODO: jam 20061219 Should this be a warning? A single line
2352
# warning might be sufficient to let the user know what
2354
mutter('Could not write hashcache for %s\nError: %s',
2355
self._hashcache.cache_file_name(), e)
2357
@needs_tree_write_lock
2358
def _write_inventory(self, inv):
2359
"""Write inventory as the current inventory."""
2360
self._set_inventory(inv, dirty=True)
2363
def set_conflicts(self, arg):
2364
raise errors.UnsupportedOperation(self.set_conflicts, self)
2366
def add_conflicts(self, arg):
2367
raise errors.UnsupportedOperation(self.add_conflicts, self)
2370
def conflicts(self):
2371
conflicts = _mod_conflicts.ConflictList()
2372
for conflicted in self._iter_conflicts():
2375
if file_kind(self.abspath(conflicted)) != "file":
2377
except errors.NoSuchFile:
2380
for suffix in ('.THIS', '.OTHER'):
2382
kind = file_kind(self.abspath(conflicted+suffix))
2385
except errors.NoSuchFile:
2389
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2390
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2392
file_id=self.path2id(conflicted)))
2395
def walkdirs(self, prefix=""):
2396
"""Walk the directories of this tree.
2398
returns a generator which yields items in the form:
2399
((curren_directory_path, fileid),
2400
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2403
This API returns a generator, which is only valid during the current
2404
tree transaction - within a single lock_read or lock_write duration.
2406
If the tree is not locked, it may cause an error to be raised,
2407
depending on the tree implementation.
2409
disk_top = self.abspath(prefix)
2410
if disk_top.endswith('/'):
2411
disk_top = disk_top[:-1]
2412
top_strip_len = len(disk_top) + 1
2413
inventory_iterator = self._walkdirs(prefix)
2414
disk_iterator = osutils.walkdirs(disk_top, prefix)
2416
current_disk = disk_iterator.next()
2417
disk_finished = False
2419
if not (e.errno == errno.ENOENT or
2420
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2423
disk_finished = True
2425
current_inv = inventory_iterator.next()
2426
inv_finished = False
2427
except StopIteration:
2430
while not inv_finished or not disk_finished:
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = current_disk
2435
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2436
cur_disk_dir_content) = ((None, None), None)
2437
if not disk_finished:
2438
# strip out .bzr dirs
2439
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2440
len(cur_disk_dir_content) > 0):
2441
# osutils.walkdirs can be made nicer -
2442
# yield the path-from-prefix rather than the pathjoined
2444
bzrdir_loc = bisect_left(cur_disk_dir_content,
2446
if (bzrdir_loc < len(cur_disk_dir_content)
2447
and self.bzrdir.is_control_filename(
2448
cur_disk_dir_content[bzrdir_loc][0])):
2449
# we dont yield the contents of, or, .bzr itself.
2450
del cur_disk_dir_content[bzrdir_loc]
2452
# everything is unknown
2455
# everything is missing
2458
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2460
# disk is before inventory - unknown
2461
dirblock = [(relpath, basename, kind, stat, None, None) for
2462
relpath, basename, kind, stat, top_path in
2463
cur_disk_dir_content]
2464
yield (cur_disk_dir_relpath, None), dirblock
2466
current_disk = disk_iterator.next()
2467
except StopIteration:
2468
disk_finished = True
2470
# inventory is before disk - missing.
2471
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2472
for relpath, basename, dkind, stat, fileid, kind in
2474
yield (current_inv[0][0], current_inv[0][1]), dirblock
2476
current_inv = inventory_iterator.next()
2477
except StopIteration:
2480
# versioned present directory
2481
# merge the inventory and disk data together
2483
for relpath, subiterator in itertools.groupby(sorted(
2484
current_inv[1] + cur_disk_dir_content,
2485
key=operator.itemgetter(0)), operator.itemgetter(1)):
2486
path_elements = list(subiterator)
2487
if len(path_elements) == 2:
2488
inv_row, disk_row = path_elements
2489
# versioned, present file
2490
dirblock.append((inv_row[0],
2491
inv_row[1], disk_row[2],
2492
disk_row[3], inv_row[4],
2494
elif len(path_elements[0]) == 5:
2496
dirblock.append((path_elements[0][0],
2497
path_elements[0][1], path_elements[0][2],
2498
path_elements[0][3], None, None))
2499
elif len(path_elements[0]) == 6:
2500
# versioned, absent file.
2501
dirblock.append((path_elements[0][0],
2502
path_elements[0][1], 'unknown', None,
2503
path_elements[0][4], path_elements[0][5]))
2505
raise NotImplementedError('unreachable code')
2506
yield current_inv[0], dirblock
2508
current_inv = inventory_iterator.next()
2509
except StopIteration:
2512
current_disk = disk_iterator.next()
2513
except StopIteration:
2514
disk_finished = True
2516
def _walkdirs(self, prefix=""):
2517
"""Walk the directories of this tree.
2519
:prefix: is used as the directrory to start with.
2520
returns a generator which yields items in the form:
2521
((curren_directory_path, fileid),
2522
[(file1_path, file1_name, file1_kind, None, file1_id,
2525
_directory = 'directory'
2526
# get the root in the inventory
2527
inv = self.inventory
2528
top_id = inv.path2id(prefix)
2532
pending = [(prefix, '', _directory, None, top_id, None)]
2535
currentdir = pending.pop()
2536
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2537
top_id = currentdir[4]
2539
relroot = currentdir[0] + '/'
2542
# FIXME: stash the node in pending
2544
if entry.kind == 'directory':
2545
for name, child in entry.sorted_children():
2546
dirblock.append((relroot + name, name, child.kind, None,
2547
child.file_id, child.kind
2549
yield (currentdir[0], entry.file_id), dirblock
2550
# push the user specified dirs from dirblock
2551
for dir in reversed(dirblock):
2552
if dir[2] == _directory:
2555
@needs_tree_write_lock
2556
def auto_resolve(self):
2557
"""Automatically resolve text conflicts according to contents.
2559
Only text conflicts are auto_resolvable. Files with no conflict markers
2560
are considered 'resolved', because bzr always puts conflict markers
2561
into files that have text conflicts. The corresponding .THIS .BASE and
2562
.OTHER files are deleted, as per 'resolve'.
2563
:return: a tuple of ConflictLists: (un_resolved, resolved).
2565
un_resolved = _mod_conflicts.ConflictList()
2566
resolved = _mod_conflicts.ConflictList()
2567
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2568
for conflict in self.conflicts():
2569
if (conflict.typestring != 'text conflict' or
2570
self.kind(conflict.file_id) != 'file'):
2571
un_resolved.append(conflict)
2573
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2575
for line in my_file:
2576
if conflict_re.search(line):
2577
un_resolved.append(conflict)
2580
resolved.append(conflict)
2583
resolved.remove_files(self)
2584
self.set_conflicts(un_resolved)
2585
return un_resolved, resolved
2588
def _check(self, references):
2589
"""Check the tree for consistency.
2591
:param references: A dict with keys matching the items returned by
2592
self._get_check_refs(), and values from looking those keys up in
2595
tree_basis = self.basis_tree()
2596
tree_basis.lock_read()
2598
repo_basis = references[('trees', self.last_revision())]
2599
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2600
raise errors.BzrCheckError(
2601
"Mismatched basis inventory content.")
2606
def _validate(self):
2607
"""Validate internal structures.
2609
This is meant mostly for the test suite. To give it a chance to detect
2610
corruption after actions have occurred. The default implementation is a
2613
:return: None. An exception should be raised if there is an error.
2617
def _get_rules_searcher(self, default_searcher):
2618
"""See Tree._get_rules_searcher."""
2619
if self._rules_searcher is None:
2620
self._rules_searcher = super(WorkingTree,
2621
self)._get_rules_searcher(default_searcher)
2622
return self._rules_searcher
2624
def get_shelf_manager(self):
2625
"""Return the ShelfManager for this WorkingTree."""
2626
from bzrlib.shelf import ShelfManager
2627
return ShelfManager(self, self._transport)
2630
class WorkingTree2(WorkingTree):
2631
"""This is the Format 2 working tree.
2633
This was the first weave based working tree.
2634
- uses os locks for locking.
2635
- uses the branch last-revision.
2638
def __init__(self, *args, **kwargs):
2639
super(WorkingTree2, self).__init__(*args, **kwargs)
2640
# WorkingTree2 has more of a constraint that self._inventory must
2641
# exist. Because this is an older format, we don't mind the overhead
2642
# caused by the extra computation here.
2644
# Newer WorkingTree's should only have self._inventory set when they
2646
if self._inventory is None:
2647
self.read_working_inventory()
2649
def _get_check_refs(self):
2650
"""Return the references needed to perform a check of this tree."""
2651
return [('trees', self.last_revision())]
2653
def lock_tree_write(self):
2654
"""See WorkingTree.lock_tree_write().
2656
In Format2 WorkingTrees we have a single lock for the branch and tree
2657
so lock_tree_write() degrades to lock_write().
2659
:return: An object with an unlock method which will release the lock
2662
self.branch.lock_write()
2664
self._control_files.lock_write()
2667
self.branch.unlock()
2671
# do non-implementation specific cleanup
2674
# we share control files:
2675
if self._control_files._lock_count == 3:
2676
# _inventory_is_modified is always False during a read lock.
2677
if self._inventory_is_modified:
2679
self._write_hashcache_if_dirty()
2681
# reverse order of locking.
2683
return self._control_files.unlock()
2685
self.branch.unlock()
2688
class WorkingTree3(WorkingTree):
2689
"""This is the Format 3 working tree.
2691
This differs from the base WorkingTree by:
2692
- having its own file lock
2693
- having its own last-revision property.
2695
This is new in bzr 0.8
2699
def _last_revision(self):
2700
"""See Mutable.last_revision."""
2702
return self._transport.get_bytes('last-revision')
2703
except errors.NoSuchFile:
2704
return _mod_revision.NULL_REVISION
2706
def _change_last_revision(self, revision_id):
2707
"""See WorkingTree._change_last_revision."""
2708
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2710
self._transport.delete('last-revision')
2711
except errors.NoSuchFile:
2715
self._transport.put_bytes('last-revision', revision_id,
2716
mode=self.bzrdir._get_file_mode())
2719
def _get_check_refs(self):
2720
"""Return the references needed to perform a check of this tree."""
2721
return [('trees', self.last_revision())]
2723
@needs_tree_write_lock
2724
def set_conflicts(self, conflicts):
2725
self._put_rio('conflicts', conflicts.to_stanzas(),
2728
@needs_tree_write_lock
2729
def add_conflicts(self, new_conflicts):
2730
conflict_set = set(self.conflicts())
2731
conflict_set.update(set(list(new_conflicts)))
2732
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2733
key=_mod_conflicts.Conflict.sort_key)))
2736
def conflicts(self):
2738
confile = self._transport.get('conflicts')
2739
except errors.NoSuchFile:
2740
return _mod_conflicts.ConflictList()
2743
if confile.next() != CONFLICT_HEADER_1 + '\n':
2744
raise errors.ConflictFormatError()
2745
except StopIteration:
2746
raise errors.ConflictFormatError()
2747
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2752
# do non-implementation specific cleanup
2754
if self._control_files._lock_count == 1:
2755
# _inventory_is_modified is always False during a read lock.
2756
if self._inventory_is_modified:
2758
self._write_hashcache_if_dirty()
2759
# reverse order of locking.
2761
return self._control_files.unlock()
2763
self.branch.unlock()
2766
def get_conflicted_stem(path):
2767
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2768
if path.endswith(suffix):
2769
return path[:-len(suffix)]
2772
class WorkingTreeFormat(object):
2773
"""An encapsulation of the initialization and open routines for a format.
2775
Formats provide three things:
2776
* An initialization routine,
2780
Formats are placed in an dict by their format string for reference
2781
during workingtree opening. Its not required that these be instances, they
2782
can be classes themselves with class methods - it simply depends on
2783
whether state is needed for a given format or not.
2785
Once a format is deprecated, just deprecate the initialize and open
2786
methods on the format class. Do not deprecate the object, as the
2787
object will be created every time regardless.
2790
_default_format = None
2791
"""The default format used for new trees."""
2794
"""The known formats."""
2796
requires_rich_root = False
2798
upgrade_recommended = False
2801
def find_format(klass, a_bzrdir):
2802
"""Return the format for the working tree object in a_bzrdir."""
2804
transport = a_bzrdir.get_workingtree_transport(None)
2805
format_string = transport.get_bytes("format")
2806
return klass._formats[format_string]
2807
except errors.NoSuchFile:
2808
raise errors.NoWorkingTree(base=transport.base)
2810
raise errors.UnknownFormatError(format=format_string,
2811
kind="working tree")
2813
def __eq__(self, other):
2814
return self.__class__ is other.__class__
2816
def __ne__(self, other):
2817
return not (self == other)
2820
def get_default_format(klass):
2821
"""Return the current default format."""
2822
return klass._default_format
2824
def get_format_string(self):
2825
"""Return the ASCII format string that identifies this format."""
2826
raise NotImplementedError(self.get_format_string)
2828
def get_format_description(self):
2829
"""Return the short description for this format."""
2830
raise NotImplementedError(self.get_format_description)
2832
def is_supported(self):
2833
"""Is this format supported?
2835
Supported formats can be initialized and opened.
2836
Unsupported formats may not support initialization or committing or
2837
some other features depending on the reason for not being supported.
2841
def supports_content_filtering(self):
2842
"""True if this format supports content filtering."""
2845
def supports_views(self):
2846
"""True if this format supports stored views."""
2850
def register_format(klass, format):
2851
klass._formats[format.get_format_string()] = format
2854
def set_default_format(klass, format):
2855
klass._default_format = format
2858
def unregister_format(klass, format):
2859
del klass._formats[format.get_format_string()]
2862
class WorkingTreeFormat2(WorkingTreeFormat):
2863
"""The second working tree format.
2865
This format modified the hash cache from the format 1 hash cache.
2868
upgrade_recommended = True
2870
def get_format_description(self):
2871
"""See WorkingTreeFormat.get_format_description()."""
2872
return "Working tree format 2"
2874
def _stub_initialize_on_transport(self, transport, file_mode):
2875
"""Workaround: create control files for a remote working tree.
2877
This ensures that it can later be updated and dealt with locally,
2878
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2879
no working tree. (See bug #43064).
2882
inv = inventory.Inventory()
2883
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2885
transport.put_file('inventory', sio, file_mode)
2886
transport.put_bytes('pending-merges', '', file_mode)
2888
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2889
accelerator_tree=None, hardlink=False):
2890
"""See WorkingTreeFormat.initialize()."""
2891
if not isinstance(a_bzrdir.transport, LocalTransport):
2892
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2893
if from_branch is not None:
2894
branch = from_branch
2896
branch = a_bzrdir.open_branch()
2897
if revision_id is None:
2898
revision_id = _mod_revision.ensure_null(branch.last_revision())
2901
branch.generate_revision_history(revision_id)
2904
inv = inventory.Inventory()
2905
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2911
basis_tree = branch.repository.revision_tree(revision_id)
2912
if basis_tree.inventory.root is not None:
2913
wt.set_root_id(basis_tree.get_root_id())
2914
# set the parent list and cache the basis tree.
2915
if _mod_revision.is_null(revision_id):
2918
parent_trees = [(revision_id, basis_tree)]
2919
wt.set_parent_trees(parent_trees)
2920
transform.build_tree(basis_tree, wt)
2924
super(WorkingTreeFormat2, self).__init__()
2925
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2927
def open(self, a_bzrdir, _found=False):
2928
"""Return the WorkingTree object for a_bzrdir
2930
_found is a private parameter, do not use it. It is used to indicate
2931
if format probing has already been done.
2934
# we are being called directly and must probe.
2935
raise NotImplementedError
2936
if not isinstance(a_bzrdir.transport, LocalTransport):
2937
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2938
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2944
class WorkingTreeFormat3(WorkingTreeFormat):
2945
"""The second working tree format updated to record a format marker.
2948
- exists within a metadir controlling .bzr
2949
- includes an explicit version marker for the workingtree control
2950
files, separate from the BzrDir format
2951
- modifies the hash cache format
2953
- uses a LockDir to guard access for writes.
2956
upgrade_recommended = True
2958
def get_format_string(self):
2959
"""See WorkingTreeFormat.get_format_string()."""
2960
return "Bazaar-NG Working Tree format 3"
2962
def get_format_description(self):
2963
"""See WorkingTreeFormat.get_format_description()."""
2964
return "Working tree format 3"
2966
_lock_file_name = 'lock'
2967
_lock_class = LockDir
2969
_tree_class = WorkingTree3
2971
def __get_matchingbzrdir(self):
2972
return bzrdir.BzrDirMetaFormat1()
2974
_matchingbzrdir = property(__get_matchingbzrdir)
2976
def _open_control_files(self, a_bzrdir):
2977
transport = a_bzrdir.get_workingtree_transport(None)
2978
return LockableFiles(transport, self._lock_file_name,
2981
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2982
accelerator_tree=None, hardlink=False):
2983
"""See WorkingTreeFormat.initialize().
2985
:param revision_id: if supplied, create a working tree at a different
2986
revision than the branch is at.
2987
:param accelerator_tree: A tree which can be used for retrieving file
2988
contents more quickly than the revision tree, i.e. a workingtree.
2989
The revision tree will be used for cases where accelerator_tree's
2990
content is different.
2991
:param hardlink: If true, hard-link files from accelerator_tree,
2994
if not isinstance(a_bzrdir.transport, LocalTransport):
2995
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2996
transport = a_bzrdir.get_workingtree_transport(self)
2997
control_files = self._open_control_files(a_bzrdir)
2998
control_files.create_lock()
2999
control_files.lock_write()
3000
transport.put_bytes('format', self.get_format_string(),
3001
mode=a_bzrdir._get_file_mode())
3002
if from_branch is not None:
3003
branch = from_branch
3005
branch = a_bzrdir.open_branch()
3006
if revision_id is None:
3007
revision_id = _mod_revision.ensure_null(branch.last_revision())
3008
# WorkingTree3 can handle an inventory which has a unique root id.
3009
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3010
# those trees. And because there isn't a format bump inbetween, we
3011
# are maintaining compatibility with older clients.
3012
# inv = Inventory(root_id=gen_root_id())
3013
inv = self._initial_inventory()
3014
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3020
_control_files=control_files)
3021
wt.lock_tree_write()
3023
basis_tree = branch.repository.revision_tree(revision_id)
3024
# only set an explicit root id if there is one to set.
3025
if basis_tree.inventory.root is not None:
3026
wt.set_root_id(basis_tree.get_root_id())
3027
if revision_id == _mod_revision.NULL_REVISION:
3028
wt.set_parent_trees([])
3030
wt.set_parent_trees([(revision_id, basis_tree)])
3031
transform.build_tree(basis_tree, wt)
3033
# Unlock in this order so that the unlock-triggers-flush in
3034
# WorkingTree is given a chance to fire.
3035
control_files.unlock()
3039
def _initial_inventory(self):
3040
return inventory.Inventory()
3043
super(WorkingTreeFormat3, self).__init__()
3045
def open(self, a_bzrdir, _found=False):
3046
"""Return the WorkingTree object for a_bzrdir
3048
_found is a private parameter, do not use it. It is used to indicate
3049
if format probing has already been done.
3052
# we are being called directly and must probe.
3053
raise NotImplementedError
3054
if not isinstance(a_bzrdir.transport, LocalTransport):
3055
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3056
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3059
def _open(self, a_bzrdir, control_files):
3060
"""Open the tree itself.
3062
:param a_bzrdir: the dir for the tree.
3063
:param control_files: the control files for the tree.
3065
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3069
_control_files=control_files)
3072
return self.get_format_string()
3075
__default_format = WorkingTreeFormat6()
3076
WorkingTreeFormat.register_format(__default_format)
3077
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3078
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3079
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3080
WorkingTreeFormat.set_default_format(__default_format)
3081
# formats which have no format string are not discoverable
3082
# and not independently creatable, so are not registered.
3083
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
