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,
68
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
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)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
self._flush_ignore_list_cache()
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
456
file_id = osutils.safe_file_id(file_id)
457
path = self.id2path(file_id)
458
return self.get_file_byname(path)
460
def get_file_text(self, file_id):
461
file_id = osutils.safe_file_id(file_id)
462
return self.get_file(file_id).read()
464
def get_file_byname(self, filename):
465
return file(self.abspath(filename), 'rb')
468
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
469
"""See Tree.annotate_iter
471
This implementation will use the basis tree implementation if possible.
472
Lines not in the basis are attributed to CURRENT_REVISION
474
If there are pending merges, lines added by those merges will be
475
incorrectly attributed to CURRENT_REVISION (but after committing, the
476
attribution will be correct).
478
file_id = osutils.safe_file_id(file_id)
479
basis = self.basis_tree()
482
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
483
require_versioned=True).next()
484
changed_content, kind = changes[2], changes[6]
485
if not changed_content:
486
return basis.annotate_iter(file_id)
490
if kind[0] != 'file':
493
old_lines = list(basis.annotate_iter(file_id))
495
for tree in self.branch.repository.revision_trees(
496
self.get_parent_ids()[1:]):
497
if file_id not in tree:
499
old.append(list(tree.annotate_iter(file_id)))
500
return annotate.reannotate(old, self.get_file(file_id).readlines(),
505
def _get_ancestors(self, default_revision):
506
ancestors = set([default_revision])
507
for parent_id in self.get_parent_ids():
508
ancestors.update(self.branch.repository.get_ancestry(
509
parent_id, topo_sorted=False))
512
def get_parent_ids(self):
513
"""See Tree.get_parent_ids.
515
This implementation reads the pending merges list and last_revision
516
value and uses that to decide what the parents list should be.
518
last_rev = _mod_revision.ensure_null(self._last_revision())
519
if _mod_revision.NULL_REVISION == last_rev:
524
merges_file = self._control_files.get('pending-merges')
525
except errors.NoSuchFile:
528
for l in merges_file.readlines():
529
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
530
parents.append(revision_id)
534
def get_root_id(self):
535
"""Return the id of this trees root"""
536
return self._inventory.root.file_id
538
def _get_store_filename(self, file_id):
539
## XXX: badly named; this is not in the store at all
540
file_id = osutils.safe_file_id(file_id)
541
return self.abspath(self.id2path(file_id))
544
def clone(self, to_bzrdir, revision_id=None):
545
"""Duplicate this working tree into to_bzr, including all state.
547
Specifically modified files are kept as modified, but
548
ignored and unknown files are discarded.
550
If you want to make a new line of development, see bzrdir.sprout()
553
If not None, the cloned tree will have its last revision set to
554
revision, and and difference between the source trees last revision
555
and this one merged in.
557
# assumes the target bzr dir format is compatible.
558
result = self._format.initialize(to_bzrdir)
559
self.copy_content_into(result, revision_id)
563
def copy_content_into(self, tree, revision_id=None):
564
"""Copy the current content and user files of this tree into tree."""
565
tree.set_root_id(self.get_root_id())
566
if revision_id is None:
567
merge.transform_tree(tree, self)
569
# TODO now merge from tree.last_revision to revision (to preserve
570
# user local changes)
571
merge.transform_tree(tree, self)
572
tree.set_parent_ids([revision_id])
574
def id2abspath(self, file_id):
575
file_id = osutils.safe_file_id(file_id)
576
return self.abspath(self.id2path(file_id))
578
def has_id(self, file_id):
579
# files that have been deleted are excluded
580
file_id = osutils.safe_file_id(file_id)
582
if not inv.has_id(file_id):
584
path = inv.id2path(file_id)
585
return osutils.lexists(self.abspath(path))
587
def has_or_had_id(self, file_id):
588
file_id = osutils.safe_file_id(file_id)
589
if file_id == self.inventory.root.file_id:
591
return self.inventory.has_id(file_id)
593
__contains__ = has_id
595
def get_file_size(self, file_id):
596
file_id = osutils.safe_file_id(file_id)
597
return os.path.getsize(self.id2abspath(file_id))
600
def get_file_sha1(self, file_id, path=None, stat_value=None):
601
file_id = osutils.safe_file_id(file_id)
603
path = self._inventory.id2path(file_id)
604
return self._hashcache.get_sha1(path, stat_value)
606
def get_file_mtime(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
609
path = self.inventory.id2path(file_id)
610
return os.lstat(self.abspath(path)).st_mtime
612
if not supports_executable():
613
def is_executable(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
615
return self._inventory[file_id].executable
617
def is_executable(self, file_id, path=None):
619
file_id = osutils.safe_file_id(file_id)
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
@needs_tree_write_lock
625
def _add(self, files, ids, kinds):
626
"""See MutableTree._add."""
627
# TODO: Re-adding a file that is removed in the working copy
628
# should probably put it back with the previous ID.
629
# the read and write working inventory should not occur in this
630
# function - they should be part of lock_write and unlock.
632
for f, file_id, kind in zip(files, ids, kinds):
633
assert kind is not None
635
inv.add_path(f, kind=kind)
637
file_id = osutils.safe_file_id(file_id)
638
inv.add_path(f, kind=kind, file_id=file_id)
639
self._inventory_is_modified = True
641
@needs_tree_write_lock
642
def _gather_kinds(self, files, kinds):
643
"""See MutableTree._gather_kinds."""
644
for pos, f in enumerate(files):
645
if kinds[pos] is None:
646
fullpath = normpath(self.abspath(f))
648
kinds[pos] = file_kind(fullpath)
650
if e.errno == errno.ENOENT:
651
raise errors.NoSuchFile(fullpath)
654
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
655
"""Add revision_id as a parent.
657
This is equivalent to retrieving the current list of parent ids
658
and setting the list to its value plus revision_id.
660
:param revision_id: The revision id to add to the parent list. It may
661
be a ghost revision as long as its not the first parent to be added,
662
or the allow_leftmost_as_ghost parameter is set True.
663
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
parents = self.get_parent_ids() + [revision_id]
666
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
667
or allow_leftmost_as_ghost)
669
@needs_tree_write_lock
670
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
671
"""Add revision_id, tree tuple as a parent.
673
This is equivalent to retrieving the current list of parent trees
674
and setting the list to its value plus parent_tuple. See also
675
add_parent_tree_id - if you only have a parent id available it will be
676
simpler to use that api. If you have the parent already available, using
677
this api is preferred.
679
:param parent_tuple: The (revision id, tree) to add to the parent list.
680
If the revision_id is a ghost, pass None for the tree.
681
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
683
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
684
if len(parent_ids) > 1:
685
# the leftmost may have already been a ghost, preserve that if it
687
allow_leftmost_as_ghost = True
688
self.set_parent_ids(parent_ids,
689
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
691
@needs_tree_write_lock
692
def add_pending_merge(self, *revision_ids):
693
# TODO: Perhaps should check at this point that the
694
# history of the revision is actually present?
695
parents = self.get_parent_ids()
697
for rev_id in revision_ids:
698
if rev_id in parents:
700
parents.append(rev_id)
703
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
705
def path_content_summary(self, path, _lstat=os.lstat,
706
_mapper=osutils.file_kind_from_stat_mode):
707
"""See Tree.path_content_summary."""
708
abspath = self.abspath(path)
710
stat_result = _lstat(abspath)
712
if getattr(e, 'errno', None) == errno.ENOENT:
714
return ('missing', None, None, None)
715
# propogate other errors
717
kind = _mapper(stat_result.st_mode)
719
size = stat_result.st_size
720
# try for a stat cache lookup
721
if not supports_executable():
722
executable = None # caller can decide policy.
724
mode = stat_result.st_mode
725
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
726
sha1 = None # 'stat-hit-check' here
727
return (kind, size, executable, sha1)
728
elif kind == 'directory':
729
# perhaps it looks like a plain directory, but it's really a
731
if self._directory_is_tree_reference(path):
732
kind = 'tree-reference'
733
return kind, None, None, None
734
elif kind == 'symlink':
735
return ('symlink', None, None, os.readlink(abspath))
737
return (kind, None, None, None)
739
@deprecated_method(zero_eleven)
741
def pending_merges(self):
742
"""Return a list of pending merges.
744
These are revisions that have been merged into the working
745
directory but not yet committed.
747
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
748
instead - which is available on all tree objects.
750
return self.get_parent_ids()[1:]
752
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
753
"""Common ghost checking functionality from set_parent_*.
755
This checks that the left hand-parent exists if there are any
758
if len(revision_ids) > 0:
759
leftmost_id = revision_ids[0]
760
if (not allow_leftmost_as_ghost and not
761
self.branch.repository.has_revision(leftmost_id)):
762
raise errors.GhostRevisionUnusableHere(leftmost_id)
764
def _set_merges_from_parent_ids(self, parent_ids):
765
merges = parent_ids[1:]
766
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
768
@needs_tree_write_lock
769
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
770
"""Set the parent ids to revision_ids.
772
See also set_parent_trees. This api will try to retrieve the tree data
773
for each element of revision_ids from the trees repository. If you have
774
tree data already available, it is more efficient to use
775
set_parent_trees rather than set_parent_ids. set_parent_ids is however
776
an easier API to use.
778
:param revision_ids: The revision_ids to set as the parent ids of this
779
working tree. Any of these may be ghosts.
781
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
782
self._check_parents_for_ghosts(revision_ids,
783
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
784
for revision_id in revision_ids:
785
_mod_revision.check_not_reserved_id(revision_id)
787
if len(revision_ids) > 0:
788
self.set_last_revision(revision_ids[0])
790
self.set_last_revision(_mod_revision.NULL_REVISION)
792
self._set_merges_from_parent_ids(revision_ids)
794
@needs_tree_write_lock
795
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
796
"""See MutableTree.set_parent_trees."""
797
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
798
for revision_id in parent_ids:
799
_mod_revision.check_not_reserved_id(revision_id)
801
self._check_parents_for_ghosts(parent_ids,
802
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
804
if len(parent_ids) == 0:
805
leftmost_parent_id = _mod_revision.NULL_REVISION
806
leftmost_parent_tree = None
808
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
810
if self._change_last_revision(leftmost_parent_id):
811
if leftmost_parent_tree is None:
812
# If we don't have a tree, fall back to reading the
813
# parent tree from the repository.
814
self._cache_basis_inventory(leftmost_parent_id)
816
inv = leftmost_parent_tree.inventory
817
xml = self._create_basis_xml_from_inventory(
818
leftmost_parent_id, inv)
819
self._write_basis_inventory(xml)
820
self._set_merges_from_parent_ids(parent_ids)
822
@needs_tree_write_lock
823
def set_pending_merges(self, rev_list):
824
parents = self.get_parent_ids()
825
leftmost = parents[:1]
826
new_parents = leftmost + rev_list
827
self.set_parent_ids(new_parents)
829
@needs_tree_write_lock
830
def set_merge_modified(self, modified_hashes):
832
for file_id, hash in modified_hashes.iteritems():
833
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
834
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
836
def _put_rio(self, filename, stanzas, header):
837
self._must_be_locked()
838
my_file = rio_file(stanzas, header)
839
self._control_files.put(filename, my_file)
841
@needs_write_lock # because merge pulls data into the branch.
842
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
844
"""Merge from a branch into this working tree.
846
:param branch: The branch to merge from.
847
:param to_revision: If non-None, the merge will merge to to_revision,
848
but not beyond it. to_revision does not need to be in the history
849
of the branch when it is supplied. If None, to_revision defaults to
850
branch.last_revision().
852
from bzrlib.merge import Merger, Merge3Merger
853
pb = bzrlib.ui.ui_factory.nested_progress_bar()
855
merger = Merger(self.branch, this_tree=self, pb=pb)
856
merger.pp = ProgressPhase("Merge phase", 5, pb)
857
merger.pp.next_phase()
858
# check that there are no
860
merger.check_basis(check_clean=True, require_commits=False)
861
if to_revision is None:
862
to_revision = _mod_revision.ensure_null(branch.last_revision())
864
to_revision = osutils.safe_revision_id(to_revision)
865
merger.other_rev_id = to_revision
866
if _mod_revision.is_null(merger.other_rev_id):
867
raise errors.NoCommits(branch)
868
self.branch.fetch(branch, last_revision=merger.other_rev_id)
869
merger.other_basis = merger.other_rev_id
870
merger.other_tree = self.branch.repository.revision_tree(
872
merger.other_branch = branch
873
merger.pp.next_phase()
874
if from_revision is None:
877
merger.set_base_revision(from_revision, branch)
878
if merger.base_rev_id == merger.other_rev_id:
879
raise errors.PointlessMerge
880
merger.backup_files = False
881
if merge_type is None:
882
merger.merge_type = Merge3Merger
884
merger.merge_type = merge_type
885
merger.set_interesting_files(None)
886
merger.show_base = False
887
merger.reprocess = False
888
conflicts = merger.do_merge()
895
def merge_modified(self):
896
"""Return a dictionary of files modified by a merge.
898
The list is initialized by WorkingTree.set_merge_modified, which is
899
typically called after we make some automatic updates to the tree
902
This returns a map of file_id->sha1, containing only files which are
903
still in the working inventory and have that text hash.
906
hashfile = self._control_files.get('merge-hashes')
907
except errors.NoSuchFile:
911
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
912
raise errors.MergeModifiedFormatError()
913
except StopIteration:
914
raise errors.MergeModifiedFormatError()
915
for s in RioReader(hashfile):
916
# RioReader reads in Unicode, so convert file_ids back to utf8
917
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
918
if file_id not in self.inventory:
920
text_hash = s.get("hash")
921
if text_hash == self.get_file_sha1(file_id):
922
merge_hashes[file_id] = text_hash
926
def mkdir(self, path, file_id=None):
927
"""See MutableTree.mkdir()."""
929
file_id = generate_ids.gen_file_id(os.path.basename(path))
930
os.mkdir(self.abspath(path))
931
self.add(path, file_id, 'directory')
934
def get_symlink_target(self, file_id):
935
file_id = osutils.safe_file_id(file_id)
936
return os.readlink(self.id2abspath(file_id))
939
def subsume(self, other_tree):
940
def add_children(inventory, entry):
941
for child_entry in entry.children.values():
942
inventory._byid[child_entry.file_id] = child_entry
943
if child_entry.kind == 'directory':
944
add_children(inventory, child_entry)
945
if other_tree.get_root_id() == self.get_root_id():
946
raise errors.BadSubsumeSource(self, other_tree,
947
'Trees have the same root')
949
other_tree_path = self.relpath(other_tree.basedir)
950
except errors.PathNotChild:
951
raise errors.BadSubsumeSource(self, other_tree,
952
'Tree is not contained by the other')
953
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
954
if new_root_parent is None:
955
raise errors.BadSubsumeSource(self, other_tree,
956
'Parent directory is not versioned.')
957
# We need to ensure that the result of a fetch will have a
958
# versionedfile for the other_tree root, and only fetching into
959
# RepositoryKnit2 guarantees that.
960
if not self.branch.repository.supports_rich_root():
961
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
962
other_tree.lock_tree_write()
964
new_parents = other_tree.get_parent_ids()
965
other_root = other_tree.inventory.root
966
other_root.parent_id = new_root_parent
967
other_root.name = osutils.basename(other_tree_path)
968
self.inventory.add(other_root)
969
add_children(self.inventory, other_root)
970
self._write_inventory(self.inventory)
971
# normally we don't want to fetch whole repositories, but i think
972
# here we really do want to consolidate the whole thing.
973
for parent_id in other_tree.get_parent_ids():
974
self.branch.fetch(other_tree.branch, parent_id)
975
self.add_parent_tree_id(parent_id)
978
other_tree.bzrdir.retire_bzrdir()
980
def _directory_is_tree_reference(self, relpath):
981
# as a special case, if a directory contains control files then
982
# it's a tree reference, except that the root of the tree is not
983
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
984
# TODO: We could ask all the control formats whether they
985
# recognize this directory, but at the moment there's no cheap api
986
# to do that. Since we probably can only nest bzr checkouts and
987
# they always use this name it's ok for now. -- mbp 20060306
989
# FIXME: There is an unhandled case here of a subdirectory
990
# containing .bzr but not a branch; that will probably blow up
991
# when you try to commit it. It might happen if there is a
992
# checkout in a subdirectory. This can be avoided by not adding
995
@needs_tree_write_lock
996
def extract(self, file_id, format=None):
997
"""Extract a subtree from this tree.
999
A new branch will be created, relative to the path for this tree.
1003
segments = osutils.splitpath(path)
1004
transport = self.branch.bzrdir.root_transport
1005
for name in segments:
1006
transport = transport.clone(name)
1007
transport.ensure_base()
1010
sub_path = self.id2path(file_id)
1011
branch_transport = mkdirs(sub_path)
1013
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1014
branch_transport.ensure_base()
1015
branch_bzrdir = format.initialize_on_transport(branch_transport)
1017
repo = branch_bzrdir.find_repository()
1018
except errors.NoRepositoryPresent:
1019
repo = branch_bzrdir.create_repository()
1020
assert repo.supports_rich_root()
1022
if not repo.supports_rich_root():
1023
raise errors.RootNotRich()
1024
new_branch = branch_bzrdir.create_branch()
1025
new_branch.pull(self.branch)
1026
for parent_id in self.get_parent_ids():
1027
new_branch.fetch(self.branch, parent_id)
1028
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1029
if tree_transport.base != branch_transport.base:
1030
tree_bzrdir = format.initialize_on_transport(tree_transport)
1031
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1033
tree_bzrdir = branch_bzrdir
1034
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1035
wt.set_parent_ids(self.get_parent_ids())
1036
my_inv = self.inventory
1037
child_inv = Inventory(root_id=None)
1038
new_root = my_inv[file_id]
1039
my_inv.remove_recursive_id(file_id)
1040
new_root.parent_id = None
1041
child_inv.add(new_root)
1042
self._write_inventory(my_inv)
1043
wt._write_inventory(child_inv)
1046
def _serialize(self, inventory, out_file):
1047
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1049
def _deserialize(selt, in_file):
1050
return xml5.serializer_v5.read_inventory(in_file)
1053
"""Write the in memory inventory to disk."""
1054
# TODO: Maybe this should only write on dirty ?
1055
if self._control_files._lock_mode != 'w':
1056
raise errors.NotWriteLocked(self)
1058
self._serialize(self._inventory, sio)
1060
self._control_files.put('inventory', sio)
1061
self._inventory_is_modified = False
1063
def _kind(self, relpath):
1064
return osutils.file_kind(self.abspath(relpath))
1066
def list_files(self, include_root=False):
1067
"""Recursively list all files as (path, class, kind, id, entry).
1069
Lists, but does not descend into unversioned directories.
1071
This does not include files that have been deleted in this
1074
Skips the control directory.
1076
# list_files is an iterator, so @needs_read_lock doesn't work properly
1077
# with it. So callers should be careful to always read_lock the tree.
1078
if not self.is_locked():
1079
raise errors.ObjectNotLocked(self)
1081
inv = self.inventory
1082
if include_root is True:
1083
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1084
# Convert these into local objects to save lookup times
1085
pathjoin = osutils.pathjoin
1086
file_kind = self._kind
1088
# transport.base ends in a slash, we want the piece
1089
# between the last two slashes
1090
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1092
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1094
# directory file_id, relative path, absolute path, reverse sorted children
1095
children = os.listdir(self.basedir)
1097
# jam 20060527 The kernel sized tree seems equivalent whether we
1098
# use a deque and popleft to keep them sorted, or if we use a plain
1099
# list and just reverse() them.
1100
children = collections.deque(children)
1101
stack = [(inv.root.file_id, u'', self.basedir, children)]
1103
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1106
f = children.popleft()
1107
## TODO: If we find a subdirectory with its own .bzr
1108
## directory, then that is a separate tree and we
1109
## should exclude it.
1111
# the bzrdir for this tree
1112
if transport_base_dir == f:
1115
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1116
# and 'f' doesn't begin with one, we can do a string op, rather
1117
# than the checks of pathjoin(), all relative paths will have an extra slash
1119
fp = from_dir_relpath + '/' + f
1122
fap = from_dir_abspath + '/' + f
1124
f_ie = inv.get_child(from_dir_id, f)
1127
elif self.is_ignored(fp[1:]):
1130
# we may not have found this file, because of a unicode issue
1131
f_norm, can_access = osutils.normalized_filename(f)
1132
if f == f_norm or not can_access:
1133
# No change, so treat this file normally
1136
# this file can be accessed by a normalized path
1137
# check again if it is versioned
1138
# these lines are repeated here for performance
1140
fp = from_dir_relpath + '/' + f
1141
fap = from_dir_abspath + '/' + f
1142
f_ie = inv.get_child(from_dir_id, f)
1145
elif self.is_ignored(fp[1:]):
1152
# make a last minute entry
1154
yield fp[1:], c, fk, f_ie.file_id, f_ie
1157
yield fp[1:], c, fk, None, fk_entries[fk]()
1159
yield fp[1:], c, fk, None, TreeEntry()
1162
if fk != 'directory':
1165
# But do this child first
1166
new_children = os.listdir(fap)
1168
new_children = collections.deque(new_children)
1169
stack.append((f_ie.file_id, fp, fap, new_children))
1170
# Break out of inner loop,
1171
# so that we start outer loop with child
1174
# if we finished all children, pop it off the stack
1177
@needs_tree_write_lock
1178
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1181
to_dir must exist in the inventory.
1183
If to_dir exists and is a directory, the files are moved into
1184
it, keeping their old names.
1186
Note that to_dir is only the last component of the new name;
1187
this doesn't change the directory.
1189
For each entry in from_paths the move mode will be determined
1192
The first mode moves the file in the filesystem and updates the
1193
inventory. The second mode only updates the inventory without
1194
touching the file on the filesystem. This is the new mode introduced
1197
move uses the second mode if 'after == True' and the target is not
1198
versioned but present in the working tree.
1200
move uses the second mode if 'after == False' and the source is
1201
versioned but no longer in the working tree, and the target is not
1202
versioned but present in the working tree.
1204
move uses the first mode if 'after == False' and the source is
1205
versioned and present in the working tree, and the target is not
1206
versioned and not present in the working tree.
1208
Everything else results in an error.
1210
This returns a list of (from_path, to_path) pairs for each
1211
entry that is moved.
1216
# check for deprecated use of signature
1218
to_dir = kwargs.get('to_name', None)
1220
raise TypeError('You must supply a target directory')
1222
symbol_versioning.warn('The parameter to_name was deprecated'
1223
' in version 0.13. Use to_dir instead',
1226
# check destination directory
1227
assert not isinstance(from_paths, basestring)
1228
inv = self.inventory
1229
to_abs = self.abspath(to_dir)
1230
if not isdir(to_abs):
1231
raise errors.BzrMoveFailedError('',to_dir,
1232
errors.NotADirectory(to_abs))
1233
if not self.has_filename(to_dir):
1234
raise errors.BzrMoveFailedError('',to_dir,
1235
errors.NotInWorkingDirectory(to_dir))
1236
to_dir_id = inv.path2id(to_dir)
1237
if to_dir_id is None:
1238
raise errors.BzrMoveFailedError('',to_dir,
1239
errors.NotVersionedError(path=str(to_dir)))
1241
to_dir_ie = inv[to_dir_id]
1242
if to_dir_ie.kind != 'directory':
1243
raise errors.BzrMoveFailedError('',to_dir,
1244
errors.NotADirectory(to_abs))
1246
# create rename entries and tuples
1247
for from_rel in from_paths:
1248
from_tail = splitpath(from_rel)[-1]
1249
from_id = inv.path2id(from_rel)
1251
raise errors.BzrMoveFailedError(from_rel,to_dir,
1252
errors.NotVersionedError(path=str(from_rel)))
1254
from_entry = inv[from_id]
1255
from_parent_id = from_entry.parent_id
1256
to_rel = pathjoin(to_dir, from_tail)
1257
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1259
from_tail=from_tail,
1260
from_parent_id=from_parent_id,
1261
to_rel=to_rel, to_tail=from_tail,
1262
to_parent_id=to_dir_id)
1263
rename_entries.append(rename_entry)
1264
rename_tuples.append((from_rel, to_rel))
1266
# determine which move mode to use. checks also for movability
1267
rename_entries = self._determine_mv_mode(rename_entries, after)
1269
original_modified = self._inventory_is_modified
1272
self._inventory_is_modified = True
1273
self._move(rename_entries)
1275
# restore the inventory on error
1276
self._inventory_is_modified = original_modified
1278
self._write_inventory(inv)
1279
return rename_tuples
1281
def _determine_mv_mode(self, rename_entries, after=False):
1282
"""Determines for each from-to pair if both inventory and working tree
1283
or only the inventory has to be changed.
1285
Also does basic plausability tests.
1287
inv = self.inventory
1289
for rename_entry in rename_entries:
1290
# store to local variables for easier reference
1291
from_rel = rename_entry.from_rel
1292
from_id = rename_entry.from_id
1293
to_rel = rename_entry.to_rel
1294
to_id = inv.path2id(to_rel)
1295
only_change_inv = False
1297
# check the inventory for source and destination
1299
raise errors.BzrMoveFailedError(from_rel,to_rel,
1300
errors.NotVersionedError(path=str(from_rel)))
1301
if to_id is not None:
1302
raise errors.BzrMoveFailedError(from_rel,to_rel,
1303
errors.AlreadyVersionedError(path=str(to_rel)))
1305
# try to determine the mode for rename (only change inv or change
1306
# inv and file system)
1308
if not self.has_filename(to_rel):
1309
raise errors.BzrMoveFailedError(from_id,to_rel,
1310
errors.NoSuchFile(path=str(to_rel),
1311
extra="New file has not been created yet"))
1312
only_change_inv = True
1313
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1314
only_change_inv = True
1315
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1316
only_change_inv = False
1318
# something is wrong, so lets determine what exactly
1319
if not self.has_filename(from_rel) and \
1320
not self.has_filename(to_rel):
1321
raise errors.BzrRenameFailedError(from_rel,to_rel,
1322
errors.PathsDoNotExist(paths=(str(from_rel),
1325
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1326
extra="(Use --after to update the Bazaar id)")
1327
rename_entry.only_change_inv = only_change_inv
1328
return rename_entries
1330
def _move(self, rename_entries):
1331
"""Moves a list of files.
1333
Depending on the value of the flag 'only_change_inv', the
1334
file will be moved on the file system or not.
1336
inv = self.inventory
1339
for entry in rename_entries:
1341
self._move_entry(entry)
1343
self._rollback_move(moved)
1347
def _rollback_move(self, moved):
1348
"""Try to rollback a previous move in case of an filesystem error."""
1349
inv = self.inventory
1352
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1353
entry.to_tail, entry.to_parent_id, entry.from_rel,
1354
entry.from_tail, entry.from_parent_id,
1355
entry.only_change_inv))
1356
except errors.BzrMoveFailedError, e:
1357
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1358
" The working tree is in an inconsistent state."
1359
" Please consider doing a 'bzr revert'."
1360
" Error message is: %s" % e)
1362
def _move_entry(self, entry):
1363
inv = self.inventory
1364
from_rel_abs = self.abspath(entry.from_rel)
1365
to_rel_abs = self.abspath(entry.to_rel)
1366
if from_rel_abs == to_rel_abs:
1367
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1368
"Source and target are identical.")
1370
if not entry.only_change_inv:
1372
osutils.rename(from_rel_abs, to_rel_abs)
1374
raise errors.BzrMoveFailedError(entry.from_rel,
1376
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1378
@needs_tree_write_lock
1379
def rename_one(self, from_rel, to_rel, after=False):
1382
This can change the directory or the filename or both.
1384
rename_one has several 'modes' to work. First, it can rename a physical
1385
file and change the file_id. That is the normal mode. Second, it can
1386
only change the file_id without touching any physical file. This is
1387
the new mode introduced in version 0.15.
1389
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1390
versioned but present in the working tree.
1392
rename_one uses the second mode if 'after == False' and 'from_rel' is
1393
versioned but no longer in the working tree, and 'to_rel' is not
1394
versioned but present in the working tree.
1396
rename_one uses the first mode if 'after == False' and 'from_rel' is
1397
versioned and present in the working tree, and 'to_rel' is not
1398
versioned and not present in the working tree.
1400
Everything else results in an error.
1402
inv = self.inventory
1405
# create rename entries and tuples
1406
from_tail = splitpath(from_rel)[-1]
1407
from_id = inv.path2id(from_rel)
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.NotVersionedError(path=str(from_rel)))
1411
from_entry = inv[from_id]
1412
from_parent_id = from_entry.parent_id
1413
to_dir, to_tail = os.path.split(to_rel)
1414
to_dir_id = inv.path2id(to_dir)
1415
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1417
from_tail=from_tail,
1418
from_parent_id=from_parent_id,
1419
to_rel=to_rel, to_tail=to_tail,
1420
to_parent_id=to_dir_id)
1421
rename_entries.append(rename_entry)
1423
# determine which move mode to use. checks also for movability
1424
rename_entries = self._determine_mv_mode(rename_entries, after)
1426
# check if the target changed directory and if the target directory is
1428
if to_dir_id is None:
1429
raise errors.BzrMoveFailedError(from_rel,to_rel,
1430
errors.NotVersionedError(path=str(to_dir)))
1432
# all checks done. now we can continue with our actual work
1433
mutter('rename_one:\n'
1438
' to_dir_id {%s}\n',
1439
from_id, from_rel, to_rel, to_dir, to_dir_id)
1441
self._move(rename_entries)
1442
self._write_inventory(inv)
1444
class _RenameEntry(object):
1445
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1446
to_rel, to_tail, to_parent_id, only_change_inv=False):
1447
self.from_rel = from_rel
1448
self.from_id = from_id
1449
self.from_tail = from_tail
1450
self.from_parent_id = from_parent_id
1451
self.to_rel = to_rel
1452
self.to_tail = to_tail
1453
self.to_parent_id = to_parent_id
1454
self.only_change_inv = only_change_inv
1458
"""Return all unknown files.
1460
These are files in the working directory that are not versioned or
1461
control files or ignored.
1463
# force the extras method to be fully executed before returning, to
1464
# prevent race conditions with the lock
1466
[subp for subp in self.extras() if not self.is_ignored(subp)])
1468
@needs_tree_write_lock
1469
def unversion(self, file_ids):
1470
"""Remove the file ids in file_ids from the current versioned set.
1472
When a file_id is unversioned, all of its children are automatically
1475
:param file_ids: The file ids to stop versioning.
1476
:raises: NoSuchId if any fileid is not currently versioned.
1478
for file_id in file_ids:
1479
file_id = osutils.safe_file_id(file_id)
1480
if self._inventory.has_id(file_id):
1481
self._inventory.remove_recursive_id(file_id)
1483
raise errors.NoSuchId(self, file_id)
1485
# in the future this should just set a dirty bit to wait for the
1486
# final unlock. However, until all methods of workingtree start
1487
# with the current in -memory inventory rather than triggering
1488
# a read, it is more complex - we need to teach read_inventory
1489
# to know when to read, and when to not read first... and possibly
1490
# to save first when the in memory one may be corrupted.
1491
# so for now, we just only write it if it is indeed dirty.
1493
self._write_inventory(self._inventory)
1495
@deprecated_method(zero_eight)
1496
def iter_conflicts(self):
1497
"""List all files in the tree that have text or content conflicts.
1498
DEPRECATED. Use conflicts instead."""
1499
return self._iter_conflicts()
1501
def _iter_conflicts(self):
1503
for info in self.list_files():
1505
stem = get_conflicted_stem(path)
1508
if stem not in conflicted:
1509
conflicted.add(stem)
1513
def pull(self, source, overwrite=False, stop_revision=None,
1514
change_reporter=None):
1515
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1518
pp = ProgressPhase("Pull phase", 2, top_pb)
1520
old_revision_info = self.branch.last_revision_info()
1521
basis_tree = self.basis_tree()
1522
count = self.branch.pull(source, overwrite, stop_revision)
1523
new_revision_info = self.branch.last_revision_info()
1524
if new_revision_info != old_revision_info:
1526
repository = self.branch.repository
1527
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1528
basis_tree.lock_read()
1530
new_basis_tree = self.branch.basis_tree()
1537
change_reporter=change_reporter)
1538
if (basis_tree.inventory.root is None and
1539
new_basis_tree.inventory.root is not None):
1540
self.set_root_id(new_basis_tree.inventory.root.file_id)
1544
# TODO - dedup parents list with things merged by pull ?
1545
# reuse the revisiontree we merged against to set the new
1547
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1548
# we have to pull the merge trees out again, because
1549
# merge_inner has set the ids. - this corner is not yet
1550
# layered well enough to prevent double handling.
1551
# XXX TODO: Fix the double handling: telling the tree about
1552
# the already known parent data is wasteful.
1553
merges = self.get_parent_ids()[1:]
1554
parent_trees.extend([
1555
(parent, repository.revision_tree(parent)) for
1557
self.set_parent_trees(parent_trees)
1564
def put_file_bytes_non_atomic(self, file_id, bytes):
1565
"""See MutableTree.put_file_bytes_non_atomic."""
1566
file_id = osutils.safe_file_id(file_id)
1567
stream = file(self.id2abspath(file_id), 'wb')
1572
# TODO: update the hashcache here ?
1575
"""Yield all unversioned files in this WorkingTree.
1577
If there are any unversioned directories then only the directory is
1578
returned, not all its children. But if there are unversioned files
1579
under a versioned subdirectory, they are returned.
1581
Currently returned depth-first, sorted by name within directories.
1582
This is the same order used by 'osutils.walkdirs'.
1584
## TODO: Work from given directory downwards
1585
for path, dir_entry in self.inventory.directories():
1586
# mutter("search for unknowns in %r", path)
1587
dirabs = self.abspath(path)
1588
if not isdir(dirabs):
1589
# e.g. directory deleted
1593
for subf in os.listdir(dirabs):
1596
if subf not in dir_entry.children:
1597
subf_norm, can_access = osutils.normalized_filename(subf)
1598
if subf_norm != subf and can_access:
1599
if subf_norm not in dir_entry.children:
1600
fl.append(subf_norm)
1606
subp = pathjoin(path, subf)
1609
def ignored_files(self):
1610
"""Yield list of PATH, IGNORE_PATTERN"""
1611
for subp in self.extras():
1612
pat = self.is_ignored(subp)
1616
def get_ignore_list(self):
1617
"""Return list of ignore patterns.
1619
Cached in the Tree object after the first call.
1621
ignoreset = getattr(self, '_ignoreset', None)
1622
if ignoreset is not None:
1625
ignore_globs = set()
1626
ignore_globs.update(ignores.get_runtime_ignores())
1627
ignore_globs.update(ignores.get_user_ignores())
1628
if self.has_filename(bzrlib.IGNORE_FILENAME):
1629
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1631
ignore_globs.update(ignores.parse_ignore_file(f))
1634
self._ignoreset = ignore_globs
1637
def _flush_ignore_list_cache(self):
1638
"""Resets the cached ignore list to force a cache rebuild."""
1639
self._ignoreset = None
1640
self._ignoreglobster = None
1642
def is_ignored(self, filename):
1643
r"""Check whether the filename matches an ignore pattern.
1645
Patterns containing '/' or '\' need to match the whole path;
1646
others match against only the last component.
1648
If the file is ignored, returns the pattern which caused it to
1649
be ignored, otherwise None. So this can simply be used as a
1650
boolean if desired."""
1651
if getattr(self, '_ignoreglobster', None) is None:
1652
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1653
return self._ignoreglobster.match(filename)
1655
def kind(self, file_id):
1656
return file_kind(self.id2abspath(file_id))
1658
def _comparison_data(self, entry, path):
1659
abspath = self.abspath(path)
1661
stat_value = os.lstat(abspath)
1663
if getattr(e, 'errno', None) == errno.ENOENT:
1670
mode = stat_value.st_mode
1671
kind = osutils.file_kind_from_stat_mode(mode)
1672
if not supports_executable():
1673
executable = entry is not None and entry.executable
1675
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1676
return kind, executable, stat_value
1678
def _file_size(self, entry, stat_value):
1679
return stat_value.st_size
1681
def last_revision(self):
1682
"""Return the last revision of the branch for this tree.
1684
This format tree does not support a separate marker for last-revision
1685
compared to the branch.
1687
See MutableTree.last_revision
1689
return self._last_revision()
1692
def _last_revision(self):
1693
"""helper for get_parent_ids."""
1694
return _mod_revision.ensure_null(self.branch.last_revision())
1696
def is_locked(self):
1697
return self._control_files.is_locked()
1699
def _must_be_locked(self):
1700
if not self.is_locked():
1701
raise errors.ObjectNotLocked(self)
1703
def lock_read(self):
1704
"""See Branch.lock_read, and WorkingTree.unlock."""
1705
if not self.is_locked():
1707
self.branch.lock_read()
1709
return self._control_files.lock_read()
1711
self.branch.unlock()
1714
def lock_tree_write(self):
1715
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1716
if not self.is_locked():
1718
self.branch.lock_read()
1720
return self._control_files.lock_write()
1722
self.branch.unlock()
1725
def lock_write(self):
1726
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1727
if not self.is_locked():
1729
self.branch.lock_write()
1731
return self._control_files.lock_write()
1733
self.branch.unlock()
1736
def get_physical_lock_status(self):
1737
return self._control_files.get_physical_lock_status()
1739
def _basis_inventory_name(self):
1740
return 'basis-inventory-cache'
1742
def _reset_data(self):
1743
"""Reset transient data that cannot be revalidated."""
1744
self._inventory_is_modified = False
1745
result = self._deserialize(self._control_files.get('inventory'))
1746
self._set_inventory(result, dirty=False)
1748
@needs_tree_write_lock
1749
def set_last_revision(self, new_revision):
1750
"""Change the last revision in the working tree."""
1751
new_revision = osutils.safe_revision_id(new_revision)
1752
if self._change_last_revision(new_revision):
1753
self._cache_basis_inventory(new_revision)
1755
def _change_last_revision(self, new_revision):
1756
"""Template method part of set_last_revision to perform the change.
1758
This is used to allow WorkingTree3 instances to not affect branch
1759
when their last revision is set.
1761
if _mod_revision.is_null(new_revision):
1762
self.branch.set_revision_history([])
1765
self.branch.generate_revision_history(new_revision)
1766
except errors.NoSuchRevision:
1767
# not present in the repo - dont try to set it deeper than the tip
1768
self.branch.set_revision_history([new_revision])
1771
def _write_basis_inventory(self, xml):
1772
"""Write the basis inventory XML to the basis-inventory file"""
1773
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1774
path = self._basis_inventory_name()
1776
self._control_files.put(path, sio)
1778
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1779
"""Create the text that will be saved in basis-inventory"""
1780
# TODO: jam 20070209 This should be redundant, as the revision_id
1781
# as all callers should have already converted the revision_id to
1783
inventory.revision_id = osutils.safe_revision_id(revision_id)
1784
return xml7.serializer_v7.write_inventory_to_string(inventory)
1786
def _cache_basis_inventory(self, new_revision):
1787
"""Cache new_revision as the basis inventory."""
1788
# TODO: this should allow the ready-to-use inventory to be passed in,
1789
# as commit already has that ready-to-use [while the format is the
1792
# this double handles the inventory - unpack and repack -
1793
# but is easier to understand. We can/should put a conditional
1794
# in here based on whether the inventory is in the latest format
1795
# - perhaps we should repack all inventories on a repository
1797
# the fast path is to copy the raw xml from the repository. If the
1798
# xml contains 'revision_id="', then we assume the right
1799
# revision_id is set. We must check for this full string, because a
1800
# root node id can legitimately look like 'revision_id' but cannot
1802
xml = self.branch.repository.get_inventory_xml(new_revision)
1803
firstline = xml.split('\n', 1)[0]
1804
if (not 'revision_id="' in firstline or
1805
'format="7"' not in firstline):
1806
inv = self.branch.repository.deserialise_inventory(
1808
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1809
self._write_basis_inventory(xml)
1810
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1813
def read_basis_inventory(self):
1814
"""Read the cached basis inventory."""
1815
path = self._basis_inventory_name()
1816
return self._control_files.get(path).read()
1819
def read_working_inventory(self):
1820
"""Read the working inventory.
1822
:raises errors.InventoryModified: read_working_inventory will fail
1823
when the current in memory inventory has been modified.
1825
# conceptually this should be an implementation detail of the tree.
1826
# XXX: Deprecate this.
1827
# ElementTree does its own conversion from UTF-8, so open in
1829
if self._inventory_is_modified:
1830
raise errors.InventoryModified(self)
1831
result = self._deserialize(self._control_files.get('inventory'))
1832
self._set_inventory(result, dirty=False)
1835
@needs_tree_write_lock
1836
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1838
"""Remove nominated files from the working inventory.
1840
:files: File paths relative to the basedir.
1841
:keep_files: If true, the files will also be kept.
1842
:force: Delete files and directories, even if they are changed and
1843
even if the directories are not empty.
1845
if isinstance(files, basestring):
1851
unknown_nested_files=set()
1853
def recurse_directory_to_add_files(directory):
1854
# Recurse directory and add all files
1855
# so we can check if they have changed.
1856
for parent_info, file_infos in\
1857
osutils.walkdirs(self.abspath(directory),
1859
for relpath, basename, kind, lstat, abspath in file_infos:
1860
# Is it versioned or ignored?
1861
if self.path2id(relpath) or self.is_ignored(relpath):
1862
# Add nested content for deletion.
1863
new_files.add(relpath)
1865
# Files which are not versioned and not ignored
1866
# should be treated as unknown.
1867
unknown_nested_files.add((relpath, None, kind))
1869
for filename in files:
1870
# Get file name into canonical form.
1871
abspath = self.abspath(filename)
1872
filename = self.relpath(abspath)
1873
if len(filename) > 0:
1874
new_files.add(filename)
1875
if osutils.isdir(abspath):
1876
recurse_directory_to_add_files(filename)
1878
files = list(new_files)
1881
return # nothing to do
1883
# Sort needed to first handle directory content before the directory
1884
files.sort(reverse=True)
1886
# Bail out if we are going to delete files we shouldn't
1887
if not keep_files and not force:
1888
has_changed_files = len(unknown_nested_files) > 0
1889
if not has_changed_files:
1890
for (file_id, path, content_change, versioned, parent_id, name,
1891
kind, executable) in self._iter_changes(self.basis_tree(),
1892
include_unchanged=True, require_versioned=False,
1893
want_unversioned=True, specific_files=files):
1894
# Check if it's an unknown (but not ignored) OR
1895
# changed (but not deleted) :
1896
if not self.is_ignored(path[1]) and (
1897
versioned == (False, False) or
1898
content_change and kind[1] != None):
1899
has_changed_files = True
1902
if has_changed_files:
1903
# Make delta show ALL applicable changes in error message.
1904
tree_delta = self.changes_from(self.basis_tree(),
1905
require_versioned=False, want_unversioned=True,
1906
specific_files=files)
1907
for unknown_file in unknown_nested_files:
1908
if unknown_file not in tree_delta.unversioned:
1909
tree_delta.unversioned.extend((unknown_file,))
1910
raise errors.BzrRemoveChangedFilesError(tree_delta)
1912
# Build inv_delta and delete files where applicaple,
1913
# do this before any modifications to inventory.
1915
fid = self.path2id(f)
1918
message = "%s is not versioned." % (f,)
1921
# having removed it, it must be either ignored or unknown
1922
if self.is_ignored(f):
1926
textui.show_status(new_status, self.kind(fid), f,
1929
inv_delta.append((f, None, fid, None))
1930
message = "removed %s" % (f,)
1933
abs_path = self.abspath(f)
1934
if osutils.lexists(abs_path):
1935
if (osutils.isdir(abs_path) and
1936
len(os.listdir(abs_path)) > 0):
1938
osutils.rmtree(abs_path)
1940
message = "%s is not an empty directory "\
1941
"and won't be deleted." % (f,)
1943
osutils.delete_any(abs_path)
1944
message = "deleted %s" % (f,)
1945
elif message is not None:
1946
# Only care if we haven't done anything yet.
1947
message = "%s does not exist." % (f,)
1949
# Print only one message (if any) per file.
1950
if message is not None:
1952
self.apply_inventory_delta(inv_delta)
1954
@needs_tree_write_lock
1955
def revert(self, filenames, old_tree=None, backups=True,
1956
pb=DummyProgress(), report_changes=False):
1957
from bzrlib.conflicts import resolve
1958
if old_tree is None:
1959
old_tree = self.basis_tree()
1960
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1962
if not len(filenames):
1963
self.set_parent_ids(self.get_parent_ids()[:1])
1966
resolve(self, filenames, ignore_misses=True)
1969
def revision_tree(self, revision_id):
1970
"""See Tree.revision_tree.
1972
WorkingTree can supply revision_trees for the basis revision only
1973
because there is only one cached inventory in the bzr directory.
1975
if revision_id == self.last_revision():
1977
xml = self.read_basis_inventory()
1978
except errors.NoSuchFile:
1982
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1983
# dont use the repository revision_tree api because we want
1984
# to supply the inventory.
1985
if inv.revision_id == revision_id:
1986
return revisiontree.RevisionTree(self.branch.repository,
1988
except errors.BadInventoryFormat:
1990
# raise if there was no inventory, or if we read the wrong inventory.
1991
raise errors.NoSuchRevisionInTree(self, revision_id)
1993
# XXX: This method should be deprecated in favour of taking in a proper
1994
# new Inventory object.
1995
@needs_tree_write_lock
1996
def set_inventory(self, new_inventory_list):
1997
from bzrlib.inventory import (Inventory,
2002
inv = Inventory(self.get_root_id())
2003
for path, file_id, parent, kind in new_inventory_list:
2004
name = os.path.basename(path)
2007
# fixme, there should be a factory function inv,add_??
2008
if kind == 'directory':
2009
inv.add(InventoryDirectory(file_id, name, parent))
2010
elif kind == 'file':
2011
inv.add(InventoryFile(file_id, name, parent))
2012
elif kind == 'symlink':
2013
inv.add(InventoryLink(file_id, name, parent))
2015
raise errors.BzrError("unknown kind %r" % kind)
2016
self._write_inventory(inv)
2018
@needs_tree_write_lock
2019
def set_root_id(self, file_id):
2020
"""Set the root id for this tree."""
2023
symbol_versioning.warn(symbol_versioning.zero_twelve
2024
% 'WorkingTree.set_root_id with fileid=None',
2029
file_id = osutils.safe_file_id(file_id)
2030
self._set_root_id(file_id)
2032
def _set_root_id(self, file_id):
2033
"""Set the root id for this tree, in a format specific manner.
2035
:param file_id: The file id to assign to the root. It must not be
2036
present in the current inventory or an error will occur. It must
2037
not be None, but rather a valid file id.
2039
inv = self._inventory
2040
orig_root_id = inv.root.file_id
2041
# TODO: it might be nice to exit early if there was nothing
2042
# to do, saving us from trigger a sync on unlock.
2043
self._inventory_is_modified = True
2044
# we preserve the root inventory entry object, but
2045
# unlinkit from the byid index
2046
del inv._byid[inv.root.file_id]
2047
inv.root.file_id = file_id
2048
# and link it into the index with the new changed id.
2049
inv._byid[inv.root.file_id] = inv.root
2050
# and finally update all children to reference the new id.
2051
# XXX: this should be safe to just look at the root.children
2052
# list, not the WHOLE INVENTORY.
2055
if entry.parent_id == orig_root_id:
2056
entry.parent_id = inv.root.file_id
2059
"""See Branch.unlock.
2061
WorkingTree locking just uses the Branch locking facilities.
2062
This is current because all working trees have an embedded branch
2063
within them. IF in the future, we were to make branch data shareable
2064
between multiple working trees, i.e. via shared storage, then we
2065
would probably want to lock both the local tree, and the branch.
2067
raise NotImplementedError(self.unlock)
2069
def update(self, change_reporter=None):
2070
"""Update a working tree along its branch.
2072
This will update the branch if its bound too, which means we have
2073
multiple trees involved:
2075
- The new basis tree of the master.
2076
- The old basis tree of the branch.
2077
- The old basis tree of the working tree.
2078
- The current working tree state.
2080
Pathologically, all three may be different, and non-ancestors of each
2081
other. Conceptually we want to:
2083
- Preserve the wt.basis->wt.state changes
2084
- Transform the wt.basis to the new master basis.
2085
- Apply a merge of the old branch basis to get any 'local' changes from
2087
- Restore the wt.basis->wt.state changes.
2089
There isn't a single operation at the moment to do that, so we:
2090
- Merge current state -> basis tree of the master w.r.t. the old tree
2092
- Do a 'normal' merge of the old branch basis if it is relevant.
2094
if self.branch.get_master_branch() is not None:
2096
update_branch = True
2098
self.lock_tree_write()
2099
update_branch = False
2102
old_tip = self.branch.update()
2105
return self._update_tree(old_tip, change_reporter)
2109
@needs_tree_write_lock
2110
def _update_tree(self, old_tip=None, change_reporter=None):
2111
"""Update a tree to the master branch.
2113
:param old_tip: if supplied, the previous tip revision the branch,
2114
before it was changed to the master branch's tip.
2116
# here if old_tip is not None, it is the old tip of the branch before
2117
# it was updated from the master branch. This should become a pending
2118
# merge in the working tree to preserve the user existing work. we
2119
# cant set that until we update the working trees last revision to be
2120
# one from the new branch, because it will just get absorbed by the
2121
# parent de-duplication logic.
2123
# We MUST save it even if an error occurs, because otherwise the users
2124
# local work is unreferenced and will appear to have been lost.
2128
last_rev = self.get_parent_ids()[0]
2130
last_rev = _mod_revision.NULL_REVISION
2131
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2132
# merge tree state up to new branch tip.
2133
basis = self.basis_tree()
2136
to_tree = self.branch.basis_tree()
2137
if basis.inventory.root is None:
2138
self.set_root_id(to_tree.inventory.root.file_id)
2140
result += merge.merge_inner(
2145
change_reporter=change_reporter)
2148
# TODO - dedup parents list with things merged by pull ?
2149
# reuse the tree we've updated to to set the basis:
2150
parent_trees = [(self.branch.last_revision(), to_tree)]
2151
merges = self.get_parent_ids()[1:]
2152
# Ideally we ask the tree for the trees here, that way the working
2153
# tree can decide whether to give us teh entire tree or give us a
2154
# lazy initialised tree. dirstate for instance will have the trees
2155
# in ram already, whereas a last-revision + basis-inventory tree
2156
# will not, but also does not need them when setting parents.
2157
for parent in merges:
2158
parent_trees.append(
2159
(parent, self.branch.repository.revision_tree(parent)))
2160
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2161
parent_trees.append(
2162
(old_tip, self.branch.repository.revision_tree(old_tip)))
2163
self.set_parent_trees(parent_trees)
2164
last_rev = parent_trees[0][0]
2166
# the working tree had the same last-revision as the master
2167
# branch did. We may still have pivot local work from the local
2168
# branch into old_tip:
2169
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2170
self.add_parent_tree_id(old_tip)
2171
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2172
and old_tip != last_rev):
2173
# our last revision was not the prior branch last revision
2174
# and we have converted that last revision to a pending merge.
2175
# base is somewhere between the branch tip now
2176
# and the now pending merge
2178
# Since we just modified the working tree and inventory, flush out
2179
# the current state, before we modify it again.
2180
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2181
# requires it only because TreeTransform directly munges the
2182
# inventory and calls tree._write_inventory(). Ultimately we
2183
# should be able to remove this extra flush.
2185
graph = self.branch.repository.get_graph()
2186
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2188
base_tree = self.branch.repository.revision_tree(base_rev_id)
2189
other_tree = self.branch.repository.revision_tree(old_tip)
2190
result += merge.merge_inner(
2195
change_reporter=change_reporter)
2198
def _write_hashcache_if_dirty(self):
2199
"""Write out the hashcache if it is dirty."""
2200
if self._hashcache.needs_write:
2202
self._hashcache.write()
2204
if e.errno not in (errno.EPERM, errno.EACCES):
2206
# TODO: jam 20061219 Should this be a warning? A single line
2207
# warning might be sufficient to let the user know what
2209
mutter('Could not write hashcache for %s\nError: %s',
2210
self._hashcache.cache_file_name(), e)
2212
@needs_tree_write_lock
2213
def _write_inventory(self, inv):
2214
"""Write inventory as the current inventory."""
2215
self._set_inventory(inv, dirty=True)
2218
def set_conflicts(self, arg):
2219
raise errors.UnsupportedOperation(self.set_conflicts, self)
2221
def add_conflicts(self, arg):
2222
raise errors.UnsupportedOperation(self.add_conflicts, self)
2225
def conflicts(self):
2226
conflicts = _mod_conflicts.ConflictList()
2227
for conflicted in self._iter_conflicts():
2230
if file_kind(self.abspath(conflicted)) != "file":
2232
except errors.NoSuchFile:
2235
for suffix in ('.THIS', '.OTHER'):
2237
kind = file_kind(self.abspath(conflicted+suffix))
2240
except errors.NoSuchFile:
2244
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2245
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2247
file_id=self.path2id(conflicted)))
2250
def walkdirs(self, prefix=""):
2251
"""Walk the directories of this tree.
2253
returns a generator which yields items in the form:
2254
((curren_directory_path, fileid),
2255
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2258
This API returns a generator, which is only valid during the current
2259
tree transaction - within a single lock_read or lock_write duration.
2261
If the tree is not locked, it may cause an error to be raised,
2262
depending on the tree implementation.
2264
disk_top = self.abspath(prefix)
2265
if disk_top.endswith('/'):
2266
disk_top = disk_top[:-1]
2267
top_strip_len = len(disk_top) + 1
2268
inventory_iterator = self._walkdirs(prefix)
2269
disk_iterator = osutils.walkdirs(disk_top, prefix)
2271
current_disk = disk_iterator.next()
2272
disk_finished = False
2274
if not (e.errno == errno.ENOENT or
2275
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2278
disk_finished = True
2280
current_inv = inventory_iterator.next()
2281
inv_finished = False
2282
except StopIteration:
2285
while not inv_finished or not disk_finished:
2286
if not disk_finished:
2287
# strip out .bzr dirs
2288
if current_disk[0][1][top_strip_len:] == '':
2289
# osutils.walkdirs can be made nicer -
2290
# yield the path-from-prefix rather than the pathjoined
2292
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2293
if current_disk[1][bzrdir_loc][0] == '.bzr':
2294
# we dont yield the contents of, or, .bzr itself.
2295
del current_disk[1][bzrdir_loc]
2297
# everything is unknown
2300
# everything is missing
2303
direction = cmp(current_inv[0][0], current_disk[0][0])
2305
# disk is before inventory - unknown
2306
dirblock = [(relpath, basename, kind, stat, None, None) for
2307
relpath, basename, kind, stat, top_path in current_disk[1]]
2308
yield (current_disk[0][0], None), dirblock
2310
current_disk = disk_iterator.next()
2311
except StopIteration:
2312
disk_finished = True
2314
# inventory is before disk - missing.
2315
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2316
for relpath, basename, dkind, stat, fileid, kind in
2318
yield (current_inv[0][0], current_inv[0][1]), dirblock
2320
current_inv = inventory_iterator.next()
2321
except StopIteration:
2324
# versioned present directory
2325
# merge the inventory and disk data together
2327
for relpath, subiterator in itertools.groupby(sorted(
2328
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2329
path_elements = list(subiterator)
2330
if len(path_elements) == 2:
2331
inv_row, disk_row = path_elements
2332
# versioned, present file
2333
dirblock.append((inv_row[0],
2334
inv_row[1], disk_row[2],
2335
disk_row[3], inv_row[4],
2337
elif len(path_elements[0]) == 5:
2339
dirblock.append((path_elements[0][0],
2340
path_elements[0][1], path_elements[0][2],
2341
path_elements[0][3], None, None))
2342
elif len(path_elements[0]) == 6:
2343
# versioned, absent file.
2344
dirblock.append((path_elements[0][0],
2345
path_elements[0][1], 'unknown', None,
2346
path_elements[0][4], path_elements[0][5]))
2348
raise NotImplementedError('unreachable code')
2349
yield current_inv[0], dirblock
2351
current_inv = inventory_iterator.next()
2352
except StopIteration:
2355
current_disk = disk_iterator.next()
2356
except StopIteration:
2357
disk_finished = True
2359
def _walkdirs(self, prefix=""):
2360
"""Walk the directories of this tree.
2362
:prefix: is used as the directrory to start with.
2363
returns a generator which yields items in the form:
2364
((curren_directory_path, fileid),
2365
[(file1_path, file1_name, file1_kind, None, file1_id,
2368
_directory = 'directory'
2369
# get the root in the inventory
2370
inv = self.inventory
2371
top_id = inv.path2id(prefix)
2375
pending = [(prefix, '', _directory, None, top_id, None)]
2378
currentdir = pending.pop()
2379
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2380
top_id = currentdir[4]
2382
relroot = currentdir[0] + '/'
2385
# FIXME: stash the node in pending
2387
for name, child in entry.sorted_children():
2388
dirblock.append((relroot + name, name, child.kind, None,
2389
child.file_id, child.kind
2391
yield (currentdir[0], entry.file_id), dirblock
2392
# push the user specified dirs from dirblock
2393
for dir in reversed(dirblock):
2394
if dir[2] == _directory:
2397
@needs_tree_write_lock
2398
def auto_resolve(self):
2399
"""Automatically resolve text conflicts according to contents.
2401
Only text conflicts are auto_resolvable. Files with no conflict markers
2402
are considered 'resolved', because bzr always puts conflict markers
2403
into files that have text conflicts. The corresponding .THIS .BASE and
2404
.OTHER files are deleted, as per 'resolve'.
2405
:return: a tuple of ConflictLists: (un_resolved, resolved).
2407
un_resolved = _mod_conflicts.ConflictList()
2408
resolved = _mod_conflicts.ConflictList()
2409
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2410
for conflict in self.conflicts():
2411
if (conflict.typestring != 'text conflict' or
2412
self.kind(conflict.file_id) != 'file'):
2413
un_resolved.append(conflict)
2415
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2417
for line in my_file:
2418
if conflict_re.search(line):
2419
un_resolved.append(conflict)
2422
resolved.append(conflict)
2425
resolved.remove_files(self)
2426
self.set_conflicts(un_resolved)
2427
return un_resolved, resolved
2429
def _validate(self):
2430
"""Validate internal structures.
2432
This is meant mostly for the test suite. To give it a chance to detect
2433
corruption after actions have occurred. The default implementation is a
2436
:return: None. An exception should be raised if there is an error.
2441
class WorkingTree2(WorkingTree):
2442
"""This is the Format 2 working tree.
2444
This was the first weave based working tree.
2445
- uses os locks for locking.
2446
- uses the branch last-revision.
2449
def __init__(self, *args, **kwargs):
2450
super(WorkingTree2, self).__init__(*args, **kwargs)
2451
# WorkingTree2 has more of a constraint that self._inventory must
2452
# exist. Because this is an older format, we don't mind the overhead
2453
# caused by the extra computation here.
2455
# Newer WorkingTree's should only have self._inventory set when they
2457
if self._inventory is None:
2458
self.read_working_inventory()
2460
def lock_tree_write(self):
2461
"""See WorkingTree.lock_tree_write().
2463
In Format2 WorkingTrees we have a single lock for the branch and tree
2464
so lock_tree_write() degrades to lock_write().
2466
self.branch.lock_write()
2468
return self._control_files.lock_write()
2470
self.branch.unlock()
2474
# do non-implementation specific cleanup
2477
# we share control files:
2478
if self._control_files._lock_count == 3:
2479
# _inventory_is_modified is always False during a read lock.
2480
if self._inventory_is_modified:
2482
self._write_hashcache_if_dirty()
2484
# reverse order of locking.
2486
return self._control_files.unlock()
2488
self.branch.unlock()
2491
class WorkingTree3(WorkingTree):
2492
"""This is the Format 3 working tree.
2494
This differs from the base WorkingTree by:
2495
- having its own file lock
2496
- having its own last-revision property.
2498
This is new in bzr 0.8
2502
def _last_revision(self):
2503
"""See Mutable.last_revision."""
2505
return osutils.safe_revision_id(
2506
self._control_files.get('last-revision').read())
2507
except errors.NoSuchFile:
2508
return _mod_revision.NULL_REVISION
2510
def _change_last_revision(self, revision_id):
2511
"""See WorkingTree._change_last_revision."""
2512
if revision_id is None or revision_id == NULL_REVISION:
2514
self._control_files._transport.delete('last-revision')
2515
except errors.NoSuchFile:
2519
self._control_files.put_bytes('last-revision', revision_id)
2522
@needs_tree_write_lock
2523
def set_conflicts(self, conflicts):
2524
self._put_rio('conflicts', conflicts.to_stanzas(),
2527
@needs_tree_write_lock
2528
def add_conflicts(self, new_conflicts):
2529
conflict_set = set(self.conflicts())
2530
conflict_set.update(set(list(new_conflicts)))
2531
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2532
key=_mod_conflicts.Conflict.sort_key)))
2535
def conflicts(self):
2537
confile = self._control_files.get('conflicts')
2538
except errors.NoSuchFile:
2539
return _mod_conflicts.ConflictList()
2541
if confile.next() != CONFLICT_HEADER_1 + '\n':
2542
raise errors.ConflictFormatError()
2543
except StopIteration:
2544
raise errors.ConflictFormatError()
2545
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2548
# do non-implementation specific cleanup
2550
if self._control_files._lock_count == 1:
2551
# _inventory_is_modified is always False during a read lock.
2552
if self._inventory_is_modified:
2554
self._write_hashcache_if_dirty()
2555
# reverse order of locking.
2557
return self._control_files.unlock()
2559
self.branch.unlock()
2562
def get_conflicted_stem(path):
2563
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2564
if path.endswith(suffix):
2565
return path[:-len(suffix)]
2568
@deprecated_function(zero_eight)
2569
def is_control_file(filename):
2570
"""See WorkingTree.is_control_filename(filename)."""
2571
## FIXME: better check
2572
filename = normpath(filename)
2573
while filename != '':
2574
head, tail = os.path.split(filename)
2575
## mutter('check %r for control file' % ((head, tail),))
2578
if filename == head:
2584
class WorkingTreeFormat(object):
2585
"""An encapsulation of the initialization and open routines for a format.
2587
Formats provide three things:
2588
* An initialization routine,
2592
Formats are placed in an dict by their format string for reference
2593
during workingtree opening. Its not required that these be instances, they
2594
can be classes themselves with class methods - it simply depends on
2595
whether state is needed for a given format or not.
2597
Once a format is deprecated, just deprecate the initialize and open
2598
methods on the format class. Do not deprecate the object, as the
2599
object will be created every time regardless.
2602
_default_format = None
2603
"""The default format used for new trees."""
2606
"""The known formats."""
2608
requires_rich_root = False
2610
upgrade_recommended = False
2613
def find_format(klass, a_bzrdir):
2614
"""Return the format for the working tree object in a_bzrdir."""
2616
transport = a_bzrdir.get_workingtree_transport(None)
2617
format_string = transport.get("format").read()
2618
return klass._formats[format_string]
2619
except errors.NoSuchFile:
2620
raise errors.NoWorkingTree(base=transport.base)
2622
raise errors.UnknownFormatError(format=format_string)
2624
def __eq__(self, other):
2625
return self.__class__ is other.__class__
2627
def __ne__(self, other):
2628
return not (self == other)
2631
def get_default_format(klass):
2632
"""Return the current default format."""
2633
return klass._default_format
2635
def get_format_string(self):
2636
"""Return the ASCII format string that identifies this format."""
2637
raise NotImplementedError(self.get_format_string)
2639
def get_format_description(self):
2640
"""Return the short description for this format."""
2641
raise NotImplementedError(self.get_format_description)
2643
def is_supported(self):
2644
"""Is this format supported?
2646
Supported formats can be initialized and opened.
2647
Unsupported formats may not support initialization or committing or
2648
some other features depending on the reason for not being supported.
2653
def register_format(klass, format):
2654
klass._formats[format.get_format_string()] = format
2657
def set_default_format(klass, format):
2658
klass._default_format = format
2661
def unregister_format(klass, format):
2662
assert klass._formats[format.get_format_string()] is format
2663
del klass._formats[format.get_format_string()]
2666
class WorkingTreeFormat2(WorkingTreeFormat):
2667
"""The second working tree format.
2669
This format modified the hash cache from the format 1 hash cache.
2672
upgrade_recommended = True
2674
def get_format_description(self):
2675
"""See WorkingTreeFormat.get_format_description()."""
2676
return "Working tree format 2"
2678
def stub_initialize_remote(self, control_files):
2679
"""As a special workaround create critical control files for a remote working tree
2681
This ensures that it can later be updated and dealt with locally,
2682
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2683
no working tree. (See bug #43064).
2687
xml5.serializer_v5.write_inventory(inv, sio)
2689
control_files.put('inventory', sio)
2691
control_files.put_bytes('pending-merges', '')
2694
def initialize(self, a_bzrdir, revision_id=None):
2695
"""See WorkingTreeFormat.initialize()."""
2696
if not isinstance(a_bzrdir.transport, LocalTransport):
2697
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2698
branch = a_bzrdir.open_branch()
2699
if revision_id is None:
2700
revision_id = _mod_revision.ensure_null(branch.last_revision())
2702
revision_id = osutils.safe_revision_id(revision_id)
2705
branch.generate_revision_history(revision_id)
2709
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2715
basis_tree = branch.repository.revision_tree(revision_id)
2716
if basis_tree.inventory.root is not None:
2717
wt.set_root_id(basis_tree.inventory.root.file_id)
2718
# set the parent list and cache the basis tree.
2719
if _mod_revision.is_null(revision_id):
2722
parent_trees = [(revision_id, basis_tree)]
2723
wt.set_parent_trees(parent_trees)
2724
transform.build_tree(basis_tree, wt)
2728
super(WorkingTreeFormat2, self).__init__()
2729
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2731
def open(self, a_bzrdir, _found=False):
2732
"""Return the WorkingTree object for a_bzrdir
2734
_found is a private parameter, do not use it. It is used to indicate
2735
if format probing has already been done.
2738
# we are being called directly and must probe.
2739
raise NotImplementedError
2740
if not isinstance(a_bzrdir.transport, LocalTransport):
2741
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2742
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2748
class WorkingTreeFormat3(WorkingTreeFormat):
2749
"""The second working tree format updated to record a format marker.
2752
- exists within a metadir controlling .bzr
2753
- includes an explicit version marker for the workingtree control
2754
files, separate from the BzrDir format
2755
- modifies the hash cache format
2757
- uses a LockDir to guard access for writes.
2760
upgrade_recommended = True
2762
def get_format_string(self):
2763
"""See WorkingTreeFormat.get_format_string()."""
2764
return "Bazaar-NG Working Tree format 3"
2766
def get_format_description(self):
2767
"""See WorkingTreeFormat.get_format_description()."""
2768
return "Working tree format 3"
2770
_lock_file_name = 'lock'
2771
_lock_class = LockDir
2773
_tree_class = WorkingTree3
2775
def __get_matchingbzrdir(self):
2776
return bzrdir.BzrDirMetaFormat1()
2778
_matchingbzrdir = property(__get_matchingbzrdir)
2780
def _open_control_files(self, a_bzrdir):
2781
transport = a_bzrdir.get_workingtree_transport(None)
2782
return LockableFiles(transport, self._lock_file_name,
2785
def initialize(self, a_bzrdir, revision_id=None):
2786
"""See WorkingTreeFormat.initialize().
2788
revision_id allows creating a working tree at a different
2789
revision than the branch is at.
2791
if not isinstance(a_bzrdir.transport, LocalTransport):
2792
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2793
transport = a_bzrdir.get_workingtree_transport(self)
2794
control_files = self._open_control_files(a_bzrdir)
2795
control_files.create_lock()
2796
control_files.lock_write()
2797
control_files.put_utf8('format', self.get_format_string())
2798
branch = a_bzrdir.open_branch()
2799
if revision_id is None:
2800
revision_id = _mod_revision.ensure_null(branch.last_revision())
2802
revision_id = osutils.safe_revision_id(revision_id)
2803
# WorkingTree3 can handle an inventory which has a unique root id.
2804
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2805
# those trees. And because there isn't a format bump inbetween, we
2806
# are maintaining compatibility with older clients.
2807
# inv = Inventory(root_id=gen_root_id())
2808
inv = self._initial_inventory()
2809
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2815
_control_files=control_files)
2816
wt.lock_tree_write()
2818
basis_tree = branch.repository.revision_tree(revision_id)
2819
# only set an explicit root id if there is one to set.
2820
if basis_tree.inventory.root is not None:
2821
wt.set_root_id(basis_tree.inventory.root.file_id)
2822
if revision_id == NULL_REVISION:
2823
wt.set_parent_trees([])
2825
wt.set_parent_trees([(revision_id, basis_tree)])
2826
transform.build_tree(basis_tree, wt)
2828
# Unlock in this order so that the unlock-triggers-flush in
2829
# WorkingTree is given a chance to fire.
2830
control_files.unlock()
2834
def _initial_inventory(self):
2838
super(WorkingTreeFormat3, self).__init__()
2840
def open(self, a_bzrdir, _found=False):
2841
"""Return the WorkingTree object for a_bzrdir
2843
_found is a private parameter, do not use it. It is used to indicate
2844
if format probing has already been done.
2847
# we are being called directly and must probe.
2848
raise NotImplementedError
2849
if not isinstance(a_bzrdir.transport, LocalTransport):
2850
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2851
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2854
def _open(self, a_bzrdir, control_files):
2855
"""Open the tree itself.
2857
:param a_bzrdir: the dir for the tree.
2858
:param control_files: the control files for the tree.
2860
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2864
_control_files=control_files)
2867
return self.get_format_string()
2870
__default_format = WorkingTreeFormat4()
2871
WorkingTreeFormat.register_format(__default_format)
2872
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2873
WorkingTreeFormat.set_default_format(__default_format)
2874
# formats which have no format string are not discoverable
2875
# and not independently creatable, so are not registered.
2876
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
