1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
class TreeEntry(object):
124
"""An entry that implements the minimum interface used by commands.
126
This needs further inspection, it may be better to have
127
InventoryEntries without ids - though that seems wrong. For now,
128
this is a parallel hierarchy to InventoryEntry, and needs to become
129
one of several things: decorates to that hierarchy, children of, or
131
Another note is that these objects are currently only used when there is
132
no InventoryEntry available - i.e. for unversioned objects.
133
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
136
def __eq__(self, other):
137
# yes, this us ugly, TODO: best practice __eq__ style.
138
return (isinstance(other, TreeEntry)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeDirectory(TreeEntry):
146
"""See TreeEntry. This is a directory in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeDirectory)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeFile(TreeEntry):
157
"""See TreeEntry. This is a regular file in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeFile)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeLink(TreeEntry):
168
"""See TreeEntry. This is a symlink in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeLink)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
179
"""Working copy tree.
181
The inventory is held in the `Branch` working-inventory, and the
182
files are in a directory on disk.
184
It is possible for a `WorkingTree` to have a filename which is
185
not listed in the Inventory and vice versa.
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())
231
# is this scan needed ? it makes things kinda slow.
238
if _inventory is None:
239
# This will be acquired on lock_read() or lock_write()
240
self._inventory_is_modified = False
241
self._inventory = None
243
# the caller of __init__ has provided an inventory,
244
# we assume they know what they are doing - as its only
245
# the Format factory and creation methods that are
246
# permitted to do this.
247
self._set_inventory(_inventory, dirty=False)
248
self._detect_case_handling()
249
self._rules_searcher = None
251
def _detect_case_handling(self):
252
wt_trans = self.bzrdir.get_workingtree_transport(None)
254
wt_trans.stat("FoRMaT")
255
except errors.NoSuchFile:
256
self.case_sensitive = True
258
self.case_sensitive = False
260
self._setup_directory_is_tree_reference()
263
fget=lambda self: self._branch,
264
doc="""The branch this WorkingTree is connected to.
266
This cannot be set - it is reflective of the actual disk structure
267
the working tree has been constructed from.
270
def break_lock(self):
271
"""Break a lock if one is present from another instance.
273
Uses the ui factory to ask for confirmation if the lock may be from
276
This will probe the repository for its lock as well.
278
self._control_files.break_lock()
279
self.branch.break_lock()
281
def requires_rich_root(self):
282
return self._format.requires_rich_root
284
def supports_tree_reference(self):
287
def _set_inventory(self, inv, dirty):
288
"""Set the internal cached inventory.
290
:param inv: The inventory to set.
291
:param dirty: A boolean indicating whether the inventory is the same
292
logical inventory as whats on disk. If True the inventory is not
293
the same and should be written to disk or data will be lost, if
294
False then the inventory is the same as that on disk and any
295
serialisation would be unneeded overhead.
297
self._inventory = inv
298
self._inventory_is_modified = dirty
301
def open(path=None, _unsupported=False):
302
"""Open an existing working tree at path.
306
path = os.path.getcwdu()
307
control = bzrdir.BzrDir.open(path, _unsupported)
308
return control.open_workingtree(_unsupported)
311
def open_containing(path=None):
312
"""Open an existing working tree which has its root about path.
314
This probes for a working tree at path and searches upwards from there.
316
Basically we keep looking up until we find the control directory or
317
run into /. If there isn't one, raises NotBranchError.
318
TODO: give this a new exception.
319
If there is one, it is returned, along with the unused portion of path.
321
:return: The WorkingTree that contains 'path', and the rest of path
324
path = osutils.getcwd()
325
control, relpath = bzrdir.BzrDir.open_containing(path)
327
return control.open_workingtree(), relpath
330
def open_downlevel(path=None):
331
"""Open an unsupported working tree.
333
Only intended for advanced situations like upgrading part of a bzrdir.
335
return WorkingTree.open(path, _unsupported=True)
338
def find_trees(location):
339
def list_current(transport):
340
return [d for d in transport.list_dir('') if d != '.bzr']
341
def evaluate(bzrdir):
343
tree = bzrdir.open_workingtree()
344
except errors.NoWorkingTree:
348
transport = get_transport(location)
349
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
350
list_current=list_current)
351
return [t for t in iterator if t is not None]
353
# should be deprecated - this is slow and in any case treating them as a
354
# container is (we now know) bad style -- mbp 20070302
355
## @deprecated_method(zero_fifteen)
357
"""Iterate through file_ids for this tree.
359
file_ids are in a WorkingTree if they are in the working inventory
360
and the working file exists.
362
inv = self._inventory
363
for path, ie in inv.iter_entries():
364
if osutils.lexists(self.abspath(path)):
367
def all_file_ids(self):
368
"""See Tree.iter_all_file_ids"""
369
return set(self.inventory)
372
return "<%s of %s>" % (self.__class__.__name__,
373
getattr(self, 'basedir', None))
375
def abspath(self, filename):
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling
383
repository.revision_tree(NULL_REVISION).
386
revision_id = self.get_parent_ids()[0]
388
# no parents, return an empty revision tree.
389
# in the future this should return the tree for
390
# 'empty:' - the implicit root empty tree.
391
return self.branch.repository.revision_tree(
392
_mod_revision.NULL_REVISION)
394
return self.revision_tree(revision_id)
395
except errors.NoSuchRevision:
397
# No cached copy available, retrieve from the repository.
398
# FIXME? RBC 20060403 should we cache the inventory locally
401
return self.branch.repository.revision_tree(revision_id)
402
except (errors.RevisionNotPresent, errors.NoSuchRevision):
403
# the basis tree *may* be a ghost or a low level error may have
404
# occured. If the revision is present, its a problem, if its not
406
if self.branch.repository.has_revision(revision_id):
408
# the basis tree is a ghost so return an empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
413
self._flush_ignore_list_cache()
415
def relpath(self, path):
416
"""Return the local path portion from a given path.
418
The path may be absolute or relative. If its a relative path it is
419
interpreted relative to the python current working directory.
421
return osutils.relpath(self.basedir, path)
423
def has_filename(self, filename):
424
return osutils.lexists(self.abspath(filename))
426
def get_file(self, file_id, path=None):
428
path = self.id2path(file_id)
429
return self.get_file_byname(path)
431
def get_file_text(self, file_id):
432
return self.get_file(file_id).read()
434
def get_file_byname(self, filename):
435
return file(self.abspath(filename), 'rb')
438
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
439
"""See Tree.annotate_iter
441
This implementation will use the basis tree implementation if possible.
442
Lines not in the basis are attributed to CURRENT_REVISION
444
If there are pending merges, lines added by those merges will be
445
incorrectly attributed to CURRENT_REVISION (but after committing, the
446
attribution will be correct).
448
basis = self.basis_tree()
451
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
452
require_versioned=True).next()
453
changed_content, kind = changes[2], changes[6]
454
if not changed_content:
455
return basis.annotate_iter(file_id)
459
if kind[0] != 'file':
462
old_lines = list(basis.annotate_iter(file_id))
464
for tree in self.branch.repository.revision_trees(
465
self.get_parent_ids()[1:]):
466
if file_id not in tree:
468
old.append(list(tree.annotate_iter(file_id)))
469
return annotate.reannotate(old, self.get_file(file_id).readlines(),
474
def _get_ancestors(self, default_revision):
475
ancestors = set([default_revision])
476
for parent_id in self.get_parent_ids():
477
ancestors.update(self.branch.repository.get_ancestry(
478
parent_id, topo_sorted=False))
481
def get_parent_ids(self):
482
"""See Tree.get_parent_ids.
484
This implementation reads the pending merges list and last_revision
485
value and uses that to decide what the parents list should be.
487
last_rev = _mod_revision.ensure_null(self._last_revision())
488
if _mod_revision.NULL_REVISION == last_rev:
493
merges_file = self._transport.get('pending-merges')
494
except errors.NoSuchFile:
497
for l in merges_file.readlines():
498
revision_id = l.rstrip('\n')
499
parents.append(revision_id)
503
def get_root_id(self):
504
"""Return the id of this trees root"""
505
return self._inventory.root.file_id
507
def _get_store_filename(self, file_id):
508
## XXX: badly named; this is not in the store at all
509
return self.abspath(self.id2path(file_id))
512
def clone(self, to_bzrdir, revision_id=None):
513
"""Duplicate this working tree into to_bzr, including all state.
515
Specifically modified files are kept as modified, but
516
ignored and unknown files are discarded.
518
If you want to make a new line of development, see bzrdir.sprout()
521
If not None, the cloned tree will have its last revision set to
522
revision, and and difference between the source trees last revision
523
and this one merged in.
525
# assumes the target bzr dir format is compatible.
526
result = to_bzrdir.create_workingtree()
527
self.copy_content_into(result, revision_id)
531
def copy_content_into(self, tree, revision_id=None):
532
"""Copy the current content and user files of this tree into tree."""
533
tree.set_root_id(self.get_root_id())
534
if revision_id is None:
535
merge.transform_tree(tree, self)
537
# TODO now merge from tree.last_revision to revision (to preserve
538
# user local changes)
539
merge.transform_tree(tree, self)
540
tree.set_parent_ids([revision_id])
542
def id2abspath(self, file_id):
543
return self.abspath(self.id2path(file_id))
545
def has_id(self, file_id):
546
# files that have been deleted are excluded
548
if not inv.has_id(file_id):
550
path = inv.id2path(file_id)
551
return osutils.lexists(self.abspath(path))
553
def has_or_had_id(self, file_id):
554
if file_id == self.inventory.root.file_id:
556
return self.inventory.has_id(file_id)
558
__contains__ = has_id
560
def get_file_size(self, file_id):
561
"""See Tree.get_file_size"""
563
return os.path.getsize(self.id2abspath(file_id))
565
if e.errno != errno.ENOENT:
571
def get_file_sha1(self, file_id, path=None, stat_value=None):
573
path = self._inventory.id2path(file_id)
574
return self._hashcache.get_sha1(path, stat_value)
576
def get_file_mtime(self, file_id, path=None):
578
path = self.inventory.id2path(file_id)
579
return os.lstat(self.abspath(path)).st_mtime
581
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
582
file_id = self.path2id(path)
583
return self._inventory[file_id].executable
585
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
586
mode = stat_result.st_mode
587
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
589
if not supports_executable():
590
def is_executable(self, file_id, path=None):
591
return self._inventory[file_id].executable
593
_is_executable_from_path_and_stat = \
594
_is_executable_from_path_and_stat_from_basis
596
def is_executable(self, file_id, path=None):
598
path = self.id2path(file_id)
599
mode = os.lstat(self.abspath(path)).st_mode
600
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
602
_is_executable_from_path_and_stat = \
603
_is_executable_from_path_and_stat_from_stat
605
@needs_tree_write_lock
606
def _add(self, files, ids, kinds):
607
"""See MutableTree._add."""
608
# TODO: Re-adding a file that is removed in the working copy
609
# should probably put it back with the previous ID.
610
# the read and write working inventory should not occur in this
611
# function - they should be part of lock_write and unlock.
613
for f, file_id, kind in zip(files, ids, kinds):
615
inv.add_path(f, kind=kind)
617
inv.add_path(f, kind=kind, file_id=file_id)
618
self._inventory_is_modified = True
620
@needs_tree_write_lock
621
def _gather_kinds(self, files, kinds):
622
"""See MutableTree._gather_kinds."""
623
for pos, f in enumerate(files):
624
if kinds[pos] is None:
625
fullpath = normpath(self.abspath(f))
627
kinds[pos] = file_kind(fullpath)
629
if e.errno == errno.ENOENT:
630
raise errors.NoSuchFile(fullpath)
633
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
634
"""Add revision_id as a parent.
636
This is equivalent to retrieving the current list of parent ids
637
and setting the list to its value plus revision_id.
639
:param revision_id: The revision id to add to the parent list. It may
640
be a ghost revision as long as its not the first parent to be added,
641
or the allow_leftmost_as_ghost parameter is set True.
642
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
644
parents = self.get_parent_ids() + [revision_id]
645
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
646
or allow_leftmost_as_ghost)
648
@needs_tree_write_lock
649
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
650
"""Add revision_id, tree tuple as a parent.
652
This is equivalent to retrieving the current list of parent trees
653
and setting the list to its value plus parent_tuple. See also
654
add_parent_tree_id - if you only have a parent id available it will be
655
simpler to use that api. If you have the parent already available, using
656
this api is preferred.
658
:param parent_tuple: The (revision id, tree) to add to the parent list.
659
If the revision_id is a ghost, pass None for the tree.
660
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
662
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
663
if len(parent_ids) > 1:
664
# the leftmost may have already been a ghost, preserve that if it
666
allow_leftmost_as_ghost = True
667
self.set_parent_ids(parent_ids,
668
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
670
@needs_tree_write_lock
671
def add_pending_merge(self, *revision_ids):
672
# TODO: Perhaps should check at this point that the
673
# history of the revision is actually present?
674
parents = self.get_parent_ids()
676
for rev_id in revision_ids:
677
if rev_id in parents:
679
parents.append(rev_id)
682
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
684
def path_content_summary(self, path, _lstat=os.lstat,
685
_mapper=osutils.file_kind_from_stat_mode):
686
"""See Tree.path_content_summary."""
687
abspath = self.abspath(path)
689
stat_result = _lstat(abspath)
691
if getattr(e, 'errno', None) == errno.ENOENT:
693
return ('missing', None, None, None)
694
# propagate other errors
696
kind = _mapper(stat_result.st_mode)
698
size = stat_result.st_size
699
# try for a stat cache lookup
700
executable = self._is_executable_from_path_and_stat(path, stat_result)
701
return (kind, size, executable, self._sha_from_stat(
703
elif kind == 'directory':
704
# perhaps it looks like a plain directory, but it's really a
706
if self._directory_is_tree_reference(path):
707
kind = 'tree-reference'
708
return kind, None, None, None
709
elif kind == 'symlink':
710
return ('symlink', None, None, os.readlink(abspath))
712
return (kind, None, None, None)
714
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
715
"""Common ghost checking functionality from set_parent_*.
717
This checks that the left hand-parent exists if there are any
720
if len(revision_ids) > 0:
721
leftmost_id = revision_ids[0]
722
if (not allow_leftmost_as_ghost and not
723
self.branch.repository.has_revision(leftmost_id)):
724
raise errors.GhostRevisionUnusableHere(leftmost_id)
726
def _set_merges_from_parent_ids(self, parent_ids):
727
merges = parent_ids[1:]
728
self._transport.put_bytes('pending-merges', '\n'.join(merges),
729
mode=self._control_files._file_mode)
731
def _filter_parent_ids_by_ancestry(self, revision_ids):
732
"""Check that all merged revisions are proper 'heads'.
734
This will always return the first revision_id, and any merged revisions
737
if len(revision_ids) == 0:
739
graph = self.branch.repository.get_graph()
740
heads = graph.heads(revision_ids)
741
new_revision_ids = revision_ids[:1]
742
for revision_id in revision_ids[1:]:
743
if revision_id in heads and revision_id not in new_revision_ids:
744
new_revision_ids.append(revision_id)
745
if new_revision_ids != revision_ids:
746
trace.mutter('requested to set revision_ids = %s,'
747
' but filtered to %s', revision_ids, new_revision_ids)
748
return new_revision_ids
750
@needs_tree_write_lock
751
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
752
"""Set the parent ids to revision_ids.
754
See also set_parent_trees. This api will try to retrieve the tree data
755
for each element of revision_ids from the trees repository. If you have
756
tree data already available, it is more efficient to use
757
set_parent_trees rather than set_parent_ids. set_parent_ids is however
758
an easier API to use.
760
:param revision_ids: The revision_ids to set as the parent ids of this
761
working tree. Any of these may be ghosts.
763
self._check_parents_for_ghosts(revision_ids,
764
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
765
for revision_id in revision_ids:
766
_mod_revision.check_not_reserved_id(revision_id)
768
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
770
if len(revision_ids) > 0:
771
self.set_last_revision(revision_ids[0])
773
self.set_last_revision(_mod_revision.NULL_REVISION)
775
self._set_merges_from_parent_ids(revision_ids)
777
@needs_tree_write_lock
778
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
779
"""See MutableTree.set_parent_trees."""
780
parent_ids = [rev for (rev, tree) in parents_list]
781
for revision_id in parent_ids:
782
_mod_revision.check_not_reserved_id(revision_id)
784
self._check_parents_for_ghosts(parent_ids,
785
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
787
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
789
if len(parent_ids) == 0:
790
leftmost_parent_id = _mod_revision.NULL_REVISION
791
leftmost_parent_tree = None
793
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
795
if self._change_last_revision(leftmost_parent_id):
796
if leftmost_parent_tree is None:
797
# If we don't have a tree, fall back to reading the
798
# parent tree from the repository.
799
self._cache_basis_inventory(leftmost_parent_id)
801
inv = leftmost_parent_tree.inventory
802
xml = self._create_basis_xml_from_inventory(
803
leftmost_parent_id, inv)
804
self._write_basis_inventory(xml)
805
self._set_merges_from_parent_ids(parent_ids)
807
@needs_tree_write_lock
808
def set_pending_merges(self, rev_list):
809
parents = self.get_parent_ids()
810
leftmost = parents[:1]
811
new_parents = leftmost + rev_list
812
self.set_parent_ids(new_parents)
814
@needs_tree_write_lock
815
def set_merge_modified(self, modified_hashes):
817
for file_id, hash in modified_hashes.iteritems():
818
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
819
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
821
def _sha_from_stat(self, path, stat_result):
822
"""Get a sha digest from the tree's stat cache.
824
The default implementation assumes no stat cache is present.
826
:param path: The path.
827
:param stat_result: The stat result being looked up.
831
def _put_rio(self, filename, stanzas, header):
832
self._must_be_locked()
833
my_file = rio_file(stanzas, header)
834
self._transport.put_file(filename, my_file,
835
mode=self._control_files._file_mode)
837
@needs_write_lock # because merge pulls data into the branch.
838
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
840
"""Merge from a branch into this working tree.
842
:param branch: The branch to merge from.
843
:param to_revision: If non-None, the merge will merge to to_revision,
844
but not beyond it. to_revision does not need to be in the history
845
of the branch when it is supplied. If None, to_revision defaults to
846
branch.last_revision().
848
from bzrlib.merge import Merger, Merge3Merger
849
pb = bzrlib.ui.ui_factory.nested_progress_bar()
851
merger = Merger(self.branch, this_tree=self, pb=pb)
852
merger.pp = ProgressPhase("Merge phase", 5, pb)
853
merger.pp.next_phase()
854
# check that there are no
856
merger.check_basis(check_clean=True, require_commits=False)
857
if to_revision is None:
858
to_revision = _mod_revision.ensure_null(branch.last_revision())
859
merger.other_rev_id = to_revision
860
if _mod_revision.is_null(merger.other_rev_id):
861
raise errors.NoCommits(branch)
862
self.branch.fetch(branch, last_revision=merger.other_rev_id)
863
merger.other_basis = merger.other_rev_id
864
merger.other_tree = self.branch.repository.revision_tree(
866
merger.other_branch = branch
867
merger.pp.next_phase()
868
if from_revision is None:
871
merger.set_base_revision(from_revision, branch)
872
if merger.base_rev_id == merger.other_rev_id:
873
raise errors.PointlessMerge
874
merger.backup_files = False
875
if merge_type is None:
876
merger.merge_type = Merge3Merger
878
merger.merge_type = merge_type
879
merger.set_interesting_files(None)
880
merger.show_base = False
881
merger.reprocess = False
882
conflicts = merger.do_merge()
889
def merge_modified(self):
890
"""Return a dictionary of files modified by a merge.
892
The list is initialized by WorkingTree.set_merge_modified, which is
893
typically called after we make some automatic updates to the tree
896
This returns a map of file_id->sha1, containing only files which are
897
still in the working inventory and have that text hash.
900
hashfile = self._transport.get('merge-hashes')
901
except errors.NoSuchFile:
906
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
907
raise errors.MergeModifiedFormatError()
908
except StopIteration:
909
raise errors.MergeModifiedFormatError()
910
for s in RioReader(hashfile):
911
# RioReader reads in Unicode, so convert file_ids back to utf8
912
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
913
if file_id not in self.inventory:
915
text_hash = s.get("hash")
916
if text_hash == self.get_file_sha1(file_id):
917
merge_hashes[file_id] = text_hash
923
def mkdir(self, path, file_id=None):
924
"""See MutableTree.mkdir()."""
926
file_id = generate_ids.gen_file_id(os.path.basename(path))
927
os.mkdir(self.abspath(path))
928
self.add(path, file_id, 'directory')
931
def get_symlink_target(self, file_id):
932
return os.readlink(self.id2abspath(file_id))
935
def subsume(self, other_tree):
936
def add_children(inventory, entry):
937
for child_entry in entry.children.values():
938
inventory._byid[child_entry.file_id] = child_entry
939
if child_entry.kind == 'directory':
940
add_children(inventory, child_entry)
941
if other_tree.get_root_id() == self.get_root_id():
942
raise errors.BadSubsumeSource(self, other_tree,
943
'Trees have the same root')
945
other_tree_path = self.relpath(other_tree.basedir)
946
except errors.PathNotChild:
947
raise errors.BadSubsumeSource(self, other_tree,
948
'Tree is not contained by the other')
949
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
950
if new_root_parent is None:
951
raise errors.BadSubsumeSource(self, other_tree,
952
'Parent directory is not versioned.')
953
# We need to ensure that the result of a fetch will have a
954
# versionedfile for the other_tree root, and only fetching into
955
# RepositoryKnit2 guarantees that.
956
if not self.branch.repository.supports_rich_root():
957
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
958
other_tree.lock_tree_write()
960
new_parents = other_tree.get_parent_ids()
961
other_root = other_tree.inventory.root
962
other_root.parent_id = new_root_parent
963
other_root.name = osutils.basename(other_tree_path)
964
self.inventory.add(other_root)
965
add_children(self.inventory, other_root)
966
self._write_inventory(self.inventory)
967
# normally we don't want to fetch whole repositories, but i think
968
# here we really do want to consolidate the whole thing.
969
for parent_id in other_tree.get_parent_ids():
970
self.branch.fetch(other_tree.branch, parent_id)
971
self.add_parent_tree_id(parent_id)
974
other_tree.bzrdir.retire_bzrdir()
976
def _setup_directory_is_tree_reference(self):
977
if self._branch.repository._format.supports_tree_reference:
978
self._directory_is_tree_reference = \
979
self._directory_may_be_tree_reference
981
self._directory_is_tree_reference = \
982
self._directory_is_never_tree_reference
984
def _directory_is_never_tree_reference(self, relpath):
987
def _directory_may_be_tree_reference(self, relpath):
988
# as a special case, if a directory contains control files then
989
# it's a tree reference, except that the root of the tree is not
990
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
991
# TODO: We could ask all the control formats whether they
992
# recognize this directory, but at the moment there's no cheap api
993
# to do that. Since we probably can only nest bzr checkouts and
994
# they always use this name it's ok for now. -- mbp 20060306
996
# FIXME: There is an unhandled case here of a subdirectory
997
# containing .bzr but not a branch; that will probably blow up
998
# when you try to commit it. It might happen if there is a
999
# checkout in a subdirectory. This can be avoided by not adding
1002
@needs_tree_write_lock
1003
def extract(self, file_id, format=None):
1004
"""Extract a subtree from this tree.
1006
A new branch will be created, relative to the path for this tree.
1010
segments = osutils.splitpath(path)
1011
transport = self.branch.bzrdir.root_transport
1012
for name in segments:
1013
transport = transport.clone(name)
1014
transport.ensure_base()
1017
sub_path = self.id2path(file_id)
1018
branch_transport = mkdirs(sub_path)
1020
format = self.bzrdir.cloning_metadir()
1021
branch_transport.ensure_base()
1022
branch_bzrdir = format.initialize_on_transport(branch_transport)
1024
repo = branch_bzrdir.find_repository()
1025
except errors.NoRepositoryPresent:
1026
repo = branch_bzrdir.create_repository()
1027
if not repo.supports_rich_root():
1028
raise errors.RootNotRich()
1029
new_branch = branch_bzrdir.create_branch()
1030
new_branch.pull(self.branch)
1031
for parent_id in self.get_parent_ids():
1032
new_branch.fetch(self.branch, parent_id)
1033
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1034
if tree_transport.base != branch_transport.base:
1035
tree_bzrdir = format.initialize_on_transport(tree_transport)
1036
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1038
tree_bzrdir = branch_bzrdir
1039
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1040
wt.set_parent_ids(self.get_parent_ids())
1041
my_inv = self.inventory
1042
child_inv = Inventory(root_id=None)
1043
new_root = my_inv[file_id]
1044
my_inv.remove_recursive_id(file_id)
1045
new_root.parent_id = None
1046
child_inv.add(new_root)
1047
self._write_inventory(my_inv)
1048
wt._write_inventory(child_inv)
1051
def _serialize(self, inventory, out_file):
1052
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1055
def _deserialize(selt, in_file):
1056
return xml5.serializer_v5.read_inventory(in_file)
1059
"""Write the in memory inventory to disk."""
1060
# TODO: Maybe this should only write on dirty ?
1061
if self._control_files._lock_mode != 'w':
1062
raise errors.NotWriteLocked(self)
1064
self._serialize(self._inventory, sio)
1066
self._transport.put_file('inventory', sio,
1067
mode=self._control_files._file_mode)
1068
self._inventory_is_modified = False
1070
def _kind(self, relpath):
1071
return osutils.file_kind(self.abspath(relpath))
1073
def list_files(self, include_root=False):
1074
"""Recursively list all files as (path, class, kind, id, entry).
1076
Lists, but does not descend into unversioned directories.
1078
This does not include files that have been deleted in this
1081
Skips the control directory.
1083
# list_files is an iterator, so @needs_read_lock doesn't work properly
1084
# with it. So callers should be careful to always read_lock the tree.
1085
if not self.is_locked():
1086
raise errors.ObjectNotLocked(self)
1088
inv = self.inventory
1089
if include_root is True:
1090
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1091
# Convert these into local objects to save lookup times
1092
pathjoin = osutils.pathjoin
1093
file_kind = self._kind
1095
# transport.base ends in a slash, we want the piece
1096
# between the last two slashes
1097
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1099
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1101
# directory file_id, relative path, absolute path, reverse sorted children
1102
children = os.listdir(self.basedir)
1104
# jam 20060527 The kernel sized tree seems equivalent whether we
1105
# use a deque and popleft to keep them sorted, or if we use a plain
1106
# list and just reverse() them.
1107
children = collections.deque(children)
1108
stack = [(inv.root.file_id, u'', self.basedir, children)]
1110
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1113
f = children.popleft()
1114
## TODO: If we find a subdirectory with its own .bzr
1115
## directory, then that is a separate tree and we
1116
## should exclude it.
1118
# the bzrdir for this tree
1119
if transport_base_dir == f:
1122
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1123
# and 'f' doesn't begin with one, we can do a string op, rather
1124
# than the checks of pathjoin(), all relative paths will have an extra slash
1126
fp = from_dir_relpath + '/' + f
1129
fap = from_dir_abspath + '/' + f
1131
f_ie = inv.get_child(from_dir_id, f)
1134
elif self.is_ignored(fp[1:]):
1137
# we may not have found this file, because of a unicode issue
1138
f_norm, can_access = osutils.normalized_filename(f)
1139
if f == f_norm or not can_access:
1140
# No change, so treat this file normally
1143
# this file can be accessed by a normalized path
1144
# check again if it is versioned
1145
# these lines are repeated here for performance
1147
fp = from_dir_relpath + '/' + f
1148
fap = from_dir_abspath + '/' + f
1149
f_ie = inv.get_child(from_dir_id, f)
1152
elif self.is_ignored(fp[1:]):
1159
# make a last minute entry
1161
yield fp[1:], c, fk, f_ie.file_id, f_ie
1164
yield fp[1:], c, fk, None, fk_entries[fk]()
1166
yield fp[1:], c, fk, None, TreeEntry()
1169
if fk != 'directory':
1172
# But do this child first
1173
new_children = os.listdir(fap)
1175
new_children = collections.deque(new_children)
1176
stack.append((f_ie.file_id, fp, fap, new_children))
1177
# Break out of inner loop,
1178
# so that we start outer loop with child
1181
# if we finished all children, pop it off the stack
1184
@needs_tree_write_lock
1185
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1188
to_dir must exist in the inventory.
1190
If to_dir exists and is a directory, the files are moved into
1191
it, keeping their old names.
1193
Note that to_dir is only the last component of the new name;
1194
this doesn't change the directory.
1196
For each entry in from_paths the move mode will be determined
1199
The first mode moves the file in the filesystem and updates the
1200
inventory. The second mode only updates the inventory without
1201
touching the file on the filesystem. This is the new mode introduced
1204
move uses the second mode if 'after == True' and the target is not
1205
versioned but present in the working tree.
1207
move uses the second mode if 'after == False' and the source is
1208
versioned but no longer in the working tree, and the target is not
1209
versioned but present in the working tree.
1211
move uses the first mode if 'after == False' and the source is
1212
versioned and present in the working tree, and the target is not
1213
versioned and not present in the working tree.
1215
Everything else results in an error.
1217
This returns a list of (from_path, to_path) pairs for each
1218
entry that is moved.
1223
# check for deprecated use of signature
1225
to_dir = kwargs.get('to_name', None)
1227
raise TypeError('You must supply a target directory')
1229
symbol_versioning.warn('The parameter to_name was deprecated'
1230
' in version 0.13. Use to_dir instead',
1233
# check destination directory
1234
if isinstance(from_paths, basestring):
1236
inv = self.inventory
1237
to_abs = self.abspath(to_dir)
1238
if not isdir(to_abs):
1239
raise errors.BzrMoveFailedError('',to_dir,
1240
errors.NotADirectory(to_abs))
1241
if not self.has_filename(to_dir):
1242
raise errors.BzrMoveFailedError('',to_dir,
1243
errors.NotInWorkingDirectory(to_dir))
1244
to_dir_id = inv.path2id(to_dir)
1245
if to_dir_id is None:
1246
raise errors.BzrMoveFailedError('',to_dir,
1247
errors.NotVersionedError(path=str(to_dir)))
1249
to_dir_ie = inv[to_dir_id]
1250
if to_dir_ie.kind != 'directory':
1251
raise errors.BzrMoveFailedError('',to_dir,
1252
errors.NotADirectory(to_abs))
1254
# create rename entries and tuples
1255
for from_rel in from_paths:
1256
from_tail = splitpath(from_rel)[-1]
1257
from_id = inv.path2id(from_rel)
1259
raise errors.BzrMoveFailedError(from_rel,to_dir,
1260
errors.NotVersionedError(path=str(from_rel)))
1262
from_entry = inv[from_id]
1263
from_parent_id = from_entry.parent_id
1264
to_rel = pathjoin(to_dir, from_tail)
1265
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1267
from_tail=from_tail,
1268
from_parent_id=from_parent_id,
1269
to_rel=to_rel, to_tail=from_tail,
1270
to_parent_id=to_dir_id)
1271
rename_entries.append(rename_entry)
1272
rename_tuples.append((from_rel, to_rel))
1274
# determine which move mode to use. checks also for movability
1275
rename_entries = self._determine_mv_mode(rename_entries, after)
1277
original_modified = self._inventory_is_modified
1280
self._inventory_is_modified = True
1281
self._move(rename_entries)
1283
# restore the inventory on error
1284
self._inventory_is_modified = original_modified
1286
self._write_inventory(inv)
1287
return rename_tuples
1289
def _determine_mv_mode(self, rename_entries, after=False):
1290
"""Determines for each from-to pair if both inventory and working tree
1291
or only the inventory has to be changed.
1293
Also does basic plausability tests.
1295
inv = self.inventory
1297
for rename_entry in rename_entries:
1298
# store to local variables for easier reference
1299
from_rel = rename_entry.from_rel
1300
from_id = rename_entry.from_id
1301
to_rel = rename_entry.to_rel
1302
to_id = inv.path2id(to_rel)
1303
only_change_inv = False
1305
# check the inventory for source and destination
1307
raise errors.BzrMoveFailedError(from_rel,to_rel,
1308
errors.NotVersionedError(path=str(from_rel)))
1309
if to_id is not None:
1310
raise errors.BzrMoveFailedError(from_rel,to_rel,
1311
errors.AlreadyVersionedError(path=str(to_rel)))
1313
# try to determine the mode for rename (only change inv or change
1314
# inv and file system)
1316
if not self.has_filename(to_rel):
1317
raise errors.BzrMoveFailedError(from_id,to_rel,
1318
errors.NoSuchFile(path=str(to_rel),
1319
extra="New file has not been created yet"))
1320
only_change_inv = True
1321
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1322
only_change_inv = True
1323
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1324
only_change_inv = False
1325
elif (not self.case_sensitive
1326
and from_rel.lower() == to_rel.lower()
1327
and self.has_filename(from_rel)):
1328
only_change_inv = False
1330
# something is wrong, so lets determine what exactly
1331
if not self.has_filename(from_rel) and \
1332
not self.has_filename(to_rel):
1333
raise errors.BzrRenameFailedError(from_rel,to_rel,
1334
errors.PathsDoNotExist(paths=(str(from_rel),
1337
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1338
rename_entry.only_change_inv = only_change_inv
1339
return rename_entries
1341
def _move(self, rename_entries):
1342
"""Moves a list of files.
1344
Depending on the value of the flag 'only_change_inv', the
1345
file will be moved on the file system or not.
1347
inv = self.inventory
1350
for entry in rename_entries:
1352
self._move_entry(entry)
1354
self._rollback_move(moved)
1358
def _rollback_move(self, moved):
1359
"""Try to rollback a previous move in case of an filesystem error."""
1360
inv = self.inventory
1363
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1364
entry.to_tail, entry.to_parent_id, entry.from_rel,
1365
entry.from_tail, entry.from_parent_id,
1366
entry.only_change_inv))
1367
except errors.BzrMoveFailedError, e:
1368
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1369
" The working tree is in an inconsistent state."
1370
" Please consider doing a 'bzr revert'."
1371
" Error message is: %s" % e)
1373
def _move_entry(self, entry):
1374
inv = self.inventory
1375
from_rel_abs = self.abspath(entry.from_rel)
1376
to_rel_abs = self.abspath(entry.to_rel)
1377
if from_rel_abs == to_rel_abs:
1378
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1379
"Source and target are identical.")
1381
if not entry.only_change_inv:
1383
osutils.rename(from_rel_abs, to_rel_abs)
1385
raise errors.BzrMoveFailedError(entry.from_rel,
1387
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1389
@needs_tree_write_lock
1390
def rename_one(self, from_rel, to_rel, after=False):
1393
This can change the directory or the filename or both.
1395
rename_one has several 'modes' to work. First, it can rename a physical
1396
file and change the file_id. That is the normal mode. Second, it can
1397
only change the file_id without touching any physical file. This is
1398
the new mode introduced in version 0.15.
1400
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1401
versioned but present in the working tree.
1403
rename_one uses the second mode if 'after == False' and 'from_rel' is
1404
versioned but no longer in the working tree, and 'to_rel' is not
1405
versioned but present in the working tree.
1407
rename_one uses the first mode if 'after == False' and 'from_rel' is
1408
versioned and present in the working tree, and 'to_rel' is not
1409
versioned and not present in the working tree.
1411
Everything else results in an error.
1413
inv = self.inventory
1416
# create rename entries and tuples
1417
from_tail = splitpath(from_rel)[-1]
1418
from_id = inv.path2id(from_rel)
1420
raise errors.BzrRenameFailedError(from_rel,to_rel,
1421
errors.NotVersionedError(path=str(from_rel)))
1422
from_entry = inv[from_id]
1423
from_parent_id = from_entry.parent_id
1424
to_dir, to_tail = os.path.split(to_rel)
1425
to_dir_id = inv.path2id(to_dir)
1426
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1428
from_tail=from_tail,
1429
from_parent_id=from_parent_id,
1430
to_rel=to_rel, to_tail=to_tail,
1431
to_parent_id=to_dir_id)
1432
rename_entries.append(rename_entry)
1434
# determine which move mode to use. checks also for movability
1435
rename_entries = self._determine_mv_mode(rename_entries, after)
1437
# check if the target changed directory and if the target directory is
1439
if to_dir_id is None:
1440
raise errors.BzrMoveFailedError(from_rel,to_rel,
1441
errors.NotVersionedError(path=str(to_dir)))
1443
# all checks done. now we can continue with our actual work
1444
mutter('rename_one:\n'
1449
' to_dir_id {%s}\n',
1450
from_id, from_rel, to_rel, to_dir, to_dir_id)
1452
self._move(rename_entries)
1453
self._write_inventory(inv)
1455
class _RenameEntry(object):
1456
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1457
to_rel, to_tail, to_parent_id, only_change_inv=False):
1458
self.from_rel = from_rel
1459
self.from_id = from_id
1460
self.from_tail = from_tail
1461
self.from_parent_id = from_parent_id
1462
self.to_rel = to_rel
1463
self.to_tail = to_tail
1464
self.to_parent_id = to_parent_id
1465
self.only_change_inv = only_change_inv
1469
"""Return all unknown files.
1471
These are files in the working directory that are not versioned or
1472
control files or ignored.
1474
# force the extras method to be fully executed before returning, to
1475
# prevent race conditions with the lock
1477
[subp for subp in self.extras() if not self.is_ignored(subp)])
1479
@needs_tree_write_lock
1480
def unversion(self, file_ids):
1481
"""Remove the file ids in file_ids from the current versioned set.
1483
When a file_id is unversioned, all of its children are automatically
1486
:param file_ids: The file ids to stop versioning.
1487
:raises: NoSuchId if any fileid is not currently versioned.
1489
for file_id in file_ids:
1490
if self._inventory.has_id(file_id):
1491
self._inventory.remove_recursive_id(file_id)
1493
raise errors.NoSuchId(self, file_id)
1495
# in the future this should just set a dirty bit to wait for the
1496
# final unlock. However, until all methods of workingtree start
1497
# with the current in -memory inventory rather than triggering
1498
# a read, it is more complex - we need to teach read_inventory
1499
# to know when to read, and when to not read first... and possibly
1500
# to save first when the in memory one may be corrupted.
1501
# so for now, we just only write it if it is indeed dirty.
1503
self._write_inventory(self._inventory)
1505
def _iter_conflicts(self):
1507
for info in self.list_files():
1509
stem = get_conflicted_stem(path)
1512
if stem not in conflicted:
1513
conflicted.add(stem)
1517
def pull(self, source, overwrite=False, stop_revision=None,
1518
change_reporter=None, possible_transports=None):
1519
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1522
pp = ProgressPhase("Pull phase", 2, top_pb)
1524
old_revision_info = self.branch.last_revision_info()
1525
basis_tree = self.basis_tree()
1526
count = self.branch.pull(source, overwrite, stop_revision,
1527
possible_transports=possible_transports)
1528
new_revision_info = self.branch.last_revision_info()
1529
if new_revision_info != old_revision_info:
1531
repository = self.branch.repository
1532
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1533
basis_tree.lock_read()
1535
new_basis_tree = self.branch.basis_tree()
1542
change_reporter=change_reporter)
1543
if (basis_tree.inventory.root is None and
1544
new_basis_tree.inventory.root is not None):
1545
self.set_root_id(new_basis_tree.get_root_id())
1549
# TODO - dedup parents list with things merged by pull ?
1550
# reuse the revisiontree we merged against to set the new
1552
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1553
# we have to pull the merge trees out again, because
1554
# merge_inner has set the ids. - this corner is not yet
1555
# layered well enough to prevent double handling.
1556
# XXX TODO: Fix the double handling: telling the tree about
1557
# the already known parent data is wasteful.
1558
merges = self.get_parent_ids()[1:]
1559
parent_trees.extend([
1560
(parent, repository.revision_tree(parent)) for
1562
self.set_parent_trees(parent_trees)
1569
def put_file_bytes_non_atomic(self, file_id, bytes):
1570
"""See MutableTree.put_file_bytes_non_atomic."""
1571
stream = file(self.id2abspath(file_id), 'wb')
1576
# TODO: update the hashcache here ?
1579
"""Yield all unversioned files in this WorkingTree.
1581
If there are any unversioned directories then only the directory is
1582
returned, not all its children. But if there are unversioned files
1583
under a versioned subdirectory, they are returned.
1585
Currently returned depth-first, sorted by name within directories.
1586
This is the same order used by 'osutils.walkdirs'.
1588
## TODO: Work from given directory downwards
1589
for path, dir_entry in self.inventory.directories():
1590
# mutter("search for unknowns in %r", path)
1591
dirabs = self.abspath(path)
1592
if not isdir(dirabs):
1593
# e.g. directory deleted
1597
for subf in os.listdir(dirabs):
1600
if subf not in dir_entry.children:
1603
can_access) = osutils.normalized_filename(subf)
1604
except UnicodeDecodeError:
1605
path_os_enc = path.encode(osutils._fs_enc)
1606
relpath = path_os_enc + '/' + subf
1607
raise errors.BadFilenameEncoding(relpath,
1609
if subf_norm != subf and can_access:
1610
if subf_norm not in dir_entry.children:
1611
fl.append(subf_norm)
1617
subp = pathjoin(path, subf)
1620
def ignored_files(self):
1621
"""Yield list of PATH, IGNORE_PATTERN"""
1622
for subp in self.extras():
1623
pat = self.is_ignored(subp)
1627
def get_ignore_list(self):
1628
"""Return list of ignore patterns.
1630
Cached in the Tree object after the first call.
1632
ignoreset = getattr(self, '_ignoreset', None)
1633
if ignoreset is not None:
1636
ignore_globs = set()
1637
ignore_globs.update(ignores.get_runtime_ignores())
1638
ignore_globs.update(ignores.get_user_ignores())
1639
if self.has_filename(bzrlib.IGNORE_FILENAME):
1640
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1642
ignore_globs.update(ignores.parse_ignore_file(f))
1645
self._ignoreset = ignore_globs
1648
def _flush_ignore_list_cache(self):
1649
"""Resets the cached ignore list to force a cache rebuild."""
1650
self._ignoreset = None
1651
self._ignoreglobster = None
1653
def is_ignored(self, filename):
1654
r"""Check whether the filename matches an ignore pattern.
1656
Patterns containing '/' or '\' need to match the whole path;
1657
others match against only the last component.
1659
If the file is ignored, returns the pattern which caused it to
1660
be ignored, otherwise None. So this can simply be used as a
1661
boolean if desired."""
1662
if getattr(self, '_ignoreglobster', None) is None:
1663
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1664
return self._ignoreglobster.match(filename)
1666
def kind(self, file_id):
1667
return file_kind(self.id2abspath(file_id))
1669
def stored_kind(self, file_id):
1670
"""See Tree.stored_kind"""
1671
return self.inventory[file_id].kind
1673
def _comparison_data(self, entry, path):
1674
abspath = self.abspath(path)
1676
stat_value = os.lstat(abspath)
1678
if getattr(e, 'errno', None) == errno.ENOENT:
1685
mode = stat_value.st_mode
1686
kind = osutils.file_kind_from_stat_mode(mode)
1687
if not supports_executable():
1688
executable = entry is not None and entry.executable
1690
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1691
return kind, executable, stat_value
1693
def _file_size(self, entry, stat_value):
1694
return stat_value.st_size
1696
def last_revision(self):
1697
"""Return the last revision of the branch for this tree.
1699
This format tree does not support a separate marker for last-revision
1700
compared to the branch.
1702
See MutableTree.last_revision
1704
return self._last_revision()
1707
def _last_revision(self):
1708
"""helper for get_parent_ids."""
1709
return _mod_revision.ensure_null(self.branch.last_revision())
1711
def is_locked(self):
1712
return self._control_files.is_locked()
1714
def _must_be_locked(self):
1715
if not self.is_locked():
1716
raise errors.ObjectNotLocked(self)
1718
def lock_read(self):
1719
"""See Branch.lock_read, and WorkingTree.unlock."""
1720
if not self.is_locked():
1722
self.branch.lock_read()
1724
return self._control_files.lock_read()
1726
self.branch.unlock()
1729
def lock_tree_write(self):
1730
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1731
if not self.is_locked():
1733
self.branch.lock_read()
1735
return self._control_files.lock_write()
1737
self.branch.unlock()
1740
def lock_write(self):
1741
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1742
if not self.is_locked():
1744
self.branch.lock_write()
1746
return self._control_files.lock_write()
1748
self.branch.unlock()
1751
def get_physical_lock_status(self):
1752
return self._control_files.get_physical_lock_status()
1754
def _basis_inventory_name(self):
1755
return 'basis-inventory-cache'
1757
def _reset_data(self):
1758
"""Reset transient data that cannot be revalidated."""
1759
self._inventory_is_modified = False
1760
result = self._deserialize(self._transport.get('inventory'))
1761
self._set_inventory(result, dirty=False)
1763
@needs_tree_write_lock
1764
def set_last_revision(self, new_revision):
1765
"""Change the last revision in the working tree."""
1766
if self._change_last_revision(new_revision):
1767
self._cache_basis_inventory(new_revision)
1769
def _change_last_revision(self, new_revision):
1770
"""Template method part of set_last_revision to perform the change.
1772
This is used to allow WorkingTree3 instances to not affect branch
1773
when their last revision is set.
1775
if _mod_revision.is_null(new_revision):
1776
self.branch.set_revision_history([])
1779
self.branch.generate_revision_history(new_revision)
1780
except errors.NoSuchRevision:
1781
# not present in the repo - dont try to set it deeper than the tip
1782
self.branch.set_revision_history([new_revision])
1785
def _write_basis_inventory(self, xml):
1786
"""Write the basis inventory XML to the basis-inventory file"""
1787
path = self._basis_inventory_name()
1789
self._transport.put_file(path, sio,
1790
mode=self._control_files._file_mode)
1792
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1793
"""Create the text that will be saved in basis-inventory"""
1794
inventory.revision_id = revision_id
1795
return xml7.serializer_v7.write_inventory_to_string(inventory)
1797
def _cache_basis_inventory(self, new_revision):
1798
"""Cache new_revision as the basis inventory."""
1799
# TODO: this should allow the ready-to-use inventory to be passed in,
1800
# as commit already has that ready-to-use [while the format is the
1803
# this double handles the inventory - unpack and repack -
1804
# but is easier to understand. We can/should put a conditional
1805
# in here based on whether the inventory is in the latest format
1806
# - perhaps we should repack all inventories on a repository
1808
# the fast path is to copy the raw xml from the repository. If the
1809
# xml contains 'revision_id="', then we assume the right
1810
# revision_id is set. We must check for this full string, because a
1811
# root node id can legitimately look like 'revision_id' but cannot
1813
xml = self.branch.repository.get_inventory_xml(new_revision)
1814
firstline = xml.split('\n', 1)[0]
1815
if (not 'revision_id="' in firstline or
1816
'format="7"' not in firstline):
1817
inv = self.branch.repository.deserialise_inventory(
1819
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1820
self._write_basis_inventory(xml)
1821
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1824
def read_basis_inventory(self):
1825
"""Read the cached basis inventory."""
1826
path = self._basis_inventory_name()
1827
return self._transport.get_bytes(path)
1830
def read_working_inventory(self):
1831
"""Read the working inventory.
1833
:raises errors.InventoryModified: read_working_inventory will fail
1834
when the current in memory inventory has been modified.
1836
# conceptually this should be an implementation detail of the tree.
1837
# XXX: Deprecate this.
1838
# ElementTree does its own conversion from UTF-8, so open in
1840
if self._inventory_is_modified:
1841
raise errors.InventoryModified(self)
1842
result = self._deserialize(self._transport.get('inventory'))
1843
self._set_inventory(result, dirty=False)
1846
@needs_tree_write_lock
1847
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1849
"""Remove nominated files from the working inventory.
1851
:files: File paths relative to the basedir.
1852
:keep_files: If true, the files will also be kept.
1853
:force: Delete files and directories, even if they are changed and
1854
even if the directories are not empty.
1856
if isinstance(files, basestring):
1862
unknown_nested_files=set()
1864
def recurse_directory_to_add_files(directory):
1865
# Recurse directory and add all files
1866
# so we can check if they have changed.
1867
for parent_info, file_infos in\
1868
self.walkdirs(directory):
1869
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1870
# Is it versioned or ignored?
1871
if self.path2id(relpath) or self.is_ignored(relpath):
1872
# Add nested content for deletion.
1873
new_files.add(relpath)
1875
# Files which are not versioned and not ignored
1876
# should be treated as unknown.
1877
unknown_nested_files.add((relpath, None, kind))
1879
for filename in files:
1880
# Get file name into canonical form.
1881
abspath = self.abspath(filename)
1882
filename = self.relpath(abspath)
1883
if len(filename) > 0:
1884
new_files.add(filename)
1885
recurse_directory_to_add_files(filename)
1887
files = list(new_files)
1890
return # nothing to do
1892
# Sort needed to first handle directory content before the directory
1893
files.sort(reverse=True)
1895
# Bail out if we are going to delete files we shouldn't
1896
if not keep_files and not force:
1897
has_changed_files = len(unknown_nested_files) > 0
1898
if not has_changed_files:
1899
for (file_id, path, content_change, versioned, parent_id, name,
1900
kind, executable) in self.iter_changes(self.basis_tree(),
1901
include_unchanged=True, require_versioned=False,
1902
want_unversioned=True, specific_files=files):
1903
if versioned == (False, False):
1904
# The record is unknown ...
1905
if not self.is_ignored(path[1]):
1906
# ... but not ignored
1907
has_changed_files = True
1909
elif content_change and (kind[1] is not None):
1910
# Versioned and changed, but not deleted
1911
has_changed_files = True
1914
if has_changed_files:
1915
# Make delta show ALL applicable changes in error message.
1916
tree_delta = self.changes_from(self.basis_tree(),
1917
require_versioned=False, want_unversioned=True,
1918
specific_files=files)
1919
for unknown_file in unknown_nested_files:
1920
if unknown_file not in tree_delta.unversioned:
1921
tree_delta.unversioned.extend((unknown_file,))
1922
raise errors.BzrRemoveChangedFilesError(tree_delta)
1924
# Build inv_delta and delete files where applicaple,
1925
# do this before any modifications to inventory.
1927
fid = self.path2id(f)
1930
message = "%s is not versioned." % (f,)
1933
# having removed it, it must be either ignored or unknown
1934
if self.is_ignored(f):
1938
textui.show_status(new_status, self.kind(fid), f,
1941
inv_delta.append((f, None, fid, None))
1942
message = "removed %s" % (f,)
1945
abs_path = self.abspath(f)
1946
if osutils.lexists(abs_path):
1947
if (osutils.isdir(abs_path) and
1948
len(os.listdir(abs_path)) > 0):
1950
osutils.rmtree(abs_path)
1952
message = "%s is not an empty directory "\
1953
"and won't be deleted." % (f,)
1955
osutils.delete_any(abs_path)
1956
message = "deleted %s" % (f,)
1957
elif message is not None:
1958
# Only care if we haven't done anything yet.
1959
message = "%s does not exist." % (f,)
1961
# Print only one message (if any) per file.
1962
if message is not None:
1964
self.apply_inventory_delta(inv_delta)
1966
@needs_tree_write_lock
1967
def revert(self, filenames=None, old_tree=None, backups=True,
1968
pb=DummyProgress(), report_changes=False):
1969
from bzrlib.conflicts import resolve
1972
symbol_versioning.warn('Using [] to revert all files is deprecated'
1973
' as of bzr 0.91. Please use None (the default) instead.',
1974
DeprecationWarning, stacklevel=2)
1975
if old_tree is None:
1976
basis_tree = self.basis_tree()
1977
basis_tree.lock_read()
1978
old_tree = basis_tree
1982
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1984
if filenames is None and len(self.get_parent_ids()) > 1:
1986
last_revision = self.last_revision()
1987
if last_revision != NULL_REVISION:
1988
if basis_tree is None:
1989
basis_tree = self.basis_tree()
1990
basis_tree.lock_read()
1991
parent_trees.append((last_revision, basis_tree))
1992
self.set_parent_trees(parent_trees)
1995
resolve(self, filenames, ignore_misses=True, recursive=True)
1997
if basis_tree is not None:
2001
def revision_tree(self, revision_id):
2002
"""See Tree.revision_tree.
2004
WorkingTree can supply revision_trees for the basis revision only
2005
because there is only one cached inventory in the bzr directory.
2007
if revision_id == self.last_revision():
2009
xml = self.read_basis_inventory()
2010
except errors.NoSuchFile:
2014
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2015
# dont use the repository revision_tree api because we want
2016
# to supply the inventory.
2017
if inv.revision_id == revision_id:
2018
return revisiontree.RevisionTree(self.branch.repository,
2020
except errors.BadInventoryFormat:
2022
# raise if there was no inventory, or if we read the wrong inventory.
2023
raise errors.NoSuchRevisionInTree(self, revision_id)
2025
# XXX: This method should be deprecated in favour of taking in a proper
2026
# new Inventory object.
2027
@needs_tree_write_lock
2028
def set_inventory(self, new_inventory_list):
2029
from bzrlib.inventory import (Inventory,
2034
inv = Inventory(self.get_root_id())
2035
for path, file_id, parent, kind in new_inventory_list:
2036
name = os.path.basename(path)
2039
# fixme, there should be a factory function inv,add_??
2040
if kind == 'directory':
2041
inv.add(InventoryDirectory(file_id, name, parent))
2042
elif kind == 'file':
2043
inv.add(InventoryFile(file_id, name, parent))
2044
elif kind == 'symlink':
2045
inv.add(InventoryLink(file_id, name, parent))
2047
raise errors.BzrError("unknown kind %r" % kind)
2048
self._write_inventory(inv)
2050
@needs_tree_write_lock
2051
def set_root_id(self, file_id):
2052
"""Set the root id for this tree."""
2056
'WorkingTree.set_root_id with fileid=None')
2057
file_id = osutils.safe_file_id(file_id)
2058
self._set_root_id(file_id)
2060
def _set_root_id(self, file_id):
2061
"""Set the root id for this tree, in a format specific manner.
2063
:param file_id: The file id to assign to the root. It must not be
2064
present in the current inventory or an error will occur. It must
2065
not be None, but rather a valid file id.
2067
inv = self._inventory
2068
orig_root_id = inv.root.file_id
2069
# TODO: it might be nice to exit early if there was nothing
2070
# to do, saving us from trigger a sync on unlock.
2071
self._inventory_is_modified = True
2072
# we preserve the root inventory entry object, but
2073
# unlinkit from the byid index
2074
del inv._byid[inv.root.file_id]
2075
inv.root.file_id = file_id
2076
# and link it into the index with the new changed id.
2077
inv._byid[inv.root.file_id] = inv.root
2078
# and finally update all children to reference the new id.
2079
# XXX: this should be safe to just look at the root.children
2080
# list, not the WHOLE INVENTORY.
2083
if entry.parent_id == orig_root_id:
2084
entry.parent_id = inv.root.file_id
2087
"""See Branch.unlock.
2089
WorkingTree locking just uses the Branch locking facilities.
2090
This is current because all working trees have an embedded branch
2091
within them. IF in the future, we were to make branch data shareable
2092
between multiple working trees, i.e. via shared storage, then we
2093
would probably want to lock both the local tree, and the branch.
2095
raise NotImplementedError(self.unlock)
2097
def update(self, change_reporter=None, possible_transports=None):
2098
"""Update a working tree along its branch.
2100
This will update the branch if its bound too, which means we have
2101
multiple trees involved:
2103
- The new basis tree of the master.
2104
- The old basis tree of the branch.
2105
- The old basis tree of the working tree.
2106
- The current working tree state.
2108
Pathologically, all three may be different, and non-ancestors of each
2109
other. Conceptually we want to:
2111
- Preserve the wt.basis->wt.state changes
2112
- Transform the wt.basis to the new master basis.
2113
- Apply a merge of the old branch basis to get any 'local' changes from
2115
- Restore the wt.basis->wt.state changes.
2117
There isn't a single operation at the moment to do that, so we:
2118
- Merge current state -> basis tree of the master w.r.t. the old tree
2120
- Do a 'normal' merge of the old branch basis if it is relevant.
2122
if self.branch.get_bound_location() is not None:
2124
update_branch = True
2126
self.lock_tree_write()
2127
update_branch = False
2130
old_tip = self.branch.update(possible_transports)
2133
return self._update_tree(old_tip, change_reporter)
2137
@needs_tree_write_lock
2138
def _update_tree(self, old_tip=None, change_reporter=None):
2139
"""Update a tree to the master branch.
2141
:param old_tip: if supplied, the previous tip revision the branch,
2142
before it was changed to the master branch's tip.
2144
# here if old_tip is not None, it is the old tip of the branch before
2145
# it was updated from the master branch. This should become a pending
2146
# merge in the working tree to preserve the user existing work. we
2147
# cant set that until we update the working trees last revision to be
2148
# one from the new branch, because it will just get absorbed by the
2149
# parent de-duplication logic.
2151
# We MUST save it even if an error occurs, because otherwise the users
2152
# local work is unreferenced and will appear to have been lost.
2156
last_rev = self.get_parent_ids()[0]
2158
last_rev = _mod_revision.NULL_REVISION
2159
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2160
# merge tree state up to new branch tip.
2161
basis = self.basis_tree()
2164
to_tree = self.branch.basis_tree()
2165
if basis.inventory.root is None:
2166
self.set_root_id(to_tree.get_root_id())
2168
result += merge.merge_inner(
2173
change_reporter=change_reporter)
2176
# TODO - dedup parents list with things merged by pull ?
2177
# reuse the tree we've updated to to set the basis:
2178
parent_trees = [(self.branch.last_revision(), to_tree)]
2179
merges = self.get_parent_ids()[1:]
2180
# Ideally we ask the tree for the trees here, that way the working
2181
# tree can decide whether to give us teh entire tree or give us a
2182
# lazy initialised tree. dirstate for instance will have the trees
2183
# in ram already, whereas a last-revision + basis-inventory tree
2184
# will not, but also does not need them when setting parents.
2185
for parent in merges:
2186
parent_trees.append(
2187
(parent, self.branch.repository.revision_tree(parent)))
2188
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2189
parent_trees.append(
2190
(old_tip, self.branch.repository.revision_tree(old_tip)))
2191
self.set_parent_trees(parent_trees)
2192
last_rev = parent_trees[0][0]
2194
# the working tree had the same last-revision as the master
2195
# branch did. We may still have pivot local work from the local
2196
# branch into old_tip:
2197
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2198
self.add_parent_tree_id(old_tip)
2199
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2200
and old_tip != last_rev):
2201
# our last revision was not the prior branch last revision
2202
# and we have converted that last revision to a pending merge.
2203
# base is somewhere between the branch tip now
2204
# and the now pending merge
2206
# Since we just modified the working tree and inventory, flush out
2207
# the current state, before we modify it again.
2208
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2209
# requires it only because TreeTransform directly munges the
2210
# inventory and calls tree._write_inventory(). Ultimately we
2211
# should be able to remove this extra flush.
2213
graph = self.branch.repository.get_graph()
2214
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2216
base_tree = self.branch.repository.revision_tree(base_rev_id)
2217
other_tree = self.branch.repository.revision_tree(old_tip)
2218
result += merge.merge_inner(
2223
change_reporter=change_reporter)
2226
def _write_hashcache_if_dirty(self):
2227
"""Write out the hashcache if it is dirty."""
2228
if self._hashcache.needs_write:
2230
self._hashcache.write()
2232
if e.errno not in (errno.EPERM, errno.EACCES):
2234
# TODO: jam 20061219 Should this be a warning? A single line
2235
# warning might be sufficient to let the user know what
2237
mutter('Could not write hashcache for %s\nError: %s',
2238
self._hashcache.cache_file_name(), e)
2240
@needs_tree_write_lock
2241
def _write_inventory(self, inv):
2242
"""Write inventory as the current inventory."""
2243
self._set_inventory(inv, dirty=True)
2246
def set_conflicts(self, arg):
2247
raise errors.UnsupportedOperation(self.set_conflicts, self)
2249
def add_conflicts(self, arg):
2250
raise errors.UnsupportedOperation(self.add_conflicts, self)
2253
def conflicts(self):
2254
conflicts = _mod_conflicts.ConflictList()
2255
for conflicted in self._iter_conflicts():
2258
if file_kind(self.abspath(conflicted)) != "file":
2260
except errors.NoSuchFile:
2263
for suffix in ('.THIS', '.OTHER'):
2265
kind = file_kind(self.abspath(conflicted+suffix))
2268
except errors.NoSuchFile:
2272
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2273
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2275
file_id=self.path2id(conflicted)))
2278
def walkdirs(self, prefix=""):
2279
"""Walk the directories of this tree.
2281
returns a generator which yields items in the form:
2282
((curren_directory_path, fileid),
2283
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2286
This API returns a generator, which is only valid during the current
2287
tree transaction - within a single lock_read or lock_write duration.
2289
If the tree is not locked, it may cause an error to be raised,
2290
depending on the tree implementation.
2292
disk_top = self.abspath(prefix)
2293
if disk_top.endswith('/'):
2294
disk_top = disk_top[:-1]
2295
top_strip_len = len(disk_top) + 1
2296
inventory_iterator = self._walkdirs(prefix)
2297
disk_iterator = osutils.walkdirs(disk_top, prefix)
2299
current_disk = disk_iterator.next()
2300
disk_finished = False
2302
if not (e.errno == errno.ENOENT or
2303
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2306
disk_finished = True
2308
current_inv = inventory_iterator.next()
2309
inv_finished = False
2310
except StopIteration:
2313
while not inv_finished or not disk_finished:
2315
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2316
cur_disk_dir_content) = current_disk
2318
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2319
cur_disk_dir_content) = ((None, None), None)
2320
if not disk_finished:
2321
# strip out .bzr dirs
2322
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2323
len(cur_disk_dir_content) > 0):
2324
# osutils.walkdirs can be made nicer -
2325
# yield the path-from-prefix rather than the pathjoined
2327
bzrdir_loc = bisect_left(cur_disk_dir_content,
2329
if (bzrdir_loc < len(cur_disk_dir_content)
2330
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2331
# we dont yield the contents of, or, .bzr itself.
2332
del cur_disk_dir_content[bzrdir_loc]
2334
# everything is unknown
2337
# everything is missing
2340
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2342
# disk is before inventory - unknown
2343
dirblock = [(relpath, basename, kind, stat, None, None) for
2344
relpath, basename, kind, stat, top_path in
2345
cur_disk_dir_content]
2346
yield (cur_disk_dir_relpath, None), dirblock
2348
current_disk = disk_iterator.next()
2349
except StopIteration:
2350
disk_finished = True
2352
# inventory is before disk - missing.
2353
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2354
for relpath, basename, dkind, stat, fileid, kind in
2356
yield (current_inv[0][0], current_inv[0][1]), dirblock
2358
current_inv = inventory_iterator.next()
2359
except StopIteration:
2362
# versioned present directory
2363
# merge the inventory and disk data together
2365
for relpath, subiterator in itertools.groupby(sorted(
2366
current_inv[1] + cur_disk_dir_content,
2367
key=operator.itemgetter(0)), operator.itemgetter(1)):
2368
path_elements = list(subiterator)
2369
if len(path_elements) == 2:
2370
inv_row, disk_row = path_elements
2371
# versioned, present file
2372
dirblock.append((inv_row[0],
2373
inv_row[1], disk_row[2],
2374
disk_row[3], inv_row[4],
2376
elif len(path_elements[0]) == 5:
2378
dirblock.append((path_elements[0][0],
2379
path_elements[0][1], path_elements[0][2],
2380
path_elements[0][3], None, None))
2381
elif len(path_elements[0]) == 6:
2382
# versioned, absent file.
2383
dirblock.append((path_elements[0][0],
2384
path_elements[0][1], 'unknown', None,
2385
path_elements[0][4], path_elements[0][5]))
2387
raise NotImplementedError('unreachable code')
2388
yield current_inv[0], dirblock
2390
current_inv = inventory_iterator.next()
2391
except StopIteration:
2394
current_disk = disk_iterator.next()
2395
except StopIteration:
2396
disk_finished = True
2398
def _walkdirs(self, prefix=""):
2399
"""Walk the directories of this tree.
2401
:prefix: is used as the directrory to start with.
2402
returns a generator which yields items in the form:
2403
((curren_directory_path, fileid),
2404
[(file1_path, file1_name, file1_kind, None, file1_id,
2407
_directory = 'directory'
2408
# get the root in the inventory
2409
inv = self.inventory
2410
top_id = inv.path2id(prefix)
2414
pending = [(prefix, '', _directory, None, top_id, None)]
2417
currentdir = pending.pop()
2418
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2419
top_id = currentdir[4]
2421
relroot = currentdir[0] + '/'
2424
# FIXME: stash the node in pending
2426
if entry.kind == 'directory':
2427
for name, child in entry.sorted_children():
2428
dirblock.append((relroot + name, name, child.kind, None,
2429
child.file_id, child.kind
2431
yield (currentdir[0], entry.file_id), dirblock
2432
# push the user specified dirs from dirblock
2433
for dir in reversed(dirblock):
2434
if dir[2] == _directory:
2437
@needs_tree_write_lock
2438
def auto_resolve(self):
2439
"""Automatically resolve text conflicts according to contents.
2441
Only text conflicts are auto_resolvable. Files with no conflict markers
2442
are considered 'resolved', because bzr always puts conflict markers
2443
into files that have text conflicts. The corresponding .THIS .BASE and
2444
.OTHER files are deleted, as per 'resolve'.
2445
:return: a tuple of ConflictLists: (un_resolved, resolved).
2447
un_resolved = _mod_conflicts.ConflictList()
2448
resolved = _mod_conflicts.ConflictList()
2449
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2450
for conflict in self.conflicts():
2451
if (conflict.typestring != 'text conflict' or
2452
self.kind(conflict.file_id) != 'file'):
2453
un_resolved.append(conflict)
2455
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2457
for line in my_file:
2458
if conflict_re.search(line):
2459
un_resolved.append(conflict)
2462
resolved.append(conflict)
2465
resolved.remove_files(self)
2466
self.set_conflicts(un_resolved)
2467
return un_resolved, resolved
2471
tree_basis = self.basis_tree()
2472
tree_basis.lock_read()
2474
repo_basis = self.branch.repository.revision_tree(
2475
self.last_revision())
2476
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2477
raise errors.BzrCheckError(
2478
"Mismatched basis inventory content.")
2483
def _validate(self):
2484
"""Validate internal structures.
2486
This is meant mostly for the test suite. To give it a chance to detect
2487
corruption after actions have occurred. The default implementation is a
2490
:return: None. An exception should be raised if there is an error.
2495
def _get_rules_searcher(self, default_searcher):
2496
"""See Tree._get_rules_searcher."""
2497
if self._rules_searcher is None:
2498
self._rules_searcher = super(WorkingTree,
2499
self)._get_rules_searcher(default_searcher)
2500
return self._rules_searcher
2503
class WorkingTree2(WorkingTree):
2504
"""This is the Format 2 working tree.
2506
This was the first weave based working tree.
2507
- uses os locks for locking.
2508
- uses the branch last-revision.
2511
def __init__(self, *args, **kwargs):
2512
super(WorkingTree2, self).__init__(*args, **kwargs)
2513
# WorkingTree2 has more of a constraint that self._inventory must
2514
# exist. Because this is an older format, we don't mind the overhead
2515
# caused by the extra computation here.
2517
# Newer WorkingTree's should only have self._inventory set when they
2519
if self._inventory is None:
2520
self.read_working_inventory()
2522
def lock_tree_write(self):
2523
"""See WorkingTree.lock_tree_write().
2525
In Format2 WorkingTrees we have a single lock for the branch and tree
2526
so lock_tree_write() degrades to lock_write().
2528
self.branch.lock_write()
2530
return self._control_files.lock_write()
2532
self.branch.unlock()
2536
# do non-implementation specific cleanup
2539
# we share control files:
2540
if self._control_files._lock_count == 3:
2541
# _inventory_is_modified is always False during a read lock.
2542
if self._inventory_is_modified:
2544
self._write_hashcache_if_dirty()
2546
# reverse order of locking.
2548
return self._control_files.unlock()
2550
self.branch.unlock()
2553
class WorkingTree3(WorkingTree):
2554
"""This is the Format 3 working tree.
2556
This differs from the base WorkingTree by:
2557
- having its own file lock
2558
- having its own last-revision property.
2560
This is new in bzr 0.8
2564
def _last_revision(self):
2565
"""See Mutable.last_revision."""
2567
return self._transport.get_bytes('last-revision')
2568
except errors.NoSuchFile:
2569
return _mod_revision.NULL_REVISION
2571
def _change_last_revision(self, revision_id):
2572
"""See WorkingTree._change_last_revision."""
2573
if revision_id is None or revision_id == NULL_REVISION:
2575
self._transport.delete('last-revision')
2576
except errors.NoSuchFile:
2580
self._transport.put_bytes('last-revision', revision_id,
2581
mode=self._control_files._file_mode)
2584
@needs_tree_write_lock
2585
def set_conflicts(self, conflicts):
2586
self._put_rio('conflicts', conflicts.to_stanzas(),
2589
@needs_tree_write_lock
2590
def add_conflicts(self, new_conflicts):
2591
conflict_set = set(self.conflicts())
2592
conflict_set.update(set(list(new_conflicts)))
2593
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2594
key=_mod_conflicts.Conflict.sort_key)))
2597
def conflicts(self):
2599
confile = self._transport.get('conflicts')
2600
except errors.NoSuchFile:
2601
return _mod_conflicts.ConflictList()
2604
if confile.next() != CONFLICT_HEADER_1 + '\n':
2605
raise errors.ConflictFormatError()
2606
except StopIteration:
2607
raise errors.ConflictFormatError()
2608
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2613
# do non-implementation specific cleanup
2615
if self._control_files._lock_count == 1:
2616
# _inventory_is_modified is always False during a read lock.
2617
if self._inventory_is_modified:
2619
self._write_hashcache_if_dirty()
2620
# reverse order of locking.
2622
return self._control_files.unlock()
2624
self.branch.unlock()
2627
def get_conflicted_stem(path):
2628
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2629
if path.endswith(suffix):
2630
return path[:-len(suffix)]
2633
class WorkingTreeFormat(object):
2634
"""An encapsulation of the initialization and open routines for a format.
2636
Formats provide three things:
2637
* An initialization routine,
2641
Formats are placed in an dict by their format string for reference
2642
during workingtree opening. Its not required that these be instances, they
2643
can be classes themselves with class methods - it simply depends on
2644
whether state is needed for a given format or not.
2646
Once a format is deprecated, just deprecate the initialize and open
2647
methods on the format class. Do not deprecate the object, as the
2648
object will be created every time regardless.
2651
_default_format = None
2652
"""The default format used for new trees."""
2655
"""The known formats."""
2657
requires_rich_root = False
2659
upgrade_recommended = False
2662
def find_format(klass, a_bzrdir):
2663
"""Return the format for the working tree object in a_bzrdir."""
2665
transport = a_bzrdir.get_workingtree_transport(None)
2666
format_string = transport.get("format").read()
2667
return klass._formats[format_string]
2668
except errors.NoSuchFile:
2669
raise errors.NoWorkingTree(base=transport.base)
2671
raise errors.UnknownFormatError(format=format_string,
2672
kind="working tree")
2674
def __eq__(self, other):
2675
return self.__class__ is other.__class__
2677
def __ne__(self, other):
2678
return not (self == other)
2681
def get_default_format(klass):
2682
"""Return the current default format."""
2683
return klass._default_format
2685
def get_format_string(self):
2686
"""Return the ASCII format string that identifies this format."""
2687
raise NotImplementedError(self.get_format_string)
2689
def get_format_description(self):
2690
"""Return the short description for this format."""
2691
raise NotImplementedError(self.get_format_description)
2693
def is_supported(self):
2694
"""Is this format supported?
2696
Supported formats can be initialized and opened.
2697
Unsupported formats may not support initialization or committing or
2698
some other features depending on the reason for not being supported.
2703
def register_format(klass, format):
2704
klass._formats[format.get_format_string()] = format
2707
def set_default_format(klass, format):
2708
klass._default_format = format
2711
def unregister_format(klass, format):
2712
del klass._formats[format.get_format_string()]
2715
class WorkingTreeFormat2(WorkingTreeFormat):
2716
"""The second working tree format.
2718
This format modified the hash cache from the format 1 hash cache.
2721
upgrade_recommended = True
2723
def get_format_description(self):
2724
"""See WorkingTreeFormat.get_format_description()."""
2725
return "Working tree format 2"
2727
def _stub_initialize_on_transport(self, transport, file_mode):
2728
"""Workaround: create control files for a remote working tree.
2730
This ensures that it can later be updated and dealt with locally,
2731
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2732
no working tree. (See bug #43064).
2736
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2738
transport.put_file('inventory', sio, file_mode)
2739
transport.put_bytes('pending-merges', '', file_mode)
2741
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2742
accelerator_tree=None, hardlink=False):
2743
"""See WorkingTreeFormat.initialize()."""
2744
if not isinstance(a_bzrdir.transport, LocalTransport):
2745
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2746
if from_branch is not None:
2747
branch = from_branch
2749
branch = a_bzrdir.open_branch()
2750
if revision_id is None:
2751
revision_id = _mod_revision.ensure_null(branch.last_revision())
2754
branch.generate_revision_history(revision_id)
2758
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2764
basis_tree = branch.repository.revision_tree(revision_id)
2765
if basis_tree.inventory.root is not None:
2766
wt.set_root_id(basis_tree.get_root_id())
2767
# set the parent list and cache the basis tree.
2768
if _mod_revision.is_null(revision_id):
2771
parent_trees = [(revision_id, basis_tree)]
2772
wt.set_parent_trees(parent_trees)
2773
transform.build_tree(basis_tree, wt)
2777
super(WorkingTreeFormat2, self).__init__()
2778
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2780
def open(self, a_bzrdir, _found=False):
2781
"""Return the WorkingTree object for a_bzrdir
2783
_found is a private parameter, do not use it. It is used to indicate
2784
if format probing has already been done.
2787
# we are being called directly and must probe.
2788
raise NotImplementedError
2789
if not isinstance(a_bzrdir.transport, LocalTransport):
2790
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2791
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2797
class WorkingTreeFormat3(WorkingTreeFormat):
2798
"""The second working tree format updated to record a format marker.
2801
- exists within a metadir controlling .bzr
2802
- includes an explicit version marker for the workingtree control
2803
files, separate from the BzrDir format
2804
- modifies the hash cache format
2806
- uses a LockDir to guard access for writes.
2809
upgrade_recommended = True
2811
def get_format_string(self):
2812
"""See WorkingTreeFormat.get_format_string()."""
2813
return "Bazaar-NG Working Tree format 3"
2815
def get_format_description(self):
2816
"""See WorkingTreeFormat.get_format_description()."""
2817
return "Working tree format 3"
2819
_lock_file_name = 'lock'
2820
_lock_class = LockDir
2822
_tree_class = WorkingTree3
2824
def __get_matchingbzrdir(self):
2825
return bzrdir.BzrDirMetaFormat1()
2827
_matchingbzrdir = property(__get_matchingbzrdir)
2829
def _open_control_files(self, a_bzrdir):
2830
transport = a_bzrdir.get_workingtree_transport(None)
2831
return LockableFiles(transport, self._lock_file_name,
2834
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2835
accelerator_tree=None, hardlink=False):
2836
"""See WorkingTreeFormat.initialize().
2838
:param revision_id: if supplied, create a working tree at a different
2839
revision than the branch is at.
2840
:param accelerator_tree: A tree which can be used for retrieving file
2841
contents more quickly than the revision tree, i.e. a workingtree.
2842
The revision tree will be used for cases where accelerator_tree's
2843
content is different.
2844
:param hardlink: If true, hard-link files from accelerator_tree,
2847
if not isinstance(a_bzrdir.transport, LocalTransport):
2848
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2849
transport = a_bzrdir.get_workingtree_transport(self)
2850
control_files = self._open_control_files(a_bzrdir)
2851
control_files.create_lock()
2852
control_files.lock_write()
2853
transport.put_bytes('format', self.get_format_string(),
2854
mode=control_files._file_mode)
2855
if from_branch is not None:
2856
branch = from_branch
2858
branch = a_bzrdir.open_branch()
2859
if revision_id is None:
2860
revision_id = _mod_revision.ensure_null(branch.last_revision())
2861
# WorkingTree3 can handle an inventory which has a unique root id.
2862
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2863
# those trees. And because there isn't a format bump inbetween, we
2864
# are maintaining compatibility with older clients.
2865
# inv = Inventory(root_id=gen_root_id())
2866
inv = self._initial_inventory()
2867
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2873
_control_files=control_files)
2874
wt.lock_tree_write()
2876
basis_tree = branch.repository.revision_tree(revision_id)
2877
# only set an explicit root id if there is one to set.
2878
if basis_tree.inventory.root is not None:
2879
wt.set_root_id(basis_tree.get_root_id())
2880
if revision_id == NULL_REVISION:
2881
wt.set_parent_trees([])
2883
wt.set_parent_trees([(revision_id, basis_tree)])
2884
transform.build_tree(basis_tree, wt)
2886
# Unlock in this order so that the unlock-triggers-flush in
2887
# WorkingTree is given a chance to fire.
2888
control_files.unlock()
2892
def _initial_inventory(self):
2896
super(WorkingTreeFormat3, self).__init__()
2898
def open(self, a_bzrdir, _found=False):
2899
"""Return the WorkingTree object for a_bzrdir
2901
_found is a private parameter, do not use it. It is used to indicate
2902
if format probing has already been done.
2905
# we are being called directly and must probe.
2906
raise NotImplementedError
2907
if not isinstance(a_bzrdir.transport, LocalTransport):
2908
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2909
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2912
def _open(self, a_bzrdir, control_files):
2913
"""Open the tree itself.
2915
:param a_bzrdir: the dir for the tree.
2916
:param control_files: the control files for the tree.
2918
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2922
_control_files=control_files)
2925
return self.get_format_string()
2928
__default_format = WorkingTreeFormat4()
2929
WorkingTreeFormat.register_format(__default_format)
2930
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2931
WorkingTreeFormat.set_default_format(__default_format)
2932
# formats which have no format string are not discoverable
2933
# and not independently creatable, so are not registered.
2934
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
