1
# Copyright (C) 2005, 2006, 2007 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,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
273
self.case_sensitive = True
276
fget=lambda self: self._branch,
277
doc="""The branch this WorkingTree is connected to.
279
This cannot be set - it is reflective of the actual disk structure
280
the working tree has been constructed from.
283
def break_lock(self):
284
"""Break a lock if one is present from another instance.
286
Uses the ui factory to ask for confirmation if the lock may be from
289
This will probe the repository for its lock as well.
291
self._control_files.break_lock()
292
self.branch.break_lock()
294
def requires_rich_root(self):
295
return self._format.requires_rich_root
297
def supports_tree_reference(self):
300
def _set_inventory(self, inv, dirty):
301
"""Set the internal cached inventory.
303
:param inv: The inventory to set.
304
:param dirty: A boolean indicating whether the inventory is the same
305
logical inventory as whats on disk. If True the inventory is not
306
the same and should be written to disk or data will be lost, if
307
False then the inventory is the same as that on disk and any
308
serialisation would be unneeded overhead.
310
assert inv.root is not None
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = os.path.getcwdu()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
351
# should be deprecated - this is slow and in any case treating them as a
352
# container is (we now know) bad style -- mbp 20070302
353
## @deprecated_method(zero_fifteen)
355
"""Iterate through file_ids for this tree.
357
file_ids are in a WorkingTree if they are in the working inventory
358
and the working file exists.
360
inv = self._inventory
361
for path, ie in inv.iter_entries():
362
if osutils.lexists(self.abspath(path)):
366
return "<%s of %s>" % (self.__class__.__name__,
367
getattr(self, 'basedir', None))
369
def abspath(self, filename):
370
return pathjoin(self.basedir, filename)
372
def basis_tree(self):
373
"""Return RevisionTree for the current last revision.
375
If the left most parent is a ghost then the returned tree will be an
376
empty tree - one obtained by calling repository.revision_tree(None).
379
revision_id = self.get_parent_ids()[0]
381
# no parents, return an empty revision tree.
382
# in the future this should return the tree for
383
# 'empty:' - the implicit root empty tree.
384
return self.branch.repository.revision_tree(None)
386
return self.revision_tree(revision_id)
387
except errors.NoSuchRevision:
389
# No cached copy available, retrieve from the repository.
390
# FIXME? RBC 20060403 should we cache the inventory locally
393
return self.branch.repository.revision_tree(revision_id)
394
except errors.RevisionNotPresent:
395
# the basis tree *may* be a ghost or a low level error may have
396
# occured. If the revision is present, its a problem, if its not
398
if self.branch.repository.has_revision(revision_id):
400
# the basis tree is a ghost so return an empty tree.
401
return self.branch.repository.revision_tree(None)
404
self._flush_ignore_list_cache()
407
@deprecated_method(zero_eight)
408
def create(branch, directory):
409
"""Create a workingtree for branch at directory.
411
If existing_directory already exists it must have a .bzr directory.
412
If it does not exist, it will be created.
414
This returns a new WorkingTree object for the new checkout.
416
TODO FIXME RBC 20060124 when we have checkout formats in place this
417
should accept an optional revisionid to checkout [and reject this if
418
checking out into the same dir as a pre-checkout-aware branch format.]
420
XXX: When BzrDir is present, these should be created through that
423
warnings.warn('delete WorkingTree.create', stacklevel=3)
424
transport = get_transport(directory)
425
if branch.bzrdir.root_transport.base == transport.base:
427
return branch.bzrdir.create_workingtree()
428
# different directory,
429
# create a branch reference
430
# and now a working tree.
431
raise NotImplementedError
434
@deprecated_method(zero_eight)
435
def create_standalone(directory):
436
"""Create a checkout and a branch and a repo at directory.
438
Directory must exist and be empty.
440
please use BzrDir.create_standalone_workingtree
442
return bzrdir.BzrDir.create_standalone_workingtree(directory)
444
def relpath(self, path):
445
"""Return the local path portion from a given path.
447
The path may be absolute or relative. If its a relative path it is
448
interpreted relative to the python current working directory.
450
return osutils.relpath(self.basedir, path)
452
def has_filename(self, filename):
453
return osutils.lexists(self.abspath(filename))
455
def get_file(self, file_id, path=None):
457
path = self.id2path(file_id)
458
return self.get_file_byname(path)
460
def get_file_text(self, file_id):
461
return self.get_file(file_id).read()
463
def get_file_byname(self, filename):
464
return file(self.abspath(filename), 'rb')
467
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
468
"""See Tree.annotate_iter
470
This implementation will use the basis tree implementation if possible.
471
Lines not in the basis are attributed to CURRENT_REVISION
473
If there are pending merges, lines added by those merges will be
474
incorrectly attributed to CURRENT_REVISION (but after committing, the
475
attribution will be correct).
477
basis = self.basis_tree()
480
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
481
require_versioned=True).next()
482
changed_content, kind = changes[2], changes[6]
483
if not changed_content:
484
return basis.annotate_iter(file_id)
488
if kind[0] != 'file':
491
old_lines = list(basis.annotate_iter(file_id))
493
for tree in self.branch.repository.revision_trees(
494
self.get_parent_ids()[1:]):
495
if file_id not in tree:
497
old.append(list(tree.annotate_iter(file_id)))
498
return annotate.reannotate(old, self.get_file(file_id).readlines(),
503
def _get_ancestors(self, default_revision):
504
ancestors = set([default_revision])
505
for parent_id in self.get_parent_ids():
506
ancestors.update(self.branch.repository.get_ancestry(
507
parent_id, topo_sorted=False))
510
def get_parent_ids(self):
511
"""See Tree.get_parent_ids.
513
This implementation reads the pending merges list and last_revision
514
value and uses that to decide what the parents list should be.
516
last_rev = _mod_revision.ensure_null(self._last_revision())
517
if _mod_revision.NULL_REVISION == last_rev:
522
merges_file = self._control_files.get('pending-merges')
523
except errors.NoSuchFile:
526
for l in merges_file.readlines():
527
revision_id = l.rstrip('\n')
528
parents.append(revision_id)
532
def get_root_id(self):
533
"""Return the id of this trees root"""
534
return self._inventory.root.file_id
536
def _get_store_filename(self, file_id):
537
## XXX: badly named; this is not in the store at all
538
return self.abspath(self.id2path(file_id))
541
def clone(self, to_bzrdir, revision_id=None):
542
"""Duplicate this working tree into to_bzr, including all state.
544
Specifically modified files are kept as modified, but
545
ignored and unknown files are discarded.
547
If you want to make a new line of development, see bzrdir.sprout()
550
If not None, the cloned tree will have its last revision set to
551
revision, and and difference between the source trees last revision
552
and this one merged in.
554
# assumes the target bzr dir format is compatible.
555
result = self._format.initialize(to_bzrdir)
556
self.copy_content_into(result, revision_id)
560
def copy_content_into(self, tree, revision_id=None):
561
"""Copy the current content and user files of this tree into tree."""
562
tree.set_root_id(self.get_root_id())
563
if revision_id is None:
564
merge.transform_tree(tree, self)
566
# TODO now merge from tree.last_revision to revision (to preserve
567
# user local changes)
568
merge.transform_tree(tree, self)
569
tree.set_parent_ids([revision_id])
571
def id2abspath(self, file_id):
572
return self.abspath(self.id2path(file_id))
574
def has_id(self, file_id):
575
# files that have been deleted are excluded
577
if not inv.has_id(file_id):
579
path = inv.id2path(file_id)
580
return osutils.lexists(self.abspath(path))
582
def has_or_had_id(self, file_id):
583
if file_id == self.inventory.root.file_id:
585
return self.inventory.has_id(file_id)
587
__contains__ = has_id
589
def get_file_size(self, file_id):
590
return os.path.getsize(self.id2abspath(file_id))
593
def get_file_sha1(self, file_id, path=None, stat_value=None):
595
path = self._inventory.id2path(file_id)
596
return self._hashcache.get_sha1(path, stat_value)
598
def get_file_mtime(self, file_id, path=None):
600
path = self.inventory.id2path(file_id)
601
return os.lstat(self.abspath(path)).st_mtime
603
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
604
file_id = self.path2id(path)
605
return self._inventory[file_id].executable
607
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
608
mode = stat_result.st_mode
609
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
611
if not supports_executable():
612
def is_executable(self, file_id, path=None):
613
return self._inventory[file_id].executable
615
_is_executable_from_path_and_stat = \
616
_is_executable_from_path_and_stat_from_basis
618
def is_executable(self, file_id, path=None):
620
path = self.id2path(file_id)
621
mode = os.lstat(self.abspath(path)).st_mode
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
_is_executable_from_path_and_stat = \
625
_is_executable_from_path_and_stat_from_stat
627
@needs_tree_write_lock
628
def _add(self, files, ids, kinds):
629
"""See MutableTree._add."""
630
# TODO: Re-adding a file that is removed in the working copy
631
# should probably put it back with the previous ID.
632
# the read and write working inventory should not occur in this
633
# function - they should be part of lock_write and unlock.
635
for f, file_id, kind in zip(files, ids, kinds):
636
assert kind is not None
638
inv.add_path(f, kind=kind)
640
inv.add_path(f, kind=kind, file_id=file_id)
641
self._inventory_is_modified = True
643
@needs_tree_write_lock
644
def _gather_kinds(self, files, kinds):
645
"""See MutableTree._gather_kinds."""
646
for pos, f in enumerate(files):
647
if kinds[pos] is None:
648
fullpath = normpath(self.abspath(f))
650
kinds[pos] = file_kind(fullpath)
652
if e.errno == errno.ENOENT:
653
raise errors.NoSuchFile(fullpath)
656
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
657
"""Add revision_id as a parent.
659
This is equivalent to retrieving the current list of parent ids
660
and setting the list to its value plus revision_id.
662
:param revision_id: The revision id to add to the parent list. It may
663
be a ghost revision as long as its not the first parent to be added,
664
or the allow_leftmost_as_ghost parameter is set True.
665
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
667
parents = self.get_parent_ids() + [revision_id]
668
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
669
or allow_leftmost_as_ghost)
671
@needs_tree_write_lock
672
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
673
"""Add revision_id, tree tuple as a parent.
675
This is equivalent to retrieving the current list of parent trees
676
and setting the list to its value plus parent_tuple. See also
677
add_parent_tree_id - if you only have a parent id available it will be
678
simpler to use that api. If you have the parent already available, using
679
this api is preferred.
681
:param parent_tuple: The (revision id, tree) to add to the parent list.
682
If the revision_id is a ghost, pass None for the tree.
683
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
685
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
686
if len(parent_ids) > 1:
687
# the leftmost may have already been a ghost, preserve that if it
689
allow_leftmost_as_ghost = True
690
self.set_parent_ids(parent_ids,
691
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
693
@needs_tree_write_lock
694
def add_pending_merge(self, *revision_ids):
695
# TODO: Perhaps should check at this point that the
696
# history of the revision is actually present?
697
parents = self.get_parent_ids()
699
for rev_id in revision_ids:
700
if rev_id in parents:
702
parents.append(rev_id)
705
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
707
def path_content_summary(self, path, _lstat=os.lstat,
708
_mapper=osutils.file_kind_from_stat_mode):
709
"""See Tree.path_content_summary."""
710
abspath = self.abspath(path)
712
stat_result = _lstat(abspath)
714
if getattr(e, 'errno', None) == errno.ENOENT:
716
return ('missing', None, None, None)
717
# propagate other errors
719
kind = _mapper(stat_result.st_mode)
721
size = stat_result.st_size
722
# try for a stat cache lookup
723
executable = self._is_executable_from_path_and_stat(path, stat_result)
724
return (kind, size, executable, self._sha_from_stat(
726
elif kind == 'directory':
727
# perhaps it looks like a plain directory, but it's really a
729
if self._directory_is_tree_reference(path):
730
kind = 'tree-reference'
731
return kind, None, None, None
732
elif kind == 'symlink':
733
return ('symlink', None, None, os.readlink(abspath))
735
return (kind, None, None, None)
737
@deprecated_method(zero_eleven)
739
def pending_merges(self):
740
"""Return a list of pending merges.
742
These are revisions that have been merged into the working
743
directory but not yet committed.
745
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
746
instead - which is available on all tree objects.
748
return self.get_parent_ids()[1:]
750
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
751
"""Common ghost checking functionality from set_parent_*.
753
This checks that the left hand-parent exists if there are any
756
if len(revision_ids) > 0:
757
leftmost_id = revision_ids[0]
758
if (not allow_leftmost_as_ghost and not
759
self.branch.repository.has_revision(leftmost_id)):
760
raise errors.GhostRevisionUnusableHere(leftmost_id)
762
def _set_merges_from_parent_ids(self, parent_ids):
763
merges = parent_ids[1:]
764
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
766
@needs_tree_write_lock
767
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
768
"""Set the parent ids to revision_ids.
770
See also set_parent_trees. This api will try to retrieve the tree data
771
for each element of revision_ids from the trees repository. If you have
772
tree data already available, it is more efficient to use
773
set_parent_trees rather than set_parent_ids. set_parent_ids is however
774
an easier API to use.
776
:param revision_ids: The revision_ids to set as the parent ids of this
777
working tree. Any of these may be ghosts.
779
self._check_parents_for_ghosts(revision_ids,
780
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
781
for revision_id in revision_ids:
782
_mod_revision.check_not_reserved_id(revision_id)
784
if len(revision_ids) > 0:
785
self.set_last_revision(revision_ids[0])
787
self.set_last_revision(_mod_revision.NULL_REVISION)
789
self._set_merges_from_parent_ids(revision_ids)
791
@needs_tree_write_lock
792
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
793
"""See MutableTree.set_parent_trees."""
794
parent_ids = [rev for (rev, tree) in parents_list]
795
for revision_id in parent_ids:
796
_mod_revision.check_not_reserved_id(revision_id)
798
self._check_parents_for_ghosts(parent_ids,
799
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
801
if len(parent_ids) == 0:
802
leftmost_parent_id = _mod_revision.NULL_REVISION
803
leftmost_parent_tree = None
805
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
807
if self._change_last_revision(leftmost_parent_id):
808
if leftmost_parent_tree is None:
809
# If we don't have a tree, fall back to reading the
810
# parent tree from the repository.
811
self._cache_basis_inventory(leftmost_parent_id)
813
inv = leftmost_parent_tree.inventory
814
xml = self._create_basis_xml_from_inventory(
815
leftmost_parent_id, inv)
816
self._write_basis_inventory(xml)
817
self._set_merges_from_parent_ids(parent_ids)
819
@needs_tree_write_lock
820
def set_pending_merges(self, rev_list):
821
parents = self.get_parent_ids()
822
leftmost = parents[:1]
823
new_parents = leftmost + rev_list
824
self.set_parent_ids(new_parents)
826
@needs_tree_write_lock
827
def set_merge_modified(self, modified_hashes):
829
for file_id, hash in modified_hashes.iteritems():
830
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
831
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
833
def _sha_from_stat(self, path, stat_result):
834
"""Get a sha digest from the tree's stat cache.
836
The default implementation assumes no stat cache is present.
838
:param path: The path.
839
:param stat_result: The stat result being looked up.
843
def _put_rio(self, filename, stanzas, header):
844
self._must_be_locked()
845
my_file = rio_file(stanzas, header)
846
self._control_files.put(filename, my_file)
848
@needs_write_lock # because merge pulls data into the branch.
849
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
851
"""Merge from a branch into this working tree.
853
:param branch: The branch to merge from.
854
:param to_revision: If non-None, the merge will merge to to_revision,
855
but not beyond it. to_revision does not need to be in the history
856
of the branch when it is supplied. If None, to_revision defaults to
857
branch.last_revision().
859
from bzrlib.merge import Merger, Merge3Merger
860
pb = bzrlib.ui.ui_factory.nested_progress_bar()
862
merger = Merger(self.branch, this_tree=self, pb=pb)
863
merger.pp = ProgressPhase("Merge phase", 5, pb)
864
merger.pp.next_phase()
865
# check that there are no
867
merger.check_basis(check_clean=True, require_commits=False)
868
if to_revision is None:
869
to_revision = _mod_revision.ensure_null(branch.last_revision())
870
merger.other_rev_id = to_revision
871
if _mod_revision.is_null(merger.other_rev_id):
872
raise errors.NoCommits(branch)
873
self.branch.fetch(branch, last_revision=merger.other_rev_id)
874
merger.other_basis = merger.other_rev_id
875
merger.other_tree = self.branch.repository.revision_tree(
877
merger.other_branch = branch
878
merger.pp.next_phase()
879
if from_revision is None:
882
merger.set_base_revision(from_revision, branch)
883
if merger.base_rev_id == merger.other_rev_id:
884
raise errors.PointlessMerge
885
merger.backup_files = False
886
if merge_type is None:
887
merger.merge_type = Merge3Merger
889
merger.merge_type = merge_type
890
merger.set_interesting_files(None)
891
merger.show_base = False
892
merger.reprocess = False
893
conflicts = merger.do_merge()
900
def merge_modified(self):
901
"""Return a dictionary of files modified by a merge.
903
The list is initialized by WorkingTree.set_merge_modified, which is
904
typically called after we make some automatic updates to the tree
907
This returns a map of file_id->sha1, containing only files which are
908
still in the working inventory and have that text hash.
911
hashfile = self._control_files.get('merge-hashes')
912
except errors.NoSuchFile:
916
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
917
raise errors.MergeModifiedFormatError()
918
except StopIteration:
919
raise errors.MergeModifiedFormatError()
920
for s in RioReader(hashfile):
921
# RioReader reads in Unicode, so convert file_ids back to utf8
922
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
923
if file_id not in self.inventory:
925
text_hash = s.get("hash")
926
if text_hash == self.get_file_sha1(file_id):
927
merge_hashes[file_id] = text_hash
931
def mkdir(self, path, file_id=None):
932
"""See MutableTree.mkdir()."""
934
file_id = generate_ids.gen_file_id(os.path.basename(path))
935
os.mkdir(self.abspath(path))
936
self.add(path, file_id, 'directory')
939
def get_symlink_target(self, file_id):
940
return os.readlink(self.id2abspath(file_id))
943
def subsume(self, other_tree):
944
def add_children(inventory, entry):
945
for child_entry in entry.children.values():
946
inventory._byid[child_entry.file_id] = child_entry
947
if child_entry.kind == 'directory':
948
add_children(inventory, child_entry)
949
if other_tree.get_root_id() == self.get_root_id():
950
raise errors.BadSubsumeSource(self, other_tree,
951
'Trees have the same root')
953
other_tree_path = self.relpath(other_tree.basedir)
954
except errors.PathNotChild:
955
raise errors.BadSubsumeSource(self, other_tree,
956
'Tree is not contained by the other')
957
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
958
if new_root_parent is None:
959
raise errors.BadSubsumeSource(self, other_tree,
960
'Parent directory is not versioned.')
961
# We need to ensure that the result of a fetch will have a
962
# versionedfile for the other_tree root, and only fetching into
963
# RepositoryKnit2 guarantees that.
964
if not self.branch.repository.supports_rich_root():
965
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
966
other_tree.lock_tree_write()
968
new_parents = other_tree.get_parent_ids()
969
other_root = other_tree.inventory.root
970
other_root.parent_id = new_root_parent
971
other_root.name = osutils.basename(other_tree_path)
972
self.inventory.add(other_root)
973
add_children(self.inventory, other_root)
974
self._write_inventory(self.inventory)
975
# normally we don't want to fetch whole repositories, but i think
976
# here we really do want to consolidate the whole thing.
977
for parent_id in other_tree.get_parent_ids():
978
self.branch.fetch(other_tree.branch, parent_id)
979
self.add_parent_tree_id(parent_id)
982
other_tree.bzrdir.retire_bzrdir()
984
def _directory_is_tree_reference(self, relpath):
985
# as a special case, if a directory contains control files then
986
# it's a tree reference, except that the root of the tree is not
987
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
988
# TODO: We could ask all the control formats whether they
989
# recognize this directory, but at the moment there's no cheap api
990
# to do that. Since we probably can only nest bzr checkouts and
991
# they always use this name it's ok for now. -- mbp 20060306
993
# FIXME: There is an unhandled case here of a subdirectory
994
# containing .bzr but not a branch; that will probably blow up
995
# when you try to commit it. It might happen if there is a
996
# checkout in a subdirectory. This can be avoided by not adding
999
@needs_tree_write_lock
1000
def extract(self, file_id, format=None):
1001
"""Extract a subtree from this tree.
1003
A new branch will be created, relative to the path for this tree.
1007
segments = osutils.splitpath(path)
1008
transport = self.branch.bzrdir.root_transport
1009
for name in segments:
1010
transport = transport.clone(name)
1011
transport.ensure_base()
1014
sub_path = self.id2path(file_id)
1015
branch_transport = mkdirs(sub_path)
1017
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1018
branch_transport.ensure_base()
1019
branch_bzrdir = format.initialize_on_transport(branch_transport)
1021
repo = branch_bzrdir.find_repository()
1022
except errors.NoRepositoryPresent:
1023
repo = branch_bzrdir.create_repository()
1024
assert repo.supports_rich_root()
1026
if not repo.supports_rich_root():
1027
raise errors.RootNotRich()
1028
new_branch = branch_bzrdir.create_branch()
1029
new_branch.pull(self.branch)
1030
for parent_id in self.get_parent_ids():
1031
new_branch.fetch(self.branch, parent_id)
1032
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1033
if tree_transport.base != branch_transport.base:
1034
tree_bzrdir = format.initialize_on_transport(tree_transport)
1035
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1037
tree_bzrdir = branch_bzrdir
1038
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1039
wt.set_parent_ids(self.get_parent_ids())
1040
my_inv = self.inventory
1041
child_inv = Inventory(root_id=None)
1042
new_root = my_inv[file_id]
1043
my_inv.remove_recursive_id(file_id)
1044
new_root.parent_id = None
1045
child_inv.add(new_root)
1046
self._write_inventory(my_inv)
1047
wt._write_inventory(child_inv)
1050
def _serialize(self, inventory, out_file):
1051
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1054
def _deserialize(selt, in_file):
1055
return xml5.serializer_v5.read_inventory(in_file)
1058
"""Write the in memory inventory to disk."""
1059
# TODO: Maybe this should only write on dirty ?
1060
if self._control_files._lock_mode != 'w':
1061
raise errors.NotWriteLocked(self)
1063
self._serialize(self._inventory, sio)
1065
self._control_files.put('inventory', sio)
1066
self._inventory_is_modified = False
1068
def _kind(self, relpath):
1069
return osutils.file_kind(self.abspath(relpath))
1071
def list_files(self, include_root=False):
1072
"""Recursively list all files as (path, class, kind, id, entry).
1074
Lists, but does not descend into unversioned directories.
1076
This does not include files that have been deleted in this
1079
Skips the control directory.
1081
# list_files is an iterator, so @needs_read_lock doesn't work properly
1082
# with it. So callers should be careful to always read_lock the tree.
1083
if not self.is_locked():
1084
raise errors.ObjectNotLocked(self)
1086
inv = self.inventory
1087
if include_root is True:
1088
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1089
# Convert these into local objects to save lookup times
1090
pathjoin = osutils.pathjoin
1091
file_kind = self._kind
1093
# transport.base ends in a slash, we want the piece
1094
# between the last two slashes
1095
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1097
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1099
# directory file_id, relative path, absolute path, reverse sorted children
1100
children = os.listdir(self.basedir)
1102
# jam 20060527 The kernel sized tree seems equivalent whether we
1103
# use a deque and popleft to keep them sorted, or if we use a plain
1104
# list and just reverse() them.
1105
children = collections.deque(children)
1106
stack = [(inv.root.file_id, u'', self.basedir, children)]
1108
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1111
f = children.popleft()
1112
## TODO: If we find a subdirectory with its own .bzr
1113
## directory, then that is a separate tree and we
1114
## should exclude it.
1116
# the bzrdir for this tree
1117
if transport_base_dir == f:
1120
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1121
# and 'f' doesn't begin with one, we can do a string op, rather
1122
# than the checks of pathjoin(), all relative paths will have an extra slash
1124
fp = from_dir_relpath + '/' + f
1127
fap = from_dir_abspath + '/' + f
1129
f_ie = inv.get_child(from_dir_id, f)
1132
elif self.is_ignored(fp[1:]):
1135
# we may not have found this file, because of a unicode issue
1136
f_norm, can_access = osutils.normalized_filename(f)
1137
if f == f_norm or not can_access:
1138
# No change, so treat this file normally
1141
# this file can be accessed by a normalized path
1142
# check again if it is versioned
1143
# these lines are repeated here for performance
1145
fp = from_dir_relpath + '/' + f
1146
fap = from_dir_abspath + '/' + f
1147
f_ie = inv.get_child(from_dir_id, f)
1150
elif self.is_ignored(fp[1:]):
1157
# make a last minute entry
1159
yield fp[1:], c, fk, f_ie.file_id, f_ie
1162
yield fp[1:], c, fk, None, fk_entries[fk]()
1164
yield fp[1:], c, fk, None, TreeEntry()
1167
if fk != 'directory':
1170
# But do this child first
1171
new_children = os.listdir(fap)
1173
new_children = collections.deque(new_children)
1174
stack.append((f_ie.file_id, fp, fap, new_children))
1175
# Break out of inner loop,
1176
# so that we start outer loop with child
1179
# if we finished all children, pop it off the stack
1182
@needs_tree_write_lock
1183
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1186
to_dir must exist in the inventory.
1188
If to_dir exists and is a directory, the files are moved into
1189
it, keeping their old names.
1191
Note that to_dir is only the last component of the new name;
1192
this doesn't change the directory.
1194
For each entry in from_paths the move mode will be determined
1197
The first mode moves the file in the filesystem and updates the
1198
inventory. The second mode only updates the inventory without
1199
touching the file on the filesystem. This is the new mode introduced
1202
move uses the second mode if 'after == True' and the target is not
1203
versioned but present in the working tree.
1205
move uses the second mode if 'after == False' and the source is
1206
versioned but no longer in the working tree, and the target is not
1207
versioned but present in the working tree.
1209
move uses the first mode if 'after == False' and the source is
1210
versioned and present in the working tree, and the target is not
1211
versioned and not present in the working tree.
1213
Everything else results in an error.
1215
This returns a list of (from_path, to_path) pairs for each
1216
entry that is moved.
1221
# check for deprecated use of signature
1223
to_dir = kwargs.get('to_name', None)
1225
raise TypeError('You must supply a target directory')
1227
symbol_versioning.warn('The parameter to_name was deprecated'
1228
' in version 0.13. Use to_dir instead',
1231
# check destination directory
1232
assert not isinstance(from_paths, basestring)
1233
inv = self.inventory
1234
to_abs = self.abspath(to_dir)
1235
if not isdir(to_abs):
1236
raise errors.BzrMoveFailedError('',to_dir,
1237
errors.NotADirectory(to_abs))
1238
if not self.has_filename(to_dir):
1239
raise errors.BzrMoveFailedError('',to_dir,
1240
errors.NotInWorkingDirectory(to_dir))
1241
to_dir_id = inv.path2id(to_dir)
1242
if to_dir_id is None:
1243
raise errors.BzrMoveFailedError('',to_dir,
1244
errors.NotVersionedError(path=str(to_dir)))
1246
to_dir_ie = inv[to_dir_id]
1247
if to_dir_ie.kind != 'directory':
1248
raise errors.BzrMoveFailedError('',to_dir,
1249
errors.NotADirectory(to_abs))
1251
# create rename entries and tuples
1252
for from_rel in from_paths:
1253
from_tail = splitpath(from_rel)[-1]
1254
from_id = inv.path2id(from_rel)
1256
raise errors.BzrMoveFailedError(from_rel,to_dir,
1257
errors.NotVersionedError(path=str(from_rel)))
1259
from_entry = inv[from_id]
1260
from_parent_id = from_entry.parent_id
1261
to_rel = pathjoin(to_dir, from_tail)
1262
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1264
from_tail=from_tail,
1265
from_parent_id=from_parent_id,
1266
to_rel=to_rel, to_tail=from_tail,
1267
to_parent_id=to_dir_id)
1268
rename_entries.append(rename_entry)
1269
rename_tuples.append((from_rel, to_rel))
1271
# determine which move mode to use. checks also for movability
1272
rename_entries = self._determine_mv_mode(rename_entries, after)
1274
original_modified = self._inventory_is_modified
1277
self._inventory_is_modified = True
1278
self._move(rename_entries)
1280
# restore the inventory on error
1281
self._inventory_is_modified = original_modified
1283
self._write_inventory(inv)
1284
return rename_tuples
1286
def _determine_mv_mode(self, rename_entries, after=False):
1287
"""Determines for each from-to pair if both inventory and working tree
1288
or only the inventory has to be changed.
1290
Also does basic plausability tests.
1292
inv = self.inventory
1294
for rename_entry in rename_entries:
1295
# store to local variables for easier reference
1296
from_rel = rename_entry.from_rel
1297
from_id = rename_entry.from_id
1298
to_rel = rename_entry.to_rel
1299
to_id = inv.path2id(to_rel)
1300
only_change_inv = False
1302
# check the inventory for source and destination
1304
raise errors.BzrMoveFailedError(from_rel,to_rel,
1305
errors.NotVersionedError(path=str(from_rel)))
1306
if to_id is not None:
1307
raise errors.BzrMoveFailedError(from_rel,to_rel,
1308
errors.AlreadyVersionedError(path=str(to_rel)))
1310
# try to determine the mode for rename (only change inv or change
1311
# inv and file system)
1313
if not self.has_filename(to_rel):
1314
raise errors.BzrMoveFailedError(from_id,to_rel,
1315
errors.NoSuchFile(path=str(to_rel),
1316
extra="New file has not been created yet"))
1317
only_change_inv = True
1318
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1319
only_change_inv = True
1320
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1321
only_change_inv = False
1322
elif (sys.platform == 'win32'
1323
and from_rel.lower() == to_rel.lower()
1324
and self.has_filename(from_rel)):
1325
only_change_inv = False
1327
# something is wrong, so lets determine what exactly
1328
if not self.has_filename(from_rel) and \
1329
not self.has_filename(to_rel):
1330
raise errors.BzrRenameFailedError(from_rel,to_rel,
1331
errors.PathsDoNotExist(paths=(str(from_rel),
1334
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1335
rename_entry.only_change_inv = only_change_inv
1336
return rename_entries
1338
def _move(self, rename_entries):
1339
"""Moves a list of files.
1341
Depending on the value of the flag 'only_change_inv', the
1342
file will be moved on the file system or not.
1344
inv = self.inventory
1347
for entry in rename_entries:
1349
self._move_entry(entry)
1351
self._rollback_move(moved)
1355
def _rollback_move(self, moved):
1356
"""Try to rollback a previous move in case of an filesystem error."""
1357
inv = self.inventory
1360
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1361
entry.to_tail, entry.to_parent_id, entry.from_rel,
1362
entry.from_tail, entry.from_parent_id,
1363
entry.only_change_inv))
1364
except errors.BzrMoveFailedError, e:
1365
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1366
" The working tree is in an inconsistent state."
1367
" Please consider doing a 'bzr revert'."
1368
" Error message is: %s" % e)
1370
def _move_entry(self, entry):
1371
inv = self.inventory
1372
from_rel_abs = self.abspath(entry.from_rel)
1373
to_rel_abs = self.abspath(entry.to_rel)
1374
if from_rel_abs == to_rel_abs:
1375
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1376
"Source and target are identical.")
1378
if not entry.only_change_inv:
1380
osutils.rename(from_rel_abs, to_rel_abs)
1382
raise errors.BzrMoveFailedError(entry.from_rel,
1384
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1386
@needs_tree_write_lock
1387
def rename_one(self, from_rel, to_rel, after=False):
1390
This can change the directory or the filename or both.
1392
rename_one has several 'modes' to work. First, it can rename a physical
1393
file and change the file_id. That is the normal mode. Second, it can
1394
only change the file_id without touching any physical file. This is
1395
the new mode introduced in version 0.15.
1397
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1398
versioned but present in the working tree.
1400
rename_one uses the second mode if 'after == False' and 'from_rel' is
1401
versioned but no longer in the working tree, and 'to_rel' is not
1402
versioned but present in the working tree.
1404
rename_one uses the first mode if 'after == False' and 'from_rel' is
1405
versioned and present in the working tree, and 'to_rel' is not
1406
versioned and not present in the working tree.
1408
Everything else results in an error.
1410
inv = self.inventory
1413
# create rename entries and tuples
1414
from_tail = splitpath(from_rel)[-1]
1415
from_id = inv.path2id(from_rel)
1417
raise errors.BzrRenameFailedError(from_rel,to_rel,
1418
errors.NotVersionedError(path=str(from_rel)))
1419
from_entry = inv[from_id]
1420
from_parent_id = from_entry.parent_id
1421
to_dir, to_tail = os.path.split(to_rel)
1422
to_dir_id = inv.path2id(to_dir)
1423
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1425
from_tail=from_tail,
1426
from_parent_id=from_parent_id,
1427
to_rel=to_rel, to_tail=to_tail,
1428
to_parent_id=to_dir_id)
1429
rename_entries.append(rename_entry)
1431
# determine which move mode to use. checks also for movability
1432
rename_entries = self._determine_mv_mode(rename_entries, after)
1434
# check if the target changed directory and if the target directory is
1436
if to_dir_id is None:
1437
raise errors.BzrMoveFailedError(from_rel,to_rel,
1438
errors.NotVersionedError(path=str(to_dir)))
1440
# all checks done. now we can continue with our actual work
1441
mutter('rename_one:\n'
1446
' to_dir_id {%s}\n',
1447
from_id, from_rel, to_rel, to_dir, to_dir_id)
1449
self._move(rename_entries)
1450
self._write_inventory(inv)
1452
class _RenameEntry(object):
1453
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1454
to_rel, to_tail, to_parent_id, only_change_inv=False):
1455
self.from_rel = from_rel
1456
self.from_id = from_id
1457
self.from_tail = from_tail
1458
self.from_parent_id = from_parent_id
1459
self.to_rel = to_rel
1460
self.to_tail = to_tail
1461
self.to_parent_id = to_parent_id
1462
self.only_change_inv = only_change_inv
1466
"""Return all unknown files.
1468
These are files in the working directory that are not versioned or
1469
control files or ignored.
1471
# force the extras method to be fully executed before returning, to
1472
# prevent race conditions with the lock
1474
[subp for subp in self.extras() if not self.is_ignored(subp)])
1476
@needs_tree_write_lock
1477
def unversion(self, file_ids):
1478
"""Remove the file ids in file_ids from the current versioned set.
1480
When a file_id is unversioned, all of its children are automatically
1483
:param file_ids: The file ids to stop versioning.
1484
:raises: NoSuchId if any fileid is not currently versioned.
1486
for file_id in file_ids:
1487
if self._inventory.has_id(file_id):
1488
self._inventory.remove_recursive_id(file_id)
1490
raise errors.NoSuchId(self, file_id)
1492
# in the future this should just set a dirty bit to wait for the
1493
# final unlock. However, until all methods of workingtree start
1494
# with the current in -memory inventory rather than triggering
1495
# a read, it is more complex - we need to teach read_inventory
1496
# to know when to read, and when to not read first... and possibly
1497
# to save first when the in memory one may be corrupted.
1498
# so for now, we just only write it if it is indeed dirty.
1500
self._write_inventory(self._inventory)
1502
@deprecated_method(zero_eight)
1503
def iter_conflicts(self):
1504
"""List all files in the tree that have text or content conflicts.
1505
DEPRECATED. Use conflicts instead."""
1506
return self._iter_conflicts()
1508
def _iter_conflicts(self):
1510
for info in self.list_files():
1512
stem = get_conflicted_stem(path)
1515
if stem not in conflicted:
1516
conflicted.add(stem)
1520
def pull(self, source, overwrite=False, stop_revision=None,
1521
change_reporter=None, possible_transports=None):
1522
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1525
pp = ProgressPhase("Pull phase", 2, top_pb)
1527
old_revision_info = self.branch.last_revision_info()
1528
basis_tree = self.basis_tree()
1529
count = self.branch.pull(source, overwrite, stop_revision,
1530
possible_transports=possible_transports)
1531
new_revision_info = self.branch.last_revision_info()
1532
if new_revision_info != old_revision_info:
1534
repository = self.branch.repository
1535
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1536
basis_tree.lock_read()
1538
new_basis_tree = self.branch.basis_tree()
1545
change_reporter=change_reporter)
1546
if (basis_tree.inventory.root is None and
1547
new_basis_tree.inventory.root is not None):
1548
self.set_root_id(new_basis_tree.get_root_id())
1552
# TODO - dedup parents list with things merged by pull ?
1553
# reuse the revisiontree we merged against to set the new
1555
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1556
# we have to pull the merge trees out again, because
1557
# merge_inner has set the ids. - this corner is not yet
1558
# layered well enough to prevent double handling.
1559
# XXX TODO: Fix the double handling: telling the tree about
1560
# the already known parent data is wasteful.
1561
merges = self.get_parent_ids()[1:]
1562
parent_trees.extend([
1563
(parent, repository.revision_tree(parent)) for
1565
self.set_parent_trees(parent_trees)
1572
def put_file_bytes_non_atomic(self, file_id, bytes):
1573
"""See MutableTree.put_file_bytes_non_atomic."""
1574
stream = file(self.id2abspath(file_id), 'wb')
1579
# TODO: update the hashcache here ?
1582
"""Yield all unversioned files in this WorkingTree.
1584
If there are any unversioned directories then only the directory is
1585
returned, not all its children. But if there are unversioned files
1586
under a versioned subdirectory, they are returned.
1588
Currently returned depth-first, sorted by name within directories.
1589
This is the same order used by 'osutils.walkdirs'.
1591
## TODO: Work from given directory downwards
1592
for path, dir_entry in self.inventory.directories():
1593
# mutter("search for unknowns in %r", path)
1594
dirabs = self.abspath(path)
1595
if not isdir(dirabs):
1596
# e.g. directory deleted
1600
for subf in os.listdir(dirabs):
1603
if subf not in dir_entry.children:
1604
subf_norm, can_access = osutils.normalized_filename(subf)
1605
if subf_norm != subf and can_access:
1606
if subf_norm not in dir_entry.children:
1607
fl.append(subf_norm)
1613
subp = pathjoin(path, subf)
1616
def ignored_files(self):
1617
"""Yield list of PATH, IGNORE_PATTERN"""
1618
for subp in self.extras():
1619
pat = self.is_ignored(subp)
1623
def get_ignore_list(self):
1624
"""Return list of ignore patterns.
1626
Cached in the Tree object after the first call.
1628
ignoreset = getattr(self, '_ignoreset', None)
1629
if ignoreset is not None:
1632
ignore_globs = set()
1633
ignore_globs.update(ignores.get_runtime_ignores())
1634
ignore_globs.update(ignores.get_user_ignores())
1635
if self.has_filename(bzrlib.IGNORE_FILENAME):
1636
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1638
ignore_globs.update(ignores.parse_ignore_file(f))
1641
self._ignoreset = ignore_globs
1644
def _flush_ignore_list_cache(self):
1645
"""Resets the cached ignore list to force a cache rebuild."""
1646
self._ignoreset = None
1647
self._ignoreglobster = None
1649
def is_ignored(self, filename):
1650
r"""Check whether the filename matches an ignore pattern.
1652
Patterns containing '/' or '\' need to match the whole path;
1653
others match against only the last component.
1655
If the file is ignored, returns the pattern which caused it to
1656
be ignored, otherwise None. So this can simply be used as a
1657
boolean if desired."""
1658
if getattr(self, '_ignoreglobster', None) is None:
1659
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1660
return self._ignoreglobster.match(filename)
1662
def kind(self, file_id):
1663
return file_kind(self.id2abspath(file_id))
1665
def _comparison_data(self, entry, path):
1666
abspath = self.abspath(path)
1668
stat_value = os.lstat(abspath)
1670
if getattr(e, 'errno', None) == errno.ENOENT:
1677
mode = stat_value.st_mode
1678
kind = osutils.file_kind_from_stat_mode(mode)
1679
if not supports_executable():
1680
executable = entry is not None and entry.executable
1682
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1683
return kind, executable, stat_value
1685
def _file_size(self, entry, stat_value):
1686
return stat_value.st_size
1688
def last_revision(self):
1689
"""Return the last revision of the branch for this tree.
1691
This format tree does not support a separate marker for last-revision
1692
compared to the branch.
1694
See MutableTree.last_revision
1696
return self._last_revision()
1699
def _last_revision(self):
1700
"""helper for get_parent_ids."""
1701
return _mod_revision.ensure_null(self.branch.last_revision())
1703
def is_locked(self):
1704
return self._control_files.is_locked()
1706
def _must_be_locked(self):
1707
if not self.is_locked():
1708
raise errors.ObjectNotLocked(self)
1710
def lock_read(self):
1711
"""See Branch.lock_read, and WorkingTree.unlock."""
1712
if not self.is_locked():
1714
self.branch.lock_read()
1716
return self._control_files.lock_read()
1718
self.branch.unlock()
1721
def lock_tree_write(self):
1722
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1723
if not self.is_locked():
1725
self.branch.lock_read()
1727
return self._control_files.lock_write()
1729
self.branch.unlock()
1732
def lock_write(self):
1733
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1734
if not self.is_locked():
1736
self.branch.lock_write()
1738
return self._control_files.lock_write()
1740
self.branch.unlock()
1743
def get_physical_lock_status(self):
1744
return self._control_files.get_physical_lock_status()
1746
def _basis_inventory_name(self):
1747
return 'basis-inventory-cache'
1749
def _reset_data(self):
1750
"""Reset transient data that cannot be revalidated."""
1751
self._inventory_is_modified = False
1752
result = self._deserialize(self._control_files.get('inventory'))
1753
self._set_inventory(result, dirty=False)
1755
@needs_tree_write_lock
1756
def set_last_revision(self, new_revision):
1757
"""Change the last revision in the working tree."""
1758
if self._change_last_revision(new_revision):
1759
self._cache_basis_inventory(new_revision)
1761
def _change_last_revision(self, new_revision):
1762
"""Template method part of set_last_revision to perform the change.
1764
This is used to allow WorkingTree3 instances to not affect branch
1765
when their last revision is set.
1767
if _mod_revision.is_null(new_revision):
1768
self.branch.set_revision_history([])
1771
self.branch.generate_revision_history(new_revision)
1772
except errors.NoSuchRevision:
1773
# not present in the repo - dont try to set it deeper than the tip
1774
self.branch.set_revision_history([new_revision])
1777
def _write_basis_inventory(self, xml):
1778
"""Write the basis inventory XML to the basis-inventory file"""
1779
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1780
path = self._basis_inventory_name()
1782
self._control_files.put(path, sio)
1784
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1785
"""Create the text that will be saved in basis-inventory"""
1786
inventory.revision_id = revision_id
1787
return xml7.serializer_v7.write_inventory_to_string(inventory)
1789
def _cache_basis_inventory(self, new_revision):
1790
"""Cache new_revision as the basis inventory."""
1791
# TODO: this should allow the ready-to-use inventory to be passed in,
1792
# as commit already has that ready-to-use [while the format is the
1795
# this double handles the inventory - unpack and repack -
1796
# but is easier to understand. We can/should put a conditional
1797
# in here based on whether the inventory is in the latest format
1798
# - perhaps we should repack all inventories on a repository
1800
# the fast path is to copy the raw xml from the repository. If the
1801
# xml contains 'revision_id="', then we assume the right
1802
# revision_id is set. We must check for this full string, because a
1803
# root node id can legitimately look like 'revision_id' but cannot
1805
xml = self.branch.repository.get_inventory_xml(new_revision)
1806
firstline = xml.split('\n', 1)[0]
1807
if (not 'revision_id="' in firstline or
1808
'format="7"' not in firstline):
1809
inv = self.branch.repository.deserialise_inventory(
1811
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1812
self._write_basis_inventory(xml)
1813
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1816
def read_basis_inventory(self):
1817
"""Read the cached basis inventory."""
1818
path = self._basis_inventory_name()
1819
return self._control_files.get(path).read()
1822
def read_working_inventory(self):
1823
"""Read the working inventory.
1825
:raises errors.InventoryModified: read_working_inventory will fail
1826
when the current in memory inventory has been modified.
1828
# conceptually this should be an implementation detail of the tree.
1829
# XXX: Deprecate this.
1830
# ElementTree does its own conversion from UTF-8, so open in
1832
if self._inventory_is_modified:
1833
raise errors.InventoryModified(self)
1834
result = self._deserialize(self._control_files.get('inventory'))
1835
self._set_inventory(result, dirty=False)
1838
@needs_tree_write_lock
1839
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1841
"""Remove nominated files from the working inventory.
1843
:files: File paths relative to the basedir.
1844
:keep_files: If true, the files will also be kept.
1845
:force: Delete files and directories, even if they are changed and
1846
even if the directories are not empty.
1848
if isinstance(files, basestring):
1854
unknown_nested_files=set()
1856
def recurse_directory_to_add_files(directory):
1857
# Recurse directory and add all files
1858
# so we can check if they have changed.
1859
for parent_info, file_infos in\
1860
osutils.walkdirs(self.abspath(directory),
1862
for relpath, basename, kind, lstat, abspath in file_infos:
1863
# Is it versioned or ignored?
1864
if self.path2id(relpath) or self.is_ignored(relpath):
1865
# Add nested content for deletion.
1866
new_files.add(relpath)
1868
# Files which are not versioned and not ignored
1869
# should be treated as unknown.
1870
unknown_nested_files.add((relpath, None, kind))
1872
for filename in files:
1873
# Get file name into canonical form.
1874
abspath = self.abspath(filename)
1875
filename = self.relpath(abspath)
1876
if len(filename) > 0:
1877
new_files.add(filename)
1878
if osutils.isdir(abspath):
1879
recurse_directory_to_add_files(filename)
1881
files = list(new_files)
1884
return # nothing to do
1886
# Sort needed to first handle directory content before the directory
1887
files.sort(reverse=True)
1889
# Bail out if we are going to delete files we shouldn't
1890
if not keep_files and not force:
1891
has_changed_files = len(unknown_nested_files) > 0
1892
if not has_changed_files:
1893
for (file_id, path, content_change, versioned, parent_id, name,
1894
kind, executable) in self._iter_changes(self.basis_tree(),
1895
include_unchanged=True, require_versioned=False,
1896
want_unversioned=True, specific_files=files):
1897
# Check if it's an unknown (but not ignored) OR
1898
# changed (but not deleted) :
1899
if ((versioned == (False, False) or
1900
content_change and kind[1] != None)
1901
and not self.is_ignored(path[1])):
1902
has_changed_files = True
1905
if has_changed_files:
1906
# Make delta show ALL applicable changes in error message.
1907
tree_delta = self.changes_from(self.basis_tree(),
1908
require_versioned=False, want_unversioned=True,
1909
specific_files=files)
1910
for unknown_file in unknown_nested_files:
1911
if unknown_file not in tree_delta.unversioned:
1912
tree_delta.unversioned.extend((unknown_file,))
1913
raise errors.BzrRemoveChangedFilesError(tree_delta)
1915
# Build inv_delta and delete files where applicaple,
1916
# do this before any modifications to inventory.
1918
fid = self.path2id(f)
1921
message = "%s is not versioned." % (f,)
1924
# having removed it, it must be either ignored or unknown
1925
if self.is_ignored(f):
1929
textui.show_status(new_status, self.kind(fid), f,
1932
inv_delta.append((f, None, fid, None))
1933
message = "removed %s" % (f,)
1936
abs_path = self.abspath(f)
1937
if osutils.lexists(abs_path):
1938
if (osutils.isdir(abs_path) and
1939
len(os.listdir(abs_path)) > 0):
1941
osutils.rmtree(abs_path)
1943
message = "%s is not an empty directory "\
1944
"and won't be deleted." % (f,)
1946
osutils.delete_any(abs_path)
1947
message = "deleted %s" % (f,)
1948
elif message is not None:
1949
# Only care if we haven't done anything yet.
1950
message = "%s does not exist." % (f,)
1952
# Print only one message (if any) per file.
1953
if message is not None:
1955
self.apply_inventory_delta(inv_delta)
1957
@needs_tree_write_lock
1958
def revert(self, filenames=None, old_tree=None, backups=True,
1959
pb=DummyProgress(), report_changes=False):
1960
from bzrlib.conflicts import resolve
1963
symbol_versioning.warn('Using [] to revert all files is deprecated'
1964
' as of bzr 0.91. Please use None (the default) instead.',
1965
DeprecationWarning, stacklevel=2)
1966
if old_tree is None:
1967
basis_tree = self.basis_tree()
1968
basis_tree.lock_read()
1969
old_tree = basis_tree
1973
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1975
if filenames is None and len(self.get_parent_ids()) > 1:
1977
last_revision = self.last_revision()
1978
if last_revision != NULL_REVISION:
1979
if basis_tree is None:
1980
basis_tree = self.basis_tree()
1981
basis_tree.lock_read()
1982
parent_trees.append((last_revision, basis_tree))
1983
self.set_parent_trees(parent_trees)
1986
resolve(self, filenames, ignore_misses=True, recursive=True)
1988
if basis_tree is not None:
1992
def revision_tree(self, revision_id):
1993
"""See Tree.revision_tree.
1995
WorkingTree can supply revision_trees for the basis revision only
1996
because there is only one cached inventory in the bzr directory.
1998
if revision_id == self.last_revision():
2000
xml = self.read_basis_inventory()
2001
except errors.NoSuchFile:
2005
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2006
# dont use the repository revision_tree api because we want
2007
# to supply the inventory.
2008
if inv.revision_id == revision_id:
2009
return revisiontree.RevisionTree(self.branch.repository,
2011
except errors.BadInventoryFormat:
2013
# raise if there was no inventory, or if we read the wrong inventory.
2014
raise errors.NoSuchRevisionInTree(self, revision_id)
2016
# XXX: This method should be deprecated in favour of taking in a proper
2017
# new Inventory object.
2018
@needs_tree_write_lock
2019
def set_inventory(self, new_inventory_list):
2020
from bzrlib.inventory import (Inventory,
2025
inv = Inventory(self.get_root_id())
2026
for path, file_id, parent, kind in new_inventory_list:
2027
name = os.path.basename(path)
2030
# fixme, there should be a factory function inv,add_??
2031
if kind == 'directory':
2032
inv.add(InventoryDirectory(file_id, name, parent))
2033
elif kind == 'file':
2034
inv.add(InventoryFile(file_id, name, parent))
2035
elif kind == 'symlink':
2036
inv.add(InventoryLink(file_id, name, parent))
2038
raise errors.BzrError("unknown kind %r" % kind)
2039
self._write_inventory(inv)
2041
@needs_tree_write_lock
2042
def set_root_id(self, file_id):
2043
"""Set the root id for this tree."""
2046
symbol_versioning.warn(symbol_versioning.zero_twelve
2047
% 'WorkingTree.set_root_id with fileid=None',
2052
file_id = osutils.safe_file_id(file_id)
2053
self._set_root_id(file_id)
2055
def _set_root_id(self, file_id):
2056
"""Set the root id for this tree, in a format specific manner.
2058
:param file_id: The file id to assign to the root. It must not be
2059
present in the current inventory or an error will occur. It must
2060
not be None, but rather a valid file id.
2062
inv = self._inventory
2063
orig_root_id = inv.root.file_id
2064
# TODO: it might be nice to exit early if there was nothing
2065
# to do, saving us from trigger a sync on unlock.
2066
self._inventory_is_modified = True
2067
# we preserve the root inventory entry object, but
2068
# unlinkit from the byid index
2069
del inv._byid[inv.root.file_id]
2070
inv.root.file_id = file_id
2071
# and link it into the index with the new changed id.
2072
inv._byid[inv.root.file_id] = inv.root
2073
# and finally update all children to reference the new id.
2074
# XXX: this should be safe to just look at the root.children
2075
# list, not the WHOLE INVENTORY.
2078
if entry.parent_id == orig_root_id:
2079
entry.parent_id = inv.root.file_id
2082
"""See Branch.unlock.
2084
WorkingTree locking just uses the Branch locking facilities.
2085
This is current because all working trees have an embedded branch
2086
within them. IF in the future, we were to make branch data shareable
2087
between multiple working trees, i.e. via shared storage, then we
2088
would probably want to lock both the local tree, and the branch.
2090
raise NotImplementedError(self.unlock)
2092
def update(self, change_reporter=None, possible_transports=None):
2093
"""Update a working tree along its branch.
2095
This will update the branch if its bound too, which means we have
2096
multiple trees involved:
2098
- The new basis tree of the master.
2099
- The old basis tree of the branch.
2100
- The old basis tree of the working tree.
2101
- The current working tree state.
2103
Pathologically, all three may be different, and non-ancestors of each
2104
other. Conceptually we want to:
2106
- Preserve the wt.basis->wt.state changes
2107
- Transform the wt.basis to the new master basis.
2108
- Apply a merge of the old branch basis to get any 'local' changes from
2110
- Restore the wt.basis->wt.state changes.
2112
There isn't a single operation at the moment to do that, so we:
2113
- Merge current state -> basis tree of the master w.r.t. the old tree
2115
- Do a 'normal' merge of the old branch basis if it is relevant.
2117
if self.branch.get_master_branch(possible_transports) is not None:
2119
update_branch = True
2121
self.lock_tree_write()
2122
update_branch = False
2125
old_tip = self.branch.update(possible_transports)
2128
return self._update_tree(old_tip, change_reporter)
2132
@needs_tree_write_lock
2133
def _update_tree(self, old_tip=None, change_reporter=None):
2134
"""Update a tree to the master branch.
2136
:param old_tip: if supplied, the previous tip revision the branch,
2137
before it was changed to the master branch's tip.
2139
# here if old_tip is not None, it is the old tip of the branch before
2140
# it was updated from the master branch. This should become a pending
2141
# merge in the working tree to preserve the user existing work. we
2142
# cant set that until we update the working trees last revision to be
2143
# one from the new branch, because it will just get absorbed by the
2144
# parent de-duplication logic.
2146
# We MUST save it even if an error occurs, because otherwise the users
2147
# local work is unreferenced and will appear to have been lost.
2151
last_rev = self.get_parent_ids()[0]
2153
last_rev = _mod_revision.NULL_REVISION
2154
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2155
# merge tree state up to new branch tip.
2156
basis = self.basis_tree()
2159
to_tree = self.branch.basis_tree()
2160
if basis.inventory.root is None:
2161
self.set_root_id(to_tree.get_root_id())
2163
result += merge.merge_inner(
2168
change_reporter=change_reporter)
2171
# TODO - dedup parents list with things merged by pull ?
2172
# reuse the tree we've updated to to set the basis:
2173
parent_trees = [(self.branch.last_revision(), to_tree)]
2174
merges = self.get_parent_ids()[1:]
2175
# Ideally we ask the tree for the trees here, that way the working
2176
# tree can decide whether to give us teh entire tree or give us a
2177
# lazy initialised tree. dirstate for instance will have the trees
2178
# in ram already, whereas a last-revision + basis-inventory tree
2179
# will not, but also does not need them when setting parents.
2180
for parent in merges:
2181
parent_trees.append(
2182
(parent, self.branch.repository.revision_tree(parent)))
2183
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2184
parent_trees.append(
2185
(old_tip, self.branch.repository.revision_tree(old_tip)))
2186
self.set_parent_trees(parent_trees)
2187
last_rev = parent_trees[0][0]
2189
# the working tree had the same last-revision as the master
2190
# branch did. We may still have pivot local work from the local
2191
# branch into old_tip:
2192
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2193
self.add_parent_tree_id(old_tip)
2194
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2195
and old_tip != last_rev):
2196
# our last revision was not the prior branch last revision
2197
# and we have converted that last revision to a pending merge.
2198
# base is somewhere between the branch tip now
2199
# and the now pending merge
2201
# Since we just modified the working tree and inventory, flush out
2202
# the current state, before we modify it again.
2203
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2204
# requires it only because TreeTransform directly munges the
2205
# inventory and calls tree._write_inventory(). Ultimately we
2206
# should be able to remove this extra flush.
2208
graph = self.branch.repository.get_graph()
2209
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2211
base_tree = self.branch.repository.revision_tree(base_rev_id)
2212
other_tree = self.branch.repository.revision_tree(old_tip)
2213
result += merge.merge_inner(
2218
change_reporter=change_reporter)
2221
def _write_hashcache_if_dirty(self):
2222
"""Write out the hashcache if it is dirty."""
2223
if self._hashcache.needs_write:
2225
self._hashcache.write()
2227
if e.errno not in (errno.EPERM, errno.EACCES):
2229
# TODO: jam 20061219 Should this be a warning? A single line
2230
# warning might be sufficient to let the user know what
2232
mutter('Could not write hashcache for %s\nError: %s',
2233
self._hashcache.cache_file_name(), e)
2235
@needs_tree_write_lock
2236
def _write_inventory(self, inv):
2237
"""Write inventory as the current inventory."""
2238
self._set_inventory(inv, dirty=True)
2241
def set_conflicts(self, arg):
2242
raise errors.UnsupportedOperation(self.set_conflicts, self)
2244
def add_conflicts(self, arg):
2245
raise errors.UnsupportedOperation(self.add_conflicts, self)
2248
def conflicts(self):
2249
conflicts = _mod_conflicts.ConflictList()
2250
for conflicted in self._iter_conflicts():
2253
if file_kind(self.abspath(conflicted)) != "file":
2255
except errors.NoSuchFile:
2258
for suffix in ('.THIS', '.OTHER'):
2260
kind = file_kind(self.abspath(conflicted+suffix))
2263
except errors.NoSuchFile:
2267
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2268
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2270
file_id=self.path2id(conflicted)))
2273
def walkdirs(self, prefix=""):
2274
"""Walk the directories of this tree.
2276
returns a generator which yields items in the form:
2277
((curren_directory_path, fileid),
2278
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2281
This API returns a generator, which is only valid during the current
2282
tree transaction - within a single lock_read or lock_write duration.
2284
If the tree is not locked, it may cause an error to be raised,
2285
depending on the tree implementation.
2287
disk_top = self.abspath(prefix)
2288
if disk_top.endswith('/'):
2289
disk_top = disk_top[:-1]
2290
top_strip_len = len(disk_top) + 1
2291
inventory_iterator = self._walkdirs(prefix)
2292
disk_iterator = osutils.walkdirs(disk_top, prefix)
2294
current_disk = disk_iterator.next()
2295
disk_finished = False
2297
if not (e.errno == errno.ENOENT or
2298
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2301
disk_finished = True
2303
current_inv = inventory_iterator.next()
2304
inv_finished = False
2305
except StopIteration:
2308
while not inv_finished or not disk_finished:
2310
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2311
cur_disk_dir_content) = current_disk
2313
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2314
cur_disk_dir_content) = ((None, None), None)
2315
if not disk_finished:
2316
# strip out .bzr dirs
2317
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2318
len(cur_disk_dir_content) > 0):
2319
# osutils.walkdirs can be made nicer -
2320
# yield the path-from-prefix rather than the pathjoined
2322
bzrdir_loc = bisect_left(cur_disk_dir_content,
2324
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2325
# we dont yield the contents of, or, .bzr itself.
2326
del cur_disk_dir_content[bzrdir_loc]
2328
# everything is unknown
2331
# everything is missing
2334
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2336
# disk is before inventory - unknown
2337
dirblock = [(relpath, basename, kind, stat, None, None) for
2338
relpath, basename, kind, stat, top_path in
2339
cur_disk_dir_content]
2340
yield (cur_disk_dir_relpath, None), dirblock
2342
current_disk = disk_iterator.next()
2343
except StopIteration:
2344
disk_finished = True
2346
# inventory is before disk - missing.
2347
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2348
for relpath, basename, dkind, stat, fileid, kind in
2350
yield (current_inv[0][0], current_inv[0][1]), dirblock
2352
current_inv = inventory_iterator.next()
2353
except StopIteration:
2356
# versioned present directory
2357
# merge the inventory and disk data together
2359
for relpath, subiterator in itertools.groupby(sorted(
2360
current_inv[1] + cur_disk_dir_content,
2361
key=operator.itemgetter(0)), operator.itemgetter(1)):
2362
path_elements = list(subiterator)
2363
if len(path_elements) == 2:
2364
inv_row, disk_row = path_elements
2365
# versioned, present file
2366
dirblock.append((inv_row[0],
2367
inv_row[1], disk_row[2],
2368
disk_row[3], inv_row[4],
2370
elif len(path_elements[0]) == 5:
2372
dirblock.append((path_elements[0][0],
2373
path_elements[0][1], path_elements[0][2],
2374
path_elements[0][3], None, None))
2375
elif len(path_elements[0]) == 6:
2376
# versioned, absent file.
2377
dirblock.append((path_elements[0][0],
2378
path_elements[0][1], 'unknown', None,
2379
path_elements[0][4], path_elements[0][5]))
2381
raise NotImplementedError('unreachable code')
2382
yield current_inv[0], dirblock
2384
current_inv = inventory_iterator.next()
2385
except StopIteration:
2388
current_disk = disk_iterator.next()
2389
except StopIteration:
2390
disk_finished = True
2392
def _walkdirs(self, prefix=""):
2393
"""Walk the directories of this tree.
2395
:prefix: is used as the directrory to start with.
2396
returns a generator which yields items in the form:
2397
((curren_directory_path, fileid),
2398
[(file1_path, file1_name, file1_kind, None, file1_id,
2401
_directory = 'directory'
2402
# get the root in the inventory
2403
inv = self.inventory
2404
top_id = inv.path2id(prefix)
2408
pending = [(prefix, '', _directory, None, top_id, None)]
2411
currentdir = pending.pop()
2412
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2413
top_id = currentdir[4]
2415
relroot = currentdir[0] + '/'
2418
# FIXME: stash the node in pending
2420
for name, child in entry.sorted_children():
2421
dirblock.append((relroot + name, name, child.kind, None,
2422
child.file_id, child.kind
2424
yield (currentdir[0], entry.file_id), dirblock
2425
# push the user specified dirs from dirblock
2426
for dir in reversed(dirblock):
2427
if dir[2] == _directory:
2430
@needs_tree_write_lock
2431
def auto_resolve(self):
2432
"""Automatically resolve text conflicts according to contents.
2434
Only text conflicts are auto_resolvable. Files with no conflict markers
2435
are considered 'resolved', because bzr always puts conflict markers
2436
into files that have text conflicts. The corresponding .THIS .BASE and
2437
.OTHER files are deleted, as per 'resolve'.
2438
:return: a tuple of ConflictLists: (un_resolved, resolved).
2440
un_resolved = _mod_conflicts.ConflictList()
2441
resolved = _mod_conflicts.ConflictList()
2442
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2443
for conflict in self.conflicts():
2444
if (conflict.typestring != 'text conflict' or
2445
self.kind(conflict.file_id) != 'file'):
2446
un_resolved.append(conflict)
2448
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2450
for line in my_file:
2451
if conflict_re.search(line):
2452
un_resolved.append(conflict)
2455
resolved.append(conflict)
2458
resolved.remove_files(self)
2459
self.set_conflicts(un_resolved)
2460
return un_resolved, resolved
2462
def _validate(self):
2463
"""Validate internal structures.
2465
This is meant mostly for the test suite. To give it a chance to detect
2466
corruption after actions have occurred. The default implementation is a
2469
:return: None. An exception should be raised if there is an error.
2474
class WorkingTree2(WorkingTree):
2475
"""This is the Format 2 working tree.
2477
This was the first weave based working tree.
2478
- uses os locks for locking.
2479
- uses the branch last-revision.
2482
def __init__(self, *args, **kwargs):
2483
super(WorkingTree2, self).__init__(*args, **kwargs)
2484
# WorkingTree2 has more of a constraint that self._inventory must
2485
# exist. Because this is an older format, we don't mind the overhead
2486
# caused by the extra computation here.
2488
# Newer WorkingTree's should only have self._inventory set when they
2490
if self._inventory is None:
2491
self.read_working_inventory()
2493
def lock_tree_write(self):
2494
"""See WorkingTree.lock_tree_write().
2496
In Format2 WorkingTrees we have a single lock for the branch and tree
2497
so lock_tree_write() degrades to lock_write().
2499
self.branch.lock_write()
2501
return self._control_files.lock_write()
2503
self.branch.unlock()
2507
# do non-implementation specific cleanup
2510
# we share control files:
2511
if self._control_files._lock_count == 3:
2512
# _inventory_is_modified is always False during a read lock.
2513
if self._inventory_is_modified:
2515
self._write_hashcache_if_dirty()
2517
# reverse order of locking.
2519
return self._control_files.unlock()
2521
self.branch.unlock()
2524
class WorkingTree3(WorkingTree):
2525
"""This is the Format 3 working tree.
2527
This differs from the base WorkingTree by:
2528
- having its own file lock
2529
- having its own last-revision property.
2531
This is new in bzr 0.8
2535
def _last_revision(self):
2536
"""See Mutable.last_revision."""
2538
return self._control_files.get('last-revision').read()
2539
except errors.NoSuchFile:
2540
return _mod_revision.NULL_REVISION
2542
def _change_last_revision(self, revision_id):
2543
"""See WorkingTree._change_last_revision."""
2544
if revision_id is None or revision_id == NULL_REVISION:
2546
self._control_files._transport.delete('last-revision')
2547
except errors.NoSuchFile:
2551
self._control_files.put_bytes('last-revision', revision_id)
2554
@needs_tree_write_lock
2555
def set_conflicts(self, conflicts):
2556
self._put_rio('conflicts', conflicts.to_stanzas(),
2559
@needs_tree_write_lock
2560
def add_conflicts(self, new_conflicts):
2561
conflict_set = set(self.conflicts())
2562
conflict_set.update(set(list(new_conflicts)))
2563
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2564
key=_mod_conflicts.Conflict.sort_key)))
2567
def conflicts(self):
2569
confile = self._control_files.get('conflicts')
2570
except errors.NoSuchFile:
2571
return _mod_conflicts.ConflictList()
2573
if confile.next() != CONFLICT_HEADER_1 + '\n':
2574
raise errors.ConflictFormatError()
2575
except StopIteration:
2576
raise errors.ConflictFormatError()
2577
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2580
# do non-implementation specific cleanup
2582
if self._control_files._lock_count == 1:
2583
# _inventory_is_modified is always False during a read lock.
2584
if self._inventory_is_modified:
2586
self._write_hashcache_if_dirty()
2587
# reverse order of locking.
2589
return self._control_files.unlock()
2591
self.branch.unlock()
2594
def get_conflicted_stem(path):
2595
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2596
if path.endswith(suffix):
2597
return path[:-len(suffix)]
2600
@deprecated_function(zero_eight)
2601
def is_control_file(filename):
2602
"""See WorkingTree.is_control_filename(filename)."""
2603
## FIXME: better check
2604
filename = normpath(filename)
2605
while filename != '':
2606
head, tail = os.path.split(filename)
2607
## mutter('check %r for control file' % ((head, tail),))
2610
if filename == head:
2616
class WorkingTreeFormat(object):
2617
"""An encapsulation of the initialization and open routines for a format.
2619
Formats provide three things:
2620
* An initialization routine,
2624
Formats are placed in an dict by their format string for reference
2625
during workingtree opening. Its not required that these be instances, they
2626
can be classes themselves with class methods - it simply depends on
2627
whether state is needed for a given format or not.
2629
Once a format is deprecated, just deprecate the initialize and open
2630
methods on the format class. Do not deprecate the object, as the
2631
object will be created every time regardless.
2634
_default_format = None
2635
"""The default format used for new trees."""
2638
"""The known formats."""
2640
requires_rich_root = False
2642
upgrade_recommended = False
2645
def find_format(klass, a_bzrdir):
2646
"""Return the format for the working tree object in a_bzrdir."""
2648
transport = a_bzrdir.get_workingtree_transport(None)
2649
format_string = transport.get("format").read()
2650
return klass._formats[format_string]
2651
except errors.NoSuchFile:
2652
raise errors.NoWorkingTree(base=transport.base)
2654
raise errors.UnknownFormatError(format=format_string)
2656
def __eq__(self, other):
2657
return self.__class__ is other.__class__
2659
def __ne__(self, other):
2660
return not (self == other)
2663
def get_default_format(klass):
2664
"""Return the current default format."""
2665
return klass._default_format
2667
def get_format_string(self):
2668
"""Return the ASCII format string that identifies this format."""
2669
raise NotImplementedError(self.get_format_string)
2671
def get_format_description(self):
2672
"""Return the short description for this format."""
2673
raise NotImplementedError(self.get_format_description)
2675
def is_supported(self):
2676
"""Is this format supported?
2678
Supported formats can be initialized and opened.
2679
Unsupported formats may not support initialization or committing or
2680
some other features depending on the reason for not being supported.
2685
def register_format(klass, format):
2686
klass._formats[format.get_format_string()] = format
2689
def set_default_format(klass, format):
2690
klass._default_format = format
2693
def unregister_format(klass, format):
2694
assert klass._formats[format.get_format_string()] is format
2695
del klass._formats[format.get_format_string()]
2698
class WorkingTreeFormat2(WorkingTreeFormat):
2699
"""The second working tree format.
2701
This format modified the hash cache from the format 1 hash cache.
2704
upgrade_recommended = True
2706
def get_format_description(self):
2707
"""See WorkingTreeFormat.get_format_description()."""
2708
return "Working tree format 2"
2710
def stub_initialize_remote(self, control_files):
2711
"""As a special workaround create critical control files for a remote working tree
2713
This ensures that it can later be updated and dealt with locally,
2714
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2715
no working tree. (See bug #43064).
2719
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2721
control_files.put('inventory', sio)
2723
control_files.put_bytes('pending-merges', '')
2726
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2727
"""See WorkingTreeFormat.initialize()."""
2728
if not isinstance(a_bzrdir.transport, LocalTransport):
2729
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2730
if from_branch is not None:
2731
branch = from_branch
2733
branch = a_bzrdir.open_branch()
2734
if revision_id is None:
2735
revision_id = _mod_revision.ensure_null(branch.last_revision())
2738
branch.generate_revision_history(revision_id)
2742
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2748
basis_tree = branch.repository.revision_tree(revision_id)
2749
if basis_tree.inventory.root is not None:
2750
wt.set_root_id(basis_tree.get_root_id())
2751
# set the parent list and cache the basis tree.
2752
if _mod_revision.is_null(revision_id):
2755
parent_trees = [(revision_id, basis_tree)]
2756
wt.set_parent_trees(parent_trees)
2757
transform.build_tree(basis_tree, wt)
2761
super(WorkingTreeFormat2, self).__init__()
2762
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2764
def open(self, a_bzrdir, _found=False):
2765
"""Return the WorkingTree object for a_bzrdir
2767
_found is a private parameter, do not use it. It is used to indicate
2768
if format probing has already been done.
2771
# we are being called directly and must probe.
2772
raise NotImplementedError
2773
if not isinstance(a_bzrdir.transport, LocalTransport):
2774
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2775
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2781
class WorkingTreeFormat3(WorkingTreeFormat):
2782
"""The second working tree format updated to record a format marker.
2785
- exists within a metadir controlling .bzr
2786
- includes an explicit version marker for the workingtree control
2787
files, separate from the BzrDir format
2788
- modifies the hash cache format
2790
- uses a LockDir to guard access for writes.
2793
upgrade_recommended = True
2795
def get_format_string(self):
2796
"""See WorkingTreeFormat.get_format_string()."""
2797
return "Bazaar-NG Working Tree format 3"
2799
def get_format_description(self):
2800
"""See WorkingTreeFormat.get_format_description()."""
2801
return "Working tree format 3"
2803
_lock_file_name = 'lock'
2804
_lock_class = LockDir
2806
_tree_class = WorkingTree3
2808
def __get_matchingbzrdir(self):
2809
return bzrdir.BzrDirMetaFormat1()
2811
_matchingbzrdir = property(__get_matchingbzrdir)
2813
def _open_control_files(self, a_bzrdir):
2814
transport = a_bzrdir.get_workingtree_transport(None)
2815
return LockableFiles(transport, self._lock_file_name,
2818
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2819
"""See WorkingTreeFormat.initialize().
2821
revision_id allows creating a working tree at a different
2822
revision than the branch is at.
2824
if not isinstance(a_bzrdir.transport, LocalTransport):
2825
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2826
transport = a_bzrdir.get_workingtree_transport(self)
2827
control_files = self._open_control_files(a_bzrdir)
2828
control_files.create_lock()
2829
control_files.lock_write()
2830
control_files.put_utf8('format', self.get_format_string())
2831
if from_branch is not None:
2832
branch = from_branch
2834
branch = a_bzrdir.open_branch()
2835
if revision_id is None:
2836
revision_id = _mod_revision.ensure_null(branch.last_revision())
2837
# WorkingTree3 can handle an inventory which has a unique root id.
2838
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2839
# those trees. And because there isn't a format bump inbetween, we
2840
# are maintaining compatibility with older clients.
2841
# inv = Inventory(root_id=gen_root_id())
2842
inv = self._initial_inventory()
2843
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2849
_control_files=control_files)
2850
wt.lock_tree_write()
2852
basis_tree = branch.repository.revision_tree(revision_id)
2853
# only set an explicit root id if there is one to set.
2854
if basis_tree.inventory.root is not None:
2855
wt.set_root_id(basis_tree.get_root_id())
2856
if revision_id == NULL_REVISION:
2857
wt.set_parent_trees([])
2859
wt.set_parent_trees([(revision_id, basis_tree)])
2860
transform.build_tree(basis_tree, wt)
2862
# Unlock in this order so that the unlock-triggers-flush in
2863
# WorkingTree is given a chance to fire.
2864
control_files.unlock()
2868
def _initial_inventory(self):
2872
super(WorkingTreeFormat3, self).__init__()
2874
def open(self, a_bzrdir, _found=False):
2875
"""Return the WorkingTree object for a_bzrdir
2877
_found is a private parameter, do not use it. It is used to indicate
2878
if format probing has already been done.
2881
# we are being called directly and must probe.
2882
raise NotImplementedError
2883
if not isinstance(a_bzrdir.transport, LocalTransport):
2884
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2885
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2888
def _open(self, a_bzrdir, control_files):
2889
"""Open the tree itself.
2891
:param a_bzrdir: the dir for the tree.
2892
:param control_files: the control files for the tree.
2894
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2898
_control_files=control_files)
2901
return self.get_format_string()
2904
__default_format = WorkingTreeFormat4()
2905
WorkingTreeFormat.register_format(__default_format)
2906
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2907
WorkingTreeFormat.set_default_format(__default_format)
2908
# formats which have no format string are not discoverable
2909
# and not independently creatable, so are not registered.
2910
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
