1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
57
conflicts as _mod_conflicts,
66
revision as _mod_revision,
76
from bzrlib.transport import get_transport
77
from bzrlib.workingtree_4 import (
84
from bzrlib import symbol_versioning
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib import osutils
91
from bzrlib.osutils import (
101
from bzrlib.filters import filtered_input_file
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (
109
DEPRECATED_PARAMETER,
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
116
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
119
class TreeEntry(object):
120
"""An entry that implements the minimum interface used by commands.
122
This needs further inspection, it may be better to have
123
InventoryEntries without ids - though that seems wrong. For now,
124
this is a parallel hierarchy to InventoryEntry, and needs to become
125
one of several things: decorates to that hierarchy, children of, or
127
Another note is that these objects are currently only used when there is
128
no InventoryEntry available - i.e. for unversioned objects.
129
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
132
def __eq__(self, other):
133
# yes, this us ugly, TODO: best practice __eq__ style.
134
return (isinstance(other, TreeEntry)
135
and other.__class__ == self.__class__)
137
def kind_character(self):
141
class TreeDirectory(TreeEntry):
142
"""See TreeEntry. This is a directory in a working tree."""
144
def __eq__(self, other):
145
return (isinstance(other, TreeDirectory)
146
and other.__class__ == self.__class__)
148
def kind_character(self):
152
class TreeFile(TreeEntry):
153
"""See TreeEntry. This is a regular file in a working tree."""
155
def __eq__(self, other):
156
return (isinstance(other, TreeFile)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeLink(TreeEntry):
164
"""See TreeEntry. This is a symlink in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeLink)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class WorkingTree(bzrlib.mutabletree.MutableTree):
175
"""Working copy tree.
177
The inventory is held in the `Branch` working-inventory, and the
178
files are in a directory on disk.
180
It is possible for a `WorkingTree` to have a filename which is
181
not listed in the Inventory and vice versa.
184
# override this to set the strategy for storing views
185
def _make_views(self):
186
return views.DisabledViews(self)
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode(),
229
self._content_filter_stack_provider())
232
# is this scan needed ? it makes things kinda slow.
239
if _inventory is None:
240
# This will be acquired on lock_read() or lock_write()
241
self._inventory_is_modified = False
242
self._inventory = None
244
# the caller of __init__ has provided an inventory,
245
# we assume they know what they are doing - as its only
246
# the Format factory and creation methods that are
247
# permitted to do this.
248
self._set_inventory(_inventory, dirty=False)
249
self._detect_case_handling()
250
self._rules_searcher = None
251
self.views = self._make_views()
253
def _detect_case_handling(self):
254
wt_trans = self.bzrdir.get_workingtree_transport(None)
256
wt_trans.stat("FoRMaT")
257
except errors.NoSuchFile:
258
self.case_sensitive = True
260
self.case_sensitive = False
262
self._setup_directory_is_tree_reference()
265
fget=lambda self: self._branch,
266
doc="""The branch this WorkingTree is connected to.
268
This cannot be set - it is reflective of the actual disk structure
269
the working tree has been constructed from.
272
def break_lock(self):
273
"""Break a lock if one is present from another instance.
275
Uses the ui factory to ask for confirmation if the lock may be from
278
This will probe the repository for its lock as well.
280
self._control_files.break_lock()
281
self.branch.break_lock()
283
def _get_check_refs(self):
284
"""Return the references needed to perform a check of this tree.
286
The default implementation returns no refs, and is only suitable for
287
trees that have no local caching and can commit on ghosts at any time.
289
:seealso: bzrlib.check for details about check_refs.
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def supports_content_filtering(self):
300
return self._format.supports_content_filtering()
302
def supports_views(self):
303
return self.views.supports_views()
305
def _set_inventory(self, inv, dirty):
306
"""Set the internal cached inventory.
308
:param inv: The inventory to set.
309
:param dirty: A boolean indicating whether the inventory is the same
310
logical inventory as whats on disk. If True the inventory is not
311
the same and should be written to disk or data will be lost, if
312
False then the inventory is the same as that on disk and any
313
serialisation would be unneeded overhead.
315
self._inventory = inv
316
self._inventory_is_modified = dirty
319
def open(path=None, _unsupported=False):
320
"""Open an existing working tree at path.
324
path = osutils.getcwd()
325
control = bzrdir.BzrDir.open(path, _unsupported)
326
return control.open_workingtree(_unsupported)
329
def open_containing(path=None):
330
"""Open an existing working tree which has its root about path.
332
This probes for a working tree at path and searches upwards from there.
334
Basically we keep looking up until we find the control directory or
335
run into /. If there isn't one, raises NotBranchError.
336
TODO: give this a new exception.
337
If there is one, it is returned, along with the unused portion of path.
339
:return: The WorkingTree that contains 'path', and the rest of path
342
path = osutils.getcwd()
343
control, relpath = bzrdir.BzrDir.open_containing(path)
345
return control.open_workingtree(), relpath
348
def open_downlevel(path=None):
349
"""Open an unsupported working tree.
351
Only intended for advanced situations like upgrading part of a bzrdir.
353
return WorkingTree.open(path, _unsupported=True)
356
def find_trees(location):
357
def list_current(transport):
358
return [d for d in transport.list_dir('') if d != '.bzr']
359
def evaluate(bzrdir):
361
tree = bzrdir.open_workingtree()
362
except errors.NoWorkingTree:
366
transport = get_transport(location)
367
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
368
list_current=list_current)
369
return [t for t in iterator if t is not None]
371
# should be deprecated - this is slow and in any case treating them as a
372
# container is (we now know) bad style -- mbp 20070302
373
## @deprecated_method(zero_fifteen)
375
"""Iterate through file_ids for this tree.
377
file_ids are in a WorkingTree if they are in the working inventory
378
and the working file exists.
380
inv = self._inventory
381
for path, ie in inv.iter_entries():
382
if osutils.lexists(self.abspath(path)):
385
def all_file_ids(self):
386
"""See Tree.iter_all_file_ids"""
387
return set(self.inventory)
390
return "<%s of %s>" % (self.__class__.__name__,
391
getattr(self, 'basedir', None))
393
def abspath(self, filename):
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling
401
repository.revision_tree(NULL_REVISION).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
412
return self.revision_tree(revision_id)
413
except errors.NoSuchRevision:
415
# No cached copy available, retrieve from the repository.
416
# FIXME? RBC 20060403 should we cache the inventory locally
419
return self.branch.repository.revision_tree(revision_id)
420
except (errors.RevisionNotPresent, errors.NoSuchRevision):
421
# the basis tree *may* be a ghost or a low level error may have
422
# occurred. If the revision is present, its a problem, if its not
424
if self.branch.repository.has_revision(revision_id):
426
# the basis tree is a ghost so return an empty tree.
427
return self.branch.repository.revision_tree(
428
_mod_revision.NULL_REVISION)
431
self._flush_ignore_list_cache()
433
def relpath(self, path):
434
"""Return the local path portion from a given path.
436
The path may be absolute or relative. If its a relative path it is
437
interpreted relative to the python current working directory.
439
return osutils.relpath(self.basedir, path)
441
def has_filename(self, filename):
442
return osutils.lexists(self.abspath(filename))
444
def get_file(self, file_id, path=None, filtered=True):
445
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
447
def get_file_with_stat(self, file_id, path=None, filtered=True,
449
"""See Tree.get_file_with_stat."""
451
path = self.id2path(file_id)
452
file_obj = self.get_file_byname(path, filtered=False)
453
stat_value = _fstat(file_obj.fileno())
454
if filtered and self.supports_content_filtering():
455
filters = self._content_filter_stack(path)
456
file_obj = filtered_input_file(file_obj, filters)
457
return (file_obj, stat_value)
459
def get_file_text(self, file_id, path=None, filtered=True):
460
return self.get_file(file_id, path=path, filtered=filtered).read()
462
def get_file_byname(self, filename, filtered=True):
463
path = self.abspath(filename)
465
if filtered and self.supports_content_filtering():
466
filters = self._content_filter_stack(filename)
467
return filtered_input_file(f, filters)
471
def get_file_lines(self, file_id, path=None, filtered=True):
472
"""See Tree.get_file_lines()"""
473
file = self.get_file(file_id, path, filtered=filtered)
475
return file.readlines()
480
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
481
"""See Tree.annotate_iter
483
This implementation will use the basis tree implementation if possible.
484
Lines not in the basis are attributed to CURRENT_REVISION
486
If there are pending merges, lines added by those merges will be
487
incorrectly attributed to CURRENT_REVISION (but after committing, the
488
attribution will be correct).
490
maybe_file_parent_keys = []
491
for parent_id in self.get_parent_ids():
493
parent_tree = self.revision_tree(parent_id)
494
except errors.NoSuchRevisionInTree:
495
parent_tree = self.branch.repository.revision_tree(parent_id)
496
parent_tree.lock_read()
498
if file_id not in parent_tree:
500
ie = parent_tree.inventory[file_id]
501
if ie.kind != 'file':
502
# Note: this is slightly unnecessary, because symlinks and
503
# directories have a "text" which is the empty text, and we
504
# know that won't mess up annotations. But it seems cleaner
506
parent_text_key = (file_id, ie.revision)
507
if parent_text_key not in maybe_file_parent_keys:
508
maybe_file_parent_keys.append(parent_text_key)
511
graph = _mod_graph.Graph(self.branch.repository.texts)
512
heads = graph.heads(maybe_file_parent_keys)
513
file_parent_keys = []
514
for key in maybe_file_parent_keys:
516
file_parent_keys.append(key)
518
# Now we have the parents of this content
519
annotator = self.branch.repository.texts.get_annotator()
520
text = self.get_file(file_id).read()
521
this_key =(file_id, default_revision)
522
annotator.add_special_text(this_key, file_parent_keys, text)
523
annotations = [(key[-1], line)
524
for key, line in annotator.annotate_flat(this_key)]
527
def _get_ancestors(self, default_revision):
528
ancestors = set([default_revision])
529
for parent_id in self.get_parent_ids():
530
ancestors.update(self.branch.repository.get_ancestry(
531
parent_id, topo_sorted=False))
534
def get_parent_ids(self):
535
"""See Tree.get_parent_ids.
537
This implementation reads the pending merges list and last_revision
538
value and uses that to decide what the parents list should be.
540
last_rev = _mod_revision.ensure_null(self._last_revision())
541
if _mod_revision.NULL_REVISION == last_rev:
546
merges_bytes = self._transport.get_bytes('pending-merges')
547
except errors.NoSuchFile:
550
for l in osutils.split_lines(merges_bytes):
551
revision_id = l.rstrip('\n')
552
parents.append(revision_id)
556
def get_root_id(self):
557
"""Return the id of this trees root"""
558
return self._inventory.root.file_id
560
def _get_store_filename(self, file_id):
561
## XXX: badly named; this is not in the store at all
562
return self.abspath(self.id2path(file_id))
565
def clone(self, to_bzrdir, revision_id=None):
566
"""Duplicate this working tree into to_bzr, including all state.
568
Specifically modified files are kept as modified, but
569
ignored and unknown files are discarded.
571
If you want to make a new line of development, see bzrdir.sprout()
574
If not None, the cloned tree will have its last revision set to
575
revision, and difference between the source trees last revision
576
and this one merged in.
578
# assumes the target bzr dir format is compatible.
579
result = to_bzrdir.create_workingtree()
580
self.copy_content_into(result, revision_id)
584
def copy_content_into(self, tree, revision_id=None):
585
"""Copy the current content and user files of this tree into tree."""
586
tree.set_root_id(self.get_root_id())
587
if revision_id is None:
588
merge.transform_tree(tree, self)
590
# TODO now merge from tree.last_revision to revision (to preserve
591
# user local changes)
592
merge.transform_tree(tree, self)
593
tree.set_parent_ids([revision_id])
595
def id2abspath(self, file_id):
596
return self.abspath(self.id2path(file_id))
598
def has_id(self, file_id):
599
# files that have been deleted are excluded
601
if not inv.has_id(file_id):
603
path = inv.id2path(file_id)
604
return osutils.lexists(self.abspath(path))
606
def has_or_had_id(self, file_id):
607
if file_id == self.inventory.root.file_id:
609
return self.inventory.has_id(file_id)
611
__contains__ = has_id
613
def get_file_size(self, file_id):
614
"""See Tree.get_file_size"""
615
# XXX: this returns the on-disk size; it should probably return the
618
return os.path.getsize(self.id2abspath(file_id))
620
if e.errno != errno.ENOENT:
626
def get_file_sha1(self, file_id, path=None, stat_value=None):
628
path = self._inventory.id2path(file_id)
629
return self._hashcache.get_sha1(path, stat_value)
631
def get_file_mtime(self, file_id, path=None):
633
path = self.inventory.id2path(file_id)
634
return os.lstat(self.abspath(path)).st_mtime
636
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
637
file_id = self.path2id(path)
639
# For unversioned files on win32, we just assume they are not
642
return self._inventory[file_id].executable
644
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
645
mode = stat_result.st_mode
646
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
648
if not supports_executable():
649
def is_executable(self, file_id, path=None):
650
return self._inventory[file_id].executable
652
_is_executable_from_path_and_stat = \
653
_is_executable_from_path_and_stat_from_basis
655
def is_executable(self, file_id, path=None):
657
path = self.id2path(file_id)
658
mode = os.lstat(self.abspath(path)).st_mode
659
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
661
_is_executable_from_path_and_stat = \
662
_is_executable_from_path_and_stat_from_stat
664
@needs_tree_write_lock
665
def _add(self, files, ids, kinds):
666
"""See MutableTree._add."""
667
# TODO: Re-adding a file that is removed in the working copy
668
# should probably put it back with the previous ID.
669
# the read and write working inventory should not occur in this
670
# function - they should be part of lock_write and unlock.
672
for f, file_id, kind in zip(files, ids, kinds):
674
inv.add_path(f, kind=kind)
676
inv.add_path(f, kind=kind, file_id=file_id)
677
self._inventory_is_modified = True
679
@needs_tree_write_lock
680
def _gather_kinds(self, files, kinds):
681
"""See MutableTree._gather_kinds."""
682
for pos, f in enumerate(files):
683
if kinds[pos] is None:
684
fullpath = normpath(self.abspath(f))
686
kinds[pos] = file_kind(fullpath)
688
if e.errno == errno.ENOENT:
689
raise errors.NoSuchFile(fullpath)
692
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
693
"""Add revision_id as a parent.
695
This is equivalent to retrieving the current list of parent ids
696
and setting the list to its value plus revision_id.
698
:param revision_id: The revision id to add to the parent list. It may
699
be a ghost revision as long as its not the first parent to be added,
700
or the allow_leftmost_as_ghost parameter is set True.
701
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
703
parents = self.get_parent_ids() + [revision_id]
704
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
705
or allow_leftmost_as_ghost)
707
@needs_tree_write_lock
708
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
709
"""Add revision_id, tree tuple as a parent.
711
This is equivalent to retrieving the current list of parent trees
712
and setting the list to its value plus parent_tuple. See also
713
add_parent_tree_id - if you only have a parent id available it will be
714
simpler to use that api. If you have the parent already available, using
715
this api is preferred.
717
:param parent_tuple: The (revision id, tree) to add to the parent list.
718
If the revision_id is a ghost, pass None for the tree.
719
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
721
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
722
if len(parent_ids) > 1:
723
# the leftmost may have already been a ghost, preserve that if it
725
allow_leftmost_as_ghost = True
726
self.set_parent_ids(parent_ids,
727
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
729
@needs_tree_write_lock
730
def add_pending_merge(self, *revision_ids):
731
# TODO: Perhaps should check at this point that the
732
# history of the revision is actually present?
733
parents = self.get_parent_ids()
735
for rev_id in revision_ids:
736
if rev_id in parents:
738
parents.append(rev_id)
741
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
743
def path_content_summary(self, path, _lstat=os.lstat,
744
_mapper=osutils.file_kind_from_stat_mode):
745
"""See Tree.path_content_summary."""
746
abspath = self.abspath(path)
748
stat_result = _lstat(abspath)
750
if getattr(e, 'errno', None) == errno.ENOENT:
752
return ('missing', None, None, None)
753
# propagate other errors
755
kind = _mapper(stat_result.st_mode)
757
return self._file_content_summary(path, stat_result)
758
elif kind == 'directory':
759
# perhaps it looks like a plain directory, but it's really a
761
if self._directory_is_tree_reference(path):
762
kind = 'tree-reference'
763
return kind, None, None, None
764
elif kind == 'symlink':
765
target = osutils.readlink(abspath)
766
return ('symlink', None, None, target)
768
return (kind, None, None, None)
770
def _file_content_summary(self, path, stat_result):
771
size = stat_result.st_size
772
executable = self._is_executable_from_path_and_stat(path, stat_result)
773
# try for a stat cache lookup
774
return ('file', size, executable, self._sha_from_stat(
777
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
778
"""Common ghost checking functionality from set_parent_*.
780
This checks that the left hand-parent exists if there are any
783
if len(revision_ids) > 0:
784
leftmost_id = revision_ids[0]
785
if (not allow_leftmost_as_ghost and not
786
self.branch.repository.has_revision(leftmost_id)):
787
raise errors.GhostRevisionUnusableHere(leftmost_id)
789
def _set_merges_from_parent_ids(self, parent_ids):
790
merges = parent_ids[1:]
791
self._transport.put_bytes('pending-merges', '\n'.join(merges),
792
mode=self.bzrdir._get_file_mode())
794
def _filter_parent_ids_by_ancestry(self, revision_ids):
795
"""Check that all merged revisions are proper 'heads'.
797
This will always return the first revision_id, and any merged revisions
800
if len(revision_ids) == 0:
802
graph = self.branch.repository.get_graph()
803
heads = graph.heads(revision_ids)
804
new_revision_ids = revision_ids[:1]
805
for revision_id in revision_ids[1:]:
806
if revision_id in heads and revision_id not in new_revision_ids:
807
new_revision_ids.append(revision_id)
808
if new_revision_ids != revision_ids:
809
trace.mutter('requested to set revision_ids = %s,'
810
' but filtered to %s', revision_ids, new_revision_ids)
811
return new_revision_ids
813
@needs_tree_write_lock
814
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
815
"""Set the parent ids to revision_ids.
817
See also set_parent_trees. This api will try to retrieve the tree data
818
for each element of revision_ids from the trees repository. If you have
819
tree data already available, it is more efficient to use
820
set_parent_trees rather than set_parent_ids. set_parent_ids is however
821
an easier API to use.
823
:param revision_ids: The revision_ids to set as the parent ids of this
824
working tree. Any of these may be ghosts.
826
self._check_parents_for_ghosts(revision_ids,
827
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
828
for revision_id in revision_ids:
829
_mod_revision.check_not_reserved_id(revision_id)
831
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
833
if len(revision_ids) > 0:
834
self.set_last_revision(revision_ids[0])
836
self.set_last_revision(_mod_revision.NULL_REVISION)
838
self._set_merges_from_parent_ids(revision_ids)
840
@needs_tree_write_lock
841
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
842
"""See MutableTree.set_parent_trees."""
843
parent_ids = [rev for (rev, tree) in parents_list]
844
for revision_id in parent_ids:
845
_mod_revision.check_not_reserved_id(revision_id)
847
self._check_parents_for_ghosts(parent_ids,
848
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
850
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
852
if len(parent_ids) == 0:
853
leftmost_parent_id = _mod_revision.NULL_REVISION
854
leftmost_parent_tree = None
856
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
858
if self._change_last_revision(leftmost_parent_id):
859
if leftmost_parent_tree is None:
860
# If we don't have a tree, fall back to reading the
861
# parent tree from the repository.
862
self._cache_basis_inventory(leftmost_parent_id)
864
inv = leftmost_parent_tree.inventory
865
xml = self._create_basis_xml_from_inventory(
866
leftmost_parent_id, inv)
867
self._write_basis_inventory(xml)
868
self._set_merges_from_parent_ids(parent_ids)
870
@needs_tree_write_lock
871
def set_pending_merges(self, rev_list):
872
parents = self.get_parent_ids()
873
leftmost = parents[:1]
874
new_parents = leftmost + rev_list
875
self.set_parent_ids(new_parents)
877
@needs_tree_write_lock
878
def set_merge_modified(self, modified_hashes):
880
for file_id, hash in modified_hashes.iteritems():
881
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
882
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
884
def _sha_from_stat(self, path, stat_result):
885
"""Get a sha digest from the tree's stat cache.
887
The default implementation assumes no stat cache is present.
889
:param path: The path.
890
:param stat_result: The stat result being looked up.
894
def _put_rio(self, filename, stanzas, header):
895
self._must_be_locked()
896
my_file = rio_file(stanzas, header)
897
self._transport.put_file(filename, my_file,
898
mode=self.bzrdir._get_file_mode())
900
@needs_write_lock # because merge pulls data into the branch.
901
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
902
merge_type=None, force=False):
903
"""Merge from a branch into this working tree.
905
:param branch: The branch to merge from.
906
:param to_revision: If non-None, the merge will merge to to_revision,
907
but not beyond it. to_revision does not need to be in the history
908
of the branch when it is supplied. If None, to_revision defaults to
909
branch.last_revision().
911
from bzrlib.merge import Merger, Merge3Merger
912
pb = ui.ui_factory.nested_progress_bar()
914
merger = Merger(self.branch, this_tree=self, pb=pb)
915
merger.pp = ProgressPhase("Merge phase", 5, pb)
916
merger.pp.next_phase()
917
# check that there are no local alterations
918
if not force and self.has_changes():
919
raise errors.UncommittedChanges(self)
920
if to_revision is None:
921
to_revision = _mod_revision.ensure_null(branch.last_revision())
922
merger.other_rev_id = to_revision
923
if _mod_revision.is_null(merger.other_rev_id):
924
raise errors.NoCommits(branch)
925
self.branch.fetch(branch, last_revision=merger.other_rev_id)
926
merger.other_basis = merger.other_rev_id
927
merger.other_tree = self.branch.repository.revision_tree(
929
merger.other_branch = branch
930
merger.pp.next_phase()
931
if from_revision is None:
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
939
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
952
def merge_modified(self):
953
"""Return a dictionary of files modified by a merge.
955
The list is initialized by WorkingTree.set_merge_modified, which is
956
typically called after we make some automatic updates to the tree
959
This returns a map of file_id->sha1, containing only files which are
960
still in the working inventory and have that text hash.
963
hashfile = self._transport.get('merge-hashes')
964
except errors.NoSuchFile:
969
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
raise errors.MergeModifiedFormatError()
971
except StopIteration:
972
raise errors.MergeModifiedFormatError()
973
for s in RioReader(hashfile):
974
# RioReader reads in Unicode, so convert file_ids back to utf8
975
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
976
if file_id not in self.inventory:
978
text_hash = s.get("hash")
979
if text_hash == self.get_file_sha1(file_id):
980
merge_hashes[file_id] = text_hash
986
def mkdir(self, path, file_id=None):
987
"""See MutableTree.mkdir()."""
989
file_id = generate_ids.gen_file_id(os.path.basename(path))
990
os.mkdir(self.abspath(path))
991
self.add(path, file_id, 'directory')
994
def get_symlink_target(self, file_id):
995
abspath = self.id2abspath(file_id)
996
target = osutils.readlink(abspath)
1000
def subsume(self, other_tree):
1001
def add_children(inventory, entry):
1002
for child_entry in entry.children.values():
1003
inventory._byid[child_entry.file_id] = child_entry
1004
if child_entry.kind == 'directory':
1005
add_children(inventory, child_entry)
1006
if other_tree.get_root_id() == self.get_root_id():
1007
raise errors.BadSubsumeSource(self, other_tree,
1008
'Trees have the same root')
1010
other_tree_path = self.relpath(other_tree.basedir)
1011
except errors.PathNotChild:
1012
raise errors.BadSubsumeSource(self, other_tree,
1013
'Tree is not contained by the other')
1014
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1015
if new_root_parent is None:
1016
raise errors.BadSubsumeSource(self, other_tree,
1017
'Parent directory is not versioned.')
1018
# We need to ensure that the result of a fetch will have a
1019
# versionedfile for the other_tree root, and only fetching into
1020
# RepositoryKnit2 guarantees that.
1021
if not self.branch.repository.supports_rich_root():
1022
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1023
other_tree.lock_tree_write()
1025
new_parents = other_tree.get_parent_ids()
1026
other_root = other_tree.inventory.root
1027
other_root.parent_id = new_root_parent
1028
other_root.name = osutils.basename(other_tree_path)
1029
self.inventory.add(other_root)
1030
add_children(self.inventory, other_root)
1031
self._write_inventory(self.inventory)
1032
# normally we don't want to fetch whole repositories, but i think
1033
# here we really do want to consolidate the whole thing.
1034
for parent_id in other_tree.get_parent_ids():
1035
self.branch.fetch(other_tree.branch, parent_id)
1036
self.add_parent_tree_id(parent_id)
1039
other_tree.bzrdir.retire_bzrdir()
1041
def _setup_directory_is_tree_reference(self):
1042
if self._branch.repository._format.supports_tree_reference:
1043
self._directory_is_tree_reference = \
1044
self._directory_may_be_tree_reference
1046
self._directory_is_tree_reference = \
1047
self._directory_is_never_tree_reference
1049
def _directory_is_never_tree_reference(self, relpath):
1052
def _directory_may_be_tree_reference(self, relpath):
1053
# as a special case, if a directory contains control files then
1054
# it's a tree reference, except that the root of the tree is not
1055
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1056
# TODO: We could ask all the control formats whether they
1057
# recognize this directory, but at the moment there's no cheap api
1058
# to do that. Since we probably can only nest bzr checkouts and
1059
# they always use this name it's ok for now. -- mbp 20060306
1061
# FIXME: There is an unhandled case here of a subdirectory
1062
# containing .bzr but not a branch; that will probably blow up
1063
# when you try to commit it. It might happen if there is a
1064
# checkout in a subdirectory. This can be avoided by not adding
1067
@needs_tree_write_lock
1068
def extract(self, file_id, format=None):
1069
"""Extract a subtree from this tree.
1071
A new branch will be created, relative to the path for this tree.
1075
segments = osutils.splitpath(path)
1076
transport = self.branch.bzrdir.root_transport
1077
for name in segments:
1078
transport = transport.clone(name)
1079
transport.ensure_base()
1082
sub_path = self.id2path(file_id)
1083
branch_transport = mkdirs(sub_path)
1085
format = self.bzrdir.cloning_metadir()
1086
branch_transport.ensure_base()
1087
branch_bzrdir = format.initialize_on_transport(branch_transport)
1089
repo = branch_bzrdir.find_repository()
1090
except errors.NoRepositoryPresent:
1091
repo = branch_bzrdir.create_repository()
1092
if not repo.supports_rich_root():
1093
raise errors.RootNotRich()
1094
new_branch = branch_bzrdir.create_branch()
1095
new_branch.pull(self.branch)
1096
for parent_id in self.get_parent_ids():
1097
new_branch.fetch(self.branch, parent_id)
1098
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1099
if tree_transport.base != branch_transport.base:
1100
tree_bzrdir = format.initialize_on_transport(tree_transport)
1101
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
1135
def _kind(self, relpath):
1136
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
1141
Lists, but does not descend into unversioned directories.
1142
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, do not return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
# Convert these into local objects to save lookup times
1158
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
1161
# transport.base ends in a slash, we want the piece
1162
# between the last two slashes
1163
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1165
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
# use a deque and popleft to keep them sorted, or if we use a plain
1181
# list and just reverse() them.
1182
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1185
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1188
f = children.popleft()
1189
## TODO: If we find a subdirectory with its own .bzr
1190
## directory, then that is a separate tree and we
1191
## should exclude it.
1193
# the bzrdir for this tree
1194
if transport_base_dir == f:
1197
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1198
# and 'f' doesn't begin with one, we can do a string op, rather
1199
# than the checks of pathjoin(), all relative paths will have an extra slash
1201
fp = from_dir_relpath + '/' + f
1204
fap = from_dir_abspath + '/' + f
1206
f_ie = inv.get_child(from_dir_id, f)
1209
elif self.is_ignored(fp[1:]):
1212
# we may not have found this file, because of a unicode issue
1213
f_norm, can_access = osutils.normalized_filename(f)
1214
if f == f_norm or not can_access:
1215
# No change, so treat this file normally
1218
# this file can be accessed by a normalized path
1219
# check again if it is versioned
1220
# these lines are repeated here for performance
1222
fp = from_dir_relpath + '/' + f
1223
fap = from_dir_abspath + '/' + f
1224
f_ie = inv.get_child(from_dir_id, f)
1227
elif self.is_ignored(fp[1:]):
1234
# make a last minute entry
1236
yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
yield fp[1:], c, fk, None, fk_entries[fk]()
1241
yield fp[1:], c, fk, None, TreeEntry()
1244
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1257
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1264
to_dir must exist in the inventory.
1266
If to_dir exists and is a directory, the files are moved into
1267
it, keeping their old names.
1269
Note that to_dir is only the last component of the new name;
1270
this doesn't change the directory.
1272
For each entry in from_paths the move mode will be determined
1275
The first mode moves the file in the filesystem and updates the
1276
inventory. The second mode only updates the inventory without
1277
touching the file on the filesystem. This is the new mode introduced
1280
move uses the second mode if 'after == True' and the target is not
1281
versioned but present in the working tree.
1283
move uses the second mode if 'after == False' and the source is
1284
versioned but no longer in the working tree, and the target is not
1285
versioned but present in the working tree.
1287
move uses the first mode if 'after == False' and the source is
1288
versioned and present in the working tree, and the target is not
1289
versioned and not present in the working tree.
1291
Everything else results in an error.
1293
This returns a list of (from_path, to_path) pairs for each
1294
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
1312
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1314
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
1325
to_dir_ie = inv[to_dir_id]
1326
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
1359
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1362
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1466
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
1470
This can change the directory or the filename or both.
1472
rename_one has several 'modes' to work. First, it can rename a physical
1473
file and change the file_id. That is the normal mode. Second, it can
1474
only change the file_id without touching any physical file. This is
1475
the new mode introduced in version 0.15.
1477
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the second mode if 'after == False' and 'from_rel' is
1481
versioned but no longer in the working tree, and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the first mode if 'after == False' and 'from_rel' is
1485
versioned and present in the working tree, and 'to_rel' is not
1486
versioned and not present in the working tree.
1488
Everything else results in an error.
1490
inv = self.inventory
1493
# create rename entries and tuples
1494
from_tail = splitpath(from_rel)[-1]
1495
from_id = inv.path2id(from_rel)
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1508
from_parent_id = from_entry.parent_id
1509
to_dir, to_tail = os.path.split(to_rel)
1510
to_dir_id = inv.path2id(to_dir)
1511
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1513
from_tail=from_tail,
1514
from_parent_id=from_parent_id,
1515
to_rel=to_rel, to_tail=to_tail,
1516
to_parent_id=to_dir_id)
1517
rename_entries.append(rename_entry)
1519
# determine which move mode to use. checks also for movability
1520
rename_entries = self._determine_mv_mode(rename_entries, after)
1522
# check if the target changed directory and if the target directory is
1524
if to_dir_id is None:
1525
raise errors.BzrMoveFailedError(from_rel,to_rel,
1526
errors.NotVersionedError(path=str(to_dir)))
1528
# all checks done. now we can continue with our actual work
1529
mutter('rename_one:\n'
1534
' to_dir_id {%s}\n',
1535
from_id, from_rel, to_rel, to_dir, to_dir_id)
1537
self._move(rename_entries)
1538
self._write_inventory(inv)
1540
class _RenameEntry(object):
1541
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1542
to_rel, to_tail, to_parent_id, only_change_inv=False):
1543
self.from_rel = from_rel
1544
self.from_id = from_id
1545
self.from_tail = from_tail
1546
self.from_parent_id = from_parent_id
1547
self.to_rel = to_rel
1548
self.to_tail = to_tail
1549
self.to_parent_id = to_parent_id
1550
self.only_change_inv = only_change_inv
1554
"""Return all unknown files.
1556
These are files in the working directory that are not versioned or
1557
control files or ignored.
1559
# force the extras method to be fully executed before returning, to
1560
# prevent race conditions with the lock
1562
[subp for subp in self.extras() if not self.is_ignored(subp)])
1564
@needs_tree_write_lock
1565
def unversion(self, file_ids):
1566
"""Remove the file ids in file_ids from the current versioned set.
1568
When a file_id is unversioned, all of its children are automatically
1571
:param file_ids: The file ids to stop versioning.
1572
:raises: NoSuchId if any fileid is not currently versioned.
1574
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
if self._inventory.has_id(file_id):
1579
self._inventory.remove_recursive_id(file_id)
1581
# in the future this should just set a dirty bit to wait for the
1582
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1584
# a read, it is more complex - we need to teach read_inventory
1585
# to know when to read, and when to not read first... and possibly
1586
# to save first when the in memory one may be corrupted.
1587
# so for now, we just only write it if it is indeed dirty.
1589
self._write_inventory(self._inventory)
1591
def _iter_conflicts(self):
1593
for info in self.list_files():
1595
stem = get_conflicted_stem(path)
1598
if stem not in conflicted:
1599
conflicted.add(stem)
1603
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1605
top_pb = ui.ui_factory.nested_progress_bar()
1608
pp = ProgressPhase("Pull phase", 2, top_pb)
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:
1618
repository = self.branch.repository
1619
pb = ui.ui_factory.nested_progress_bar()
1620
basis_tree.lock_read()
1622
new_basis_tree = self.branch.basis_tree()
1629
change_reporter=change_reporter)
1630
if (basis_tree.inventory.root is None and
1631
new_basis_tree.inventory.root is not None):
1632
self.set_root_id(new_basis_tree.get_root_id())
1636
# TODO - dedup parents list with things merged by pull ?
1637
# reuse the revisiontree we merged against to set the new
1639
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1640
# we have to pull the merge trees out again, because
1641
# merge_inner has set the ids. - this corner is not yet
1642
# layered well enough to prevent double handling.
1643
# XXX TODO: Fix the double handling: telling the tree about
1644
# the already known parent data is wasteful.
1645
merges = self.get_parent_ids()[1:]
1646
parent_trees.extend([
1647
(parent, repository.revision_tree(parent)) for
1649
self.set_parent_trees(parent_trees)
1656
def put_file_bytes_non_atomic(self, file_id, bytes):
1657
"""See MutableTree.put_file_bytes_non_atomic."""
1658
stream = file(self.id2abspath(file_id), 'wb')
1663
# TODO: update the hashcache here ?
1666
"""Yield all unversioned files in this WorkingTree.
1668
If there are any unversioned directories then only the directory is
1669
returned, not all its children. But if there are unversioned files
1670
under a versioned subdirectory, they are returned.
1672
Currently returned depth-first, sorted by name within directories.
1673
This is the same order used by 'osutils.walkdirs'.
1675
## TODO: Work from given directory downwards
1676
for path, dir_entry in self.inventory.directories():
1677
# mutter("search for unknowns in %r", path)
1678
dirabs = self.abspath(path)
1679
if not isdir(dirabs):
1680
# e.g. directory deleted
1684
for subf in os.listdir(dirabs):
1685
if self.bzrdir.is_control_filename(subf):
1687
if subf not in dir_entry.children:
1690
can_access) = osutils.normalized_filename(subf)
1691
except UnicodeDecodeError:
1692
path_os_enc = path.encode(osutils._fs_enc)
1693
relpath = path_os_enc + '/' + subf
1694
raise errors.BadFilenameEncoding(relpath,
1696
if subf_norm != subf and can_access:
1697
if subf_norm not in dir_entry.children:
1698
fl.append(subf_norm)
1704
subp = pathjoin(path, subf)
1707
def ignored_files(self):
1708
"""Yield list of PATH, IGNORE_PATTERN"""
1709
for subp in self.extras():
1710
pat = self.is_ignored(subp)
1714
def get_ignore_list(self):
1715
"""Return list of ignore patterns.
1717
Cached in the Tree object after the first call.
1719
ignoreset = getattr(self, '_ignoreset', None)
1720
if ignoreset is not None:
1723
ignore_globs = set()
1724
ignore_globs.update(ignores.get_runtime_ignores())
1725
ignore_globs.update(ignores.get_user_ignores())
1726
if self.has_filename(bzrlib.IGNORE_FILENAME):
1727
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1729
ignore_globs.update(ignores.parse_ignore_file(f))
1732
self._ignoreset = ignore_globs
1735
def _flush_ignore_list_cache(self):
1736
"""Resets the cached ignore list to force a cache rebuild."""
1737
self._ignoreset = None
1738
self._ignoreglobster = None
1740
def is_ignored(self, filename):
1741
r"""Check whether the filename matches an ignore pattern.
1743
Patterns containing '/' or '\' need to match the whole path;
1744
others match against only the last component. Patterns starting
1745
with '!' are ignore exceptions. Exceptions take precedence
1746
over regular patterns and cause the filename to not be ignored.
1748
If the file is ignored, returns the pattern which caused it to
1749
be ignored, otherwise None. So this can simply be used as a
1750
boolean if desired."""
1751
if getattr(self, '_ignoreglobster', None) is None:
1752
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1753
return self._ignoreglobster.match(filename)
1755
def kind(self, file_id):
1756
return file_kind(self.id2abspath(file_id))
1758
def stored_kind(self, file_id):
1759
"""See Tree.stored_kind"""
1760
return self.inventory[file_id].kind
1762
def _comparison_data(self, entry, path):
1763
abspath = self.abspath(path)
1765
stat_value = os.lstat(abspath)
1767
if getattr(e, 'errno', None) == errno.ENOENT:
1774
mode = stat_value.st_mode
1775
kind = osutils.file_kind_from_stat_mode(mode)
1776
if not supports_executable():
1777
executable = entry is not None and entry.executable
1779
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1780
return kind, executable, stat_value
1782
def _file_size(self, entry, stat_value):
1783
return stat_value.st_size
1785
def last_revision(self):
1786
"""Return the last revision of the branch for this tree.
1788
This format tree does not support a separate marker for last-revision
1789
compared to the branch.
1791
See MutableTree.last_revision
1793
return self._last_revision()
1796
def _last_revision(self):
1797
"""helper for get_parent_ids."""
1798
return _mod_revision.ensure_null(self.branch.last_revision())
1800
def is_locked(self):
1801
return self._control_files.is_locked()
1803
def _must_be_locked(self):
1804
if not self.is_locked():
1805
raise errors.ObjectNotLocked(self)
1807
def lock_read(self):
1808
"""See Branch.lock_read, and WorkingTree.unlock."""
1809
if not self.is_locked():
1811
self.branch.lock_read()
1813
return self._control_files.lock_read()
1815
self.branch.unlock()
1818
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1820
if not self.is_locked():
1822
self.branch.lock_read()
1824
return self._control_files.lock_write()
1826
self.branch.unlock()
1829
def lock_write(self):
1830
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1831
if not self.is_locked():
1833
self.branch.lock_write()
1835
return self._control_files.lock_write()
1837
self.branch.unlock()
1840
def get_physical_lock_status(self):
1841
return self._control_files.get_physical_lock_status()
1843
def _basis_inventory_name(self):
1844
return 'basis-inventory-cache'
1846
def _reset_data(self):
1847
"""Reset transient data that cannot be revalidated."""
1848
self._inventory_is_modified = False
1849
f = self._transport.get('inventory')
1851
result = self._deserialize(f)
1854
self._set_inventory(result, dirty=False)
1856
@needs_tree_write_lock
1857
def set_last_revision(self, new_revision):
1858
"""Change the last revision in the working tree."""
1859
if self._change_last_revision(new_revision):
1860
self._cache_basis_inventory(new_revision)
1862
def _change_last_revision(self, new_revision):
1863
"""Template method part of set_last_revision to perform the change.
1865
This is used to allow WorkingTree3 instances to not affect branch
1866
when their last revision is set.
1868
if _mod_revision.is_null(new_revision):
1869
self.branch.set_revision_history([])
1872
self.branch.generate_revision_history(new_revision)
1873
except errors.NoSuchRevision:
1874
# not present in the repo - dont try to set it deeper than the tip
1875
self.branch.set_revision_history([new_revision])
1878
def _write_basis_inventory(self, xml):
1879
"""Write the basis inventory XML to the basis-inventory file"""
1880
path = self._basis_inventory_name()
1882
self._transport.put_file(path, sio,
1883
mode=self.bzrdir._get_file_mode())
1885
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1886
"""Create the text that will be saved in basis-inventory"""
1887
inventory.revision_id = revision_id
1888
return xml7.serializer_v7.write_inventory_to_string(inventory)
1890
def _cache_basis_inventory(self, new_revision):
1891
"""Cache new_revision as the basis inventory."""
1892
# TODO: this should allow the ready-to-use inventory to be passed in,
1893
# as commit already has that ready-to-use [while the format is the
1896
# this double handles the inventory - unpack and repack -
1897
# but is easier to understand. We can/should put a conditional
1898
# in here based on whether the inventory is in the latest format
1899
# - perhaps we should repack all inventories on a repository
1901
# the fast path is to copy the raw xml from the repository. If the
1902
# xml contains 'revision_id="', then we assume the right
1903
# revision_id is set. We must check for this full string, because a
1904
# root node id can legitimately look like 'revision_id' but cannot
1906
xml = self.branch.repository.get_inventory_xml(new_revision)
1907
firstline = xml.split('\n', 1)[0]
1908
if (not 'revision_id="' in firstline or
1909
'format="7"' not in firstline):
1910
inv = self.branch.repository._serializer.read_inventory_from_string(
1912
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1913
self._write_basis_inventory(xml)
1914
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1917
def read_basis_inventory(self):
1918
"""Read the cached basis inventory."""
1919
path = self._basis_inventory_name()
1920
return self._transport.get_bytes(path)
1923
def read_working_inventory(self):
1924
"""Read the working inventory.
1926
:raises errors.InventoryModified: read_working_inventory will fail
1927
when the current in memory inventory has been modified.
1929
# conceptually this should be an implementation detail of the tree.
1930
# XXX: Deprecate this.
1931
# ElementTree does its own conversion from UTF-8, so open in
1933
if self._inventory_is_modified:
1934
raise errors.InventoryModified(self)
1935
f = self._transport.get('inventory')
1937
result = self._deserialize(f)
1940
self._set_inventory(result, dirty=False)
1943
@needs_tree_write_lock
1944
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1946
"""Remove nominated files from the working inventory.
1948
:files: File paths relative to the basedir.
1949
:keep_files: If true, the files will also be kept.
1950
:force: Delete files and directories, even if they are changed and
1951
even if the directories are not empty.
1953
if isinstance(files, basestring):
1959
unknown_nested_files=set()
1961
to_file = sys.stdout
1963
def recurse_directory_to_add_files(directory):
1964
# Recurse directory and add all files
1965
# so we can check if they have changed.
1966
for parent_info, file_infos in\
1967
self.walkdirs(directory):
1968
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1969
# Is it versioned or ignored?
1970
if self.path2id(relpath) or self.is_ignored(relpath):
1971
# Add nested content for deletion.
1972
new_files.add(relpath)
1974
# Files which are not versioned and not ignored
1975
# should be treated as unknown.
1976
unknown_nested_files.add((relpath, None, kind))
1978
for filename in files:
1979
# Get file name into canonical form.
1980
abspath = self.abspath(filename)
1981
filename = self.relpath(abspath)
1982
if len(filename) > 0:
1983
new_files.add(filename)
1984
recurse_directory_to_add_files(filename)
1986
files = list(new_files)
1989
return # nothing to do
1991
# Sort needed to first handle directory content before the directory
1992
files.sort(reverse=True)
1994
# Bail out if we are going to delete files we shouldn't
1995
if not keep_files and not force:
1996
has_changed_files = len(unknown_nested_files) > 0
1997
if not has_changed_files:
1998
for (file_id, path, content_change, versioned, parent_id, name,
1999
kind, executable) in self.iter_changes(self.basis_tree(),
2000
include_unchanged=True, require_versioned=False,
2001
want_unversioned=True, specific_files=files):
2002
if versioned == (False, False):
2003
# The record is unknown ...
2004
if not self.is_ignored(path[1]):
2005
# ... but not ignored
2006
has_changed_files = True
2008
elif content_change and (kind[1] is not None):
2009
# Versioned and changed, but not deleted
2010
has_changed_files = True
2013
if has_changed_files:
2014
# Make delta show ALL applicable changes in error message.
2015
tree_delta = self.changes_from(self.basis_tree(),
2016
require_versioned=False, want_unversioned=True,
2017
specific_files=files)
2018
for unknown_file in unknown_nested_files:
2019
if unknown_file not in tree_delta.unversioned:
2020
tree_delta.unversioned.extend((unknown_file,))
2021
raise errors.BzrRemoveChangedFilesError(tree_delta)
2023
# Build inv_delta and delete files where applicable,
2024
# do this before any modifications to inventory.
2026
fid = self.path2id(f)
2029
message = "%s is not versioned." % (f,)
2032
# having removed it, it must be either ignored or unknown
2033
if self.is_ignored(f):
2037
# XXX: Really should be a more abstract reporter interface
2038
kind_ch = osutils.kind_marker(self.kind(fid))
2039
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2041
inv_delta.append((f, None, fid, None))
2042
message = "removed %s" % (f,)
2045
abs_path = self.abspath(f)
2046
if osutils.lexists(abs_path):
2047
if (osutils.isdir(abs_path) and
2048
len(os.listdir(abs_path)) > 0):
2050
osutils.rmtree(abs_path)
2052
message = "%s is not an empty directory "\
2053
"and won't be deleted." % (f,)
2055
osutils.delete_any(abs_path)
2056
message = "deleted %s" % (f,)
2057
elif message is not None:
2058
# Only care if we haven't done anything yet.
2059
message = "%s does not exist." % (f,)
2061
# Print only one message (if any) per file.
2062
if message is not None:
2064
self.apply_inventory_delta(inv_delta)
2066
@needs_tree_write_lock
2067
def revert(self, filenames=None, old_tree=None, backups=True,
2068
pb=DummyProgress(), report_changes=False):
2069
from bzrlib.conflicts import resolve
2072
symbol_versioning.warn('Using [] to revert all files is deprecated'
2073
' as of bzr 0.91. Please use None (the default) instead.',
2074
DeprecationWarning, stacklevel=2)
2075
if old_tree is None:
2076
basis_tree = self.basis_tree()
2077
basis_tree.lock_read()
2078
old_tree = basis_tree
2082
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2084
if filenames is None and len(self.get_parent_ids()) > 1:
2086
last_revision = self.last_revision()
2087
if last_revision != _mod_revision.NULL_REVISION:
2088
if basis_tree is None:
2089
basis_tree = self.basis_tree()
2090
basis_tree.lock_read()
2091
parent_trees.append((last_revision, basis_tree))
2092
self.set_parent_trees(parent_trees)
2095
resolve(self, filenames, ignore_misses=True, recursive=True)
2097
if basis_tree is not None:
2101
def revision_tree(self, revision_id):
2102
"""See Tree.revision_tree.
2104
WorkingTree can supply revision_trees for the basis revision only
2105
because there is only one cached inventory in the bzr directory.
2107
if revision_id == self.last_revision():
2109
xml = self.read_basis_inventory()
2110
except errors.NoSuchFile:
2114
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2115
# dont use the repository revision_tree api because we want
2116
# to supply the inventory.
2117
if inv.revision_id == revision_id:
2118
return revisiontree.RevisionTree(self.branch.repository,
2120
except errors.BadInventoryFormat:
2122
# raise if there was no inventory, or if we read the wrong inventory.
2123
raise errors.NoSuchRevisionInTree(self, revision_id)
2125
# XXX: This method should be deprecated in favour of taking in a proper
2126
# new Inventory object.
2127
@needs_tree_write_lock
2128
def set_inventory(self, new_inventory_list):
2129
from bzrlib.inventory import (Inventory,
2133
inv = Inventory(self.get_root_id())
2134
for path, file_id, parent, kind in new_inventory_list:
2135
name = os.path.basename(path)
2138
# fixme, there should be a factory function inv,add_??
2139
if kind == 'directory':
2140
inv.add(InventoryDirectory(file_id, name, parent))
2141
elif kind == 'file':
2142
inv.add(InventoryFile(file_id, name, parent))
2143
elif kind == 'symlink':
2144
inv.add(InventoryLink(file_id, name, parent))
2146
raise errors.BzrError("unknown kind %r" % kind)
2147
self._write_inventory(inv)
2149
@needs_tree_write_lock
2150
def set_root_id(self, file_id):
2151
"""Set the root id for this tree."""
2155
'WorkingTree.set_root_id with fileid=None')
2156
file_id = osutils.safe_file_id(file_id)
2157
self._set_root_id(file_id)
2159
def _set_root_id(self, file_id):
2160
"""Set the root id for this tree, in a format specific manner.
2162
:param file_id: The file id to assign to the root. It must not be
2163
present in the current inventory or an error will occur. It must
2164
not be None, but rather a valid file id.
2166
inv = self._inventory
2167
orig_root_id = inv.root.file_id
2168
# TODO: it might be nice to exit early if there was nothing
2169
# to do, saving us from trigger a sync on unlock.
2170
self._inventory_is_modified = True
2171
# we preserve the root inventory entry object, but
2172
# unlinkit from the byid index
2173
del inv._byid[inv.root.file_id]
2174
inv.root.file_id = file_id
2175
# and link it into the index with the new changed id.
2176
inv._byid[inv.root.file_id] = inv.root
2177
# and finally update all children to reference the new id.
2178
# XXX: this should be safe to just look at the root.children
2179
# list, not the WHOLE INVENTORY.
2182
if entry.parent_id == orig_root_id:
2183
entry.parent_id = inv.root.file_id
2186
"""See Branch.unlock.
2188
WorkingTree locking just uses the Branch locking facilities.
2189
This is current because all working trees have an embedded branch
2190
within them. IF in the future, we were to make branch data shareable
2191
between multiple working trees, i.e. via shared storage, then we
2192
would probably want to lock both the local tree, and the branch.
2194
raise NotImplementedError(self.unlock)
2198
def update(self, change_reporter=None, possible_transports=None,
2199
revision=None, old_tip=_marker):
2200
"""Update a working tree along its branch.
2202
This will update the branch if its bound too, which means we have
2203
multiple trees involved:
2205
- The new basis tree of the master.
2206
- The old basis tree of the branch.
2207
- The old basis tree of the working tree.
2208
- The current working tree state.
2210
Pathologically, all three may be different, and non-ancestors of each
2211
other. Conceptually we want to:
2213
- Preserve the wt.basis->wt.state changes
2214
- Transform the wt.basis to the new master basis.
2215
- Apply a merge of the old branch basis to get any 'local' changes from
2217
- Restore the wt.basis->wt.state changes.
2219
There isn't a single operation at the moment to do that, so we:
2220
- Merge current state -> basis tree of the master w.r.t. the old tree
2222
- Do a 'normal' merge of the old branch basis if it is relevant.
2224
:param revision: The target revision to update to. Must be in the
2226
:param old_tip: If branch.update() has already been run, the value it
2227
returned (old tip of the branch or None). _marker is used
2230
if self.branch.get_bound_location() is not None:
2232
update_branch = (old_tip is self._marker)
2234
self.lock_tree_write()
2235
update_branch = False
2238
old_tip = self.branch.update(possible_transports)
2240
if old_tip is self._marker:
2242
return self._update_tree(old_tip, change_reporter, revision)
2246
@needs_tree_write_lock
2247
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2248
"""Update a tree to the master branch.
2250
:param old_tip: if supplied, the previous tip revision the branch,
2251
before it was changed to the master branch's tip.
2253
# here if old_tip is not None, it is the old tip of the branch before
2254
# it was updated from the master branch. This should become a pending
2255
# merge in the working tree to preserve the user existing work. we
2256
# cant set that until we update the working trees last revision to be
2257
# one from the new branch, because it will just get absorbed by the
2258
# parent de-duplication logic.
2260
# We MUST save it even if an error occurs, because otherwise the users
2261
# local work is unreferenced and will appear to have been lost.
2265
last_rev = self.get_parent_ids()[0]
2267
last_rev = _mod_revision.NULL_REVISION
2268
if revision is None:
2269
revision = self.branch.last_revision()
2271
if revision not in self.branch.revision_history():
2272
raise errors.NoSuchRevision(self.branch, revision)
2273
if last_rev != _mod_revision.ensure_null(revision):
2274
# merge tree state up to specified revision.
2275
basis = self.basis_tree()
2278
to_tree = self.branch.repository.revision_tree(revision)
2279
if basis.inventory.root is None:
2280
self.set_root_id(to_tree.get_root_id())
2282
result += merge.merge_inner(
2287
change_reporter=change_reporter)
2288
self.set_last_revision(revision)
2291
# TODO - dedup parents list with things merged by pull ?
2292
# reuse the tree we've updated to to set the basis:
2293
parent_trees = [(revision, to_tree)]
2294
merges = self.get_parent_ids()[1:]
2295
# Ideally we ask the tree for the trees here, that way the working
2296
# tree can decide whether to give us the entire tree or give us a
2297
# lazy initialised tree. dirstate for instance will have the trees
2298
# in ram already, whereas a last-revision + basis-inventory tree
2299
# will not, but also does not need them when setting parents.
2300
for parent in merges:
2301
parent_trees.append(
2302
(parent, self.branch.repository.revision_tree(parent)))
2303
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2304
parent_trees.append(
2305
(old_tip, self.branch.repository.revision_tree(old_tip)))
2306
self.set_parent_trees(parent_trees)
2307
last_rev = parent_trees[0][0]
2309
# the working tree had the same last-revision as the master
2310
# branch did. We may still have pivot local work from the local
2311
# branch into old_tip:
2312
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2313
self.add_parent_tree_id(old_tip)
2314
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2315
and old_tip != last_rev):
2316
# our last revision was not the prior branch last revision
2317
# and we have converted that last revision to a pending merge.
2318
# base is somewhere between the branch tip now
2319
# and the now pending merge
2321
# Since we just modified the working tree and inventory, flush out
2322
# the current state, before we modify it again.
2323
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2324
# requires it only because TreeTransform directly munges the
2325
# inventory and calls tree._write_inventory(). Ultimately we
2326
# should be able to remove this extra flush.
2328
graph = self.branch.repository.get_graph()
2329
base_rev_id = graph.find_unique_lca(revision, old_tip)
2330
base_tree = self.branch.repository.revision_tree(base_rev_id)
2331
other_tree = self.branch.repository.revision_tree(old_tip)
2332
result += merge.merge_inner(
2337
change_reporter=change_reporter)
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
2344
self._hashcache.write()
2346
if e.errno not in (errno.EPERM, errno.EACCES):
2348
# TODO: jam 20061219 Should this be a warning? A single line
2349
# warning might be sufficient to let the user know what
2351
mutter('Could not write hashcache for %s\nError: %s',
2352
self._hashcache.cache_file_name(), e)
2354
@needs_tree_write_lock
2355
def _write_inventory(self, inv):
2356
"""Write inventory as the current inventory."""
2357
self._set_inventory(inv, dirty=True)
2360
def set_conflicts(self, arg):
2361
raise errors.UnsupportedOperation(self.set_conflicts, self)
2363
def add_conflicts(self, arg):
2364
raise errors.UnsupportedOperation(self.add_conflicts, self)
2367
def conflicts(self):
2368
conflicts = _mod_conflicts.ConflictList()
2369
for conflicted in self._iter_conflicts():
2372
if file_kind(self.abspath(conflicted)) != "file":
2374
except errors.NoSuchFile:
2377
for suffix in ('.THIS', '.OTHER'):
2379
kind = file_kind(self.abspath(conflicted+suffix))
2382
except errors.NoSuchFile:
2386
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2387
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2389
file_id=self.path2id(conflicted)))
2392
def walkdirs(self, prefix=""):
2393
"""Walk the directories of this tree.
2395
returns a generator which yields items in the form:
2396
((curren_directory_path, fileid),
2397
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2400
This API returns a generator, which is only valid during the current
2401
tree transaction - within a single lock_read or lock_write duration.
2403
If the tree is not locked, it may cause an error to be raised,
2404
depending on the tree implementation.
2406
disk_top = self.abspath(prefix)
2407
if disk_top.endswith('/'):
2408
disk_top = disk_top[:-1]
2409
top_strip_len = len(disk_top) + 1
2410
inventory_iterator = self._walkdirs(prefix)
2411
disk_iterator = osutils.walkdirs(disk_top, prefix)
2413
current_disk = disk_iterator.next()
2414
disk_finished = False
2416
if not (e.errno == errno.ENOENT or
2417
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2420
disk_finished = True
2422
current_inv = inventory_iterator.next()
2423
inv_finished = False
2424
except StopIteration:
2427
while not inv_finished or not disk_finished:
2429
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
cur_disk_dir_content) = current_disk
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = ((None, None), None)
2434
if not disk_finished:
2435
# strip out .bzr dirs
2436
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
len(cur_disk_dir_content) > 0):
2438
# osutils.walkdirs can be made nicer -
2439
# yield the path-from-prefix rather than the pathjoined
2441
bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2446
# we dont yield the contents of, or, .bzr itself.
2447
del cur_disk_dir_content[bzrdir_loc]
2449
# everything is unknown
2452
# everything is missing
2455
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2457
# disk is before inventory - unknown
2458
dirblock = [(relpath, basename, kind, stat, None, None) for
2459
relpath, basename, kind, stat, top_path in
2460
cur_disk_dir_content]
2461
yield (cur_disk_dir_relpath, None), dirblock
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
# inventory is before disk - missing.
2468
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
for relpath, basename, dkind, stat, fileid, kind in
2471
yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
current_inv = inventory_iterator.next()
2474
except StopIteration:
2477
# versioned present directory
2478
# merge the inventory and disk data together
2480
for relpath, subiterator in itertools.groupby(sorted(
2481
current_inv[1] + cur_disk_dir_content,
2482
key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
path_elements = list(subiterator)
2484
if len(path_elements) == 2:
2485
inv_row, disk_row = path_elements
2486
# versioned, present file
2487
dirblock.append((inv_row[0],
2488
inv_row[1], disk_row[2],
2489
disk_row[3], inv_row[4],
2491
elif len(path_elements[0]) == 5:
2493
dirblock.append((path_elements[0][0],
2494
path_elements[0][1], path_elements[0][2],
2495
path_elements[0][3], None, None))
2496
elif len(path_elements[0]) == 6:
2497
# versioned, absent file.
2498
dirblock.append((path_elements[0][0],
2499
path_elements[0][1], 'unknown', None,
2500
path_elements[0][4], path_elements[0][5]))
2502
raise NotImplementedError('unreachable code')
2503
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
2506
except StopIteration:
2509
current_disk = disk_iterator.next()
2510
except StopIteration:
2511
disk_finished = True
2513
def _walkdirs(self, prefix=""):
2514
"""Walk the directories of this tree.
2516
:prefix: is used as the directrory to start with.
2517
returns a generator which yields items in the form:
2518
((curren_directory_path, fileid),
2519
[(file1_path, file1_name, file1_kind, None, file1_id,
2522
_directory = 'directory'
2523
# get the root in the inventory
2524
inv = self.inventory
2525
top_id = inv.path2id(prefix)
2529
pending = [(prefix, '', _directory, None, top_id, None)]
2532
currentdir = pending.pop()
2533
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2534
top_id = currentdir[4]
2536
relroot = currentdir[0] + '/'
2539
# FIXME: stash the node in pending
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2546
yield (currentdir[0], entry.file_id), dirblock
2547
# push the user specified dirs from dirblock
2548
for dir in reversed(dirblock):
2549
if dir[2] == _directory:
2552
@needs_tree_write_lock
2553
def auto_resolve(self):
2554
"""Automatically resolve text conflicts according to contents.
2556
Only text conflicts are auto_resolvable. Files with no conflict markers
2557
are considered 'resolved', because bzr always puts conflict markers
2558
into files that have text conflicts. The corresponding .THIS .BASE and
2559
.OTHER files are deleted, as per 'resolve'.
2560
:return: a tuple of ConflictLists: (un_resolved, resolved).
2562
un_resolved = _mod_conflicts.ConflictList()
2563
resolved = _mod_conflicts.ConflictList()
2564
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2565
for conflict in self.conflicts():
2566
if (conflict.typestring != 'text conflict' or
2567
self.kind(conflict.file_id) != 'file'):
2568
un_resolved.append(conflict)
2570
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2572
for line in my_file:
2573
if conflict_re.search(line):
2574
un_resolved.append(conflict)
2577
resolved.append(conflict)
2580
resolved.remove_files(self)
2581
self.set_conflicts(un_resolved)
2582
return un_resolved, resolved
2585
def _check(self, references):
2586
"""Check the tree for consistency.
2588
:param references: A dict with keys matching the items returned by
2589
self._get_check_refs(), and values from looking those keys up in
2592
tree_basis = self.basis_tree()
2593
tree_basis.lock_read()
2595
repo_basis = references[('trees', self.last_revision())]
2596
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
raise errors.BzrCheckError(
2598
"Mismatched basis inventory content.")
2603
def _validate(self):
2604
"""Validate internal structures.
2606
This is meant mostly for the test suite. To give it a chance to detect
2607
corruption after actions have occurred. The default implementation is a
2610
:return: None. An exception should be raised if there is an error.
2614
def _get_rules_searcher(self, default_searcher):
2615
"""See Tree._get_rules_searcher."""
2616
if self._rules_searcher is None:
2617
self._rules_searcher = super(WorkingTree,
2618
self)._get_rules_searcher(default_searcher)
2619
return self._rules_searcher
2621
def get_shelf_manager(self):
2622
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
2624
return ShelfManager(self, self._transport)
2627
class WorkingTree2(WorkingTree):
2628
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2631
- uses os locks for locking.
2632
- uses the branch last-revision.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
def lock_tree_write(self):
2651
"""See WorkingTree.lock_tree_write().
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
so lock_tree_write() degrades to lock_write().
2656
self.branch.lock_write()
2658
return self._control_files.lock_write()
2660
self.branch.unlock()
2664
# do non-implementation specific cleanup
2667
# we share control files:
2668
if self._control_files._lock_count == 3:
2669
# _inventory_is_modified is always False during a read lock.
2670
if self._inventory_is_modified:
2672
self._write_hashcache_if_dirty()
2674
# reverse order of locking.
2676
return self._control_files.unlock()
2678
self.branch.unlock()
2681
class WorkingTree3(WorkingTree):
2682
"""This is the Format 3 working tree.
2684
This differs from the base WorkingTree by:
2685
- having its own file lock
2686
- having its own last-revision property.
2688
This is new in bzr 0.8
2692
def _last_revision(self):
2693
"""See Mutable.last_revision."""
2695
return self._transport.get_bytes('last-revision')
2696
except errors.NoSuchFile:
2697
return _mod_revision.NULL_REVISION
2699
def _change_last_revision(self, revision_id):
2700
"""See WorkingTree._change_last_revision."""
2701
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2703
self._transport.delete('last-revision')
2704
except errors.NoSuchFile:
2708
self._transport.put_bytes('last-revision', revision_id,
2709
mode=self.bzrdir._get_file_mode())
2712
def _get_check_refs(self):
2713
"""Return the references needed to perform a check of this tree."""
2714
return [('trees', self.last_revision())]
2716
@needs_tree_write_lock
2717
def set_conflicts(self, conflicts):
2718
self._put_rio('conflicts', conflicts.to_stanzas(),
2721
@needs_tree_write_lock
2722
def add_conflicts(self, new_conflicts):
2723
conflict_set = set(self.conflicts())
2724
conflict_set.update(set(list(new_conflicts)))
2725
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2726
key=_mod_conflicts.Conflict.sort_key)))
2729
def conflicts(self):
2731
confile = self._transport.get('conflicts')
2732
except errors.NoSuchFile:
2733
return _mod_conflicts.ConflictList()
2736
if confile.next() != CONFLICT_HEADER_1 + '\n':
2737
raise errors.ConflictFormatError()
2738
except StopIteration:
2739
raise errors.ConflictFormatError()
2740
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2745
# do non-implementation specific cleanup
2747
if self._control_files._lock_count == 1:
2748
# _inventory_is_modified is always False during a read lock.
2749
if self._inventory_is_modified:
2751
self._write_hashcache_if_dirty()
2752
# reverse order of locking.
2754
return self._control_files.unlock()
2756
self.branch.unlock()
2759
def get_conflicted_stem(path):
2760
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2761
if path.endswith(suffix):
2762
return path[:-len(suffix)]
2765
class WorkingTreeFormat(object):
2766
"""An encapsulation of the initialization and open routines for a format.
2768
Formats provide three things:
2769
* An initialization routine,
2773
Formats are placed in an dict by their format string for reference
2774
during workingtree opening. Its not required that these be instances, they
2775
can be classes themselves with class methods - it simply depends on
2776
whether state is needed for a given format or not.
2778
Once a format is deprecated, just deprecate the initialize and open
2779
methods on the format class. Do not deprecate the object, as the
2780
object will be created every time regardless.
2783
_default_format = None
2784
"""The default format used for new trees."""
2787
"""The known formats."""
2789
requires_rich_root = False
2791
upgrade_recommended = False
2794
def find_format(klass, a_bzrdir):
2795
"""Return the format for the working tree object in a_bzrdir."""
2797
transport = a_bzrdir.get_workingtree_transport(None)
2798
format_string = transport.get_bytes("format")
2799
return klass._formats[format_string]
2800
except errors.NoSuchFile:
2801
raise errors.NoWorkingTree(base=transport.base)
2803
raise errors.UnknownFormatError(format=format_string,
2804
kind="working tree")
2806
def __eq__(self, other):
2807
return self.__class__ is other.__class__
2809
def __ne__(self, other):
2810
return not (self == other)
2813
def get_default_format(klass):
2814
"""Return the current default format."""
2815
return klass._default_format
2817
def get_format_string(self):
2818
"""Return the ASCII format string that identifies this format."""
2819
raise NotImplementedError(self.get_format_string)
2821
def get_format_description(self):
2822
"""Return the short description for this format."""
2823
raise NotImplementedError(self.get_format_description)
2825
def is_supported(self):
2826
"""Is this format supported?
2828
Supported formats can be initialized and opened.
2829
Unsupported formats may not support initialization or committing or
2830
some other features depending on the reason for not being supported.
2834
def supports_content_filtering(self):
2835
"""True if this format supports content filtering."""
2838
def supports_views(self):
2839
"""True if this format supports stored views."""
2843
def register_format(klass, format):
2844
klass._formats[format.get_format_string()] = format
2847
def set_default_format(klass, format):
2848
klass._default_format = format
2851
def unregister_format(klass, format):
2852
del klass._formats[format.get_format_string()]
2855
class WorkingTreeFormat2(WorkingTreeFormat):
2856
"""The second working tree format.
2858
This format modified the hash cache from the format 1 hash cache.
2861
upgrade_recommended = True
2863
def get_format_description(self):
2864
"""See WorkingTreeFormat.get_format_description()."""
2865
return "Working tree format 2"
2867
def _stub_initialize_on_transport(self, transport, file_mode):
2868
"""Workaround: create control files for a remote working tree.
2870
This ensures that it can later be updated and dealt with locally,
2871
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2872
no working tree. (See bug #43064).
2875
inv = inventory.Inventory()
2876
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2878
transport.put_file('inventory', sio, file_mode)
2879
transport.put_bytes('pending-merges', '', file_mode)
2881
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2882
accelerator_tree=None, hardlink=False):
2883
"""See WorkingTreeFormat.initialize()."""
2884
if not isinstance(a_bzrdir.transport, LocalTransport):
2885
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2886
if from_branch is not None:
2887
branch = from_branch
2889
branch = a_bzrdir.open_branch()
2890
if revision_id is None:
2891
revision_id = _mod_revision.ensure_null(branch.last_revision())
2894
branch.generate_revision_history(revision_id)
2897
inv = inventory.Inventory()
2898
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
basis_tree = branch.repository.revision_tree(revision_id)
2905
if basis_tree.inventory.root is not None:
2906
wt.set_root_id(basis_tree.get_root_id())
2907
# set the parent list and cache the basis tree.
2908
if _mod_revision.is_null(revision_id):
2911
parent_trees = [(revision_id, basis_tree)]
2912
wt.set_parent_trees(parent_trees)
2913
transform.build_tree(basis_tree, wt)
2917
super(WorkingTreeFormat2, self).__init__()
2918
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2920
def open(self, a_bzrdir, _found=False):
2921
"""Return the WorkingTree object for a_bzrdir
2923
_found is a private parameter, do not use it. It is used to indicate
2924
if format probing has already been done.
2927
# we are being called directly and must probe.
2928
raise NotImplementedError
2929
if not isinstance(a_bzrdir.transport, LocalTransport):
2930
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2931
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2937
class WorkingTreeFormat3(WorkingTreeFormat):
2938
"""The second working tree format updated to record a format marker.
2941
- exists within a metadir controlling .bzr
2942
- includes an explicit version marker for the workingtree control
2943
files, separate from the BzrDir format
2944
- modifies the hash cache format
2946
- uses a LockDir to guard access for writes.
2949
upgrade_recommended = True
2951
def get_format_string(self):
2952
"""See WorkingTreeFormat.get_format_string()."""
2953
return "Bazaar-NG Working Tree format 3"
2955
def get_format_description(self):
2956
"""See WorkingTreeFormat.get_format_description()."""
2957
return "Working tree format 3"
2959
_lock_file_name = 'lock'
2960
_lock_class = LockDir
2962
_tree_class = WorkingTree3
2964
def __get_matchingbzrdir(self):
2965
return bzrdir.BzrDirMetaFormat1()
2967
_matchingbzrdir = property(__get_matchingbzrdir)
2969
def _open_control_files(self, a_bzrdir):
2970
transport = a_bzrdir.get_workingtree_transport(None)
2971
return LockableFiles(transport, self._lock_file_name,
2974
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2975
accelerator_tree=None, hardlink=False):
2976
"""See WorkingTreeFormat.initialize().
2978
:param revision_id: if supplied, create a working tree at a different
2979
revision than the branch is at.
2980
:param accelerator_tree: A tree which can be used for retrieving file
2981
contents more quickly than the revision tree, i.e. a workingtree.
2982
The revision tree will be used for cases where accelerator_tree's
2983
content is different.
2984
:param hardlink: If true, hard-link files from accelerator_tree,
2987
if not isinstance(a_bzrdir.transport, LocalTransport):
2988
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2989
transport = a_bzrdir.get_workingtree_transport(self)
2990
control_files = self._open_control_files(a_bzrdir)
2991
control_files.create_lock()
2992
control_files.lock_write()
2993
transport.put_bytes('format', self.get_format_string(),
2994
mode=a_bzrdir._get_file_mode())
2995
if from_branch is not None:
2996
branch = from_branch
2998
branch = a_bzrdir.open_branch()
2999
if revision_id is None:
3000
revision_id = _mod_revision.ensure_null(branch.last_revision())
3001
# WorkingTree3 can handle an inventory which has a unique root id.
3002
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3003
# those trees. And because there isn't a format bump inbetween, we
3004
# are maintaining compatibility with older clients.
3005
# inv = Inventory(root_id=gen_root_id())
3006
inv = self._initial_inventory()
3007
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3013
_control_files=control_files)
3014
wt.lock_tree_write()
3016
basis_tree = branch.repository.revision_tree(revision_id)
3017
# only set an explicit root id if there is one to set.
3018
if basis_tree.inventory.root is not None:
3019
wt.set_root_id(basis_tree.get_root_id())
3020
if revision_id == _mod_revision.NULL_REVISION:
3021
wt.set_parent_trees([])
3023
wt.set_parent_trees([(revision_id, basis_tree)])
3024
transform.build_tree(basis_tree, wt)
3026
# Unlock in this order so that the unlock-triggers-flush in
3027
# WorkingTree is given a chance to fire.
3028
control_files.unlock()
3032
def _initial_inventory(self):
3033
return inventory.Inventory()
3036
super(WorkingTreeFormat3, self).__init__()
3038
def open(self, a_bzrdir, _found=False):
3039
"""Return the WorkingTree object for a_bzrdir
3041
_found is a private parameter, do not use it. It is used to indicate
3042
if format probing has already been done.
3045
# we are being called directly and must probe.
3046
raise NotImplementedError
3047
if not isinstance(a_bzrdir.transport, LocalTransport):
3048
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3049
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3052
def _open(self, a_bzrdir, control_files):
3053
"""Open the tree itself.
3055
:param a_bzrdir: the dir for the tree.
3056
:param control_files: the control files for the tree.
3058
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3062
_control_files=control_files)
3065
return self.get_format_string()
3068
__default_format = WorkingTreeFormat6()
3069
WorkingTreeFormat.register_format(__default_format)
3070
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3071
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3072
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3073
WorkingTreeFormat.set_default_format(__default_format)
3074
# formats which have no format string are not discoverable
3075
# and not independently creatable, so are not registered.
3076
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
