1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
class TreeEntry(object):
124
"""An entry that implements the minimum interface used by commands.
126
This needs further inspection, it may be better to have
127
InventoryEntries without ids - though that seems wrong. For now,
128
this is a parallel hierarchy to InventoryEntry, and needs to become
129
one of several things: decorates to that hierarchy, children of, or
131
Another note is that these objects are currently only used when there is
132
no InventoryEntry available - i.e. for unversioned objects.
133
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
136
def __eq__(self, other):
137
# yes, this us ugly, TODO: best practice __eq__ style.
138
return (isinstance(other, TreeEntry)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeDirectory(TreeEntry):
146
"""See TreeEntry. This is a directory in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeDirectory)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeFile(TreeEntry):
157
"""See TreeEntry. This is a regular file in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeFile)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeLink(TreeEntry):
168
"""See TreeEntry. This is a symlink in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeLink)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
179
"""Working copy tree.
181
The inventory is held in the `Branch` working-inventory, and the
182
files are in a directory on disk.
184
It is possible for a `WorkingTree` to have a filename which is
185
not listed in the Inventory and vice versa.
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode())
231
# is this scan needed ? it makes things kinda slow.
238
if _inventory is None:
239
# This will be acquired on lock_read() or lock_write()
240
self._inventory_is_modified = False
241
self._inventory = None
243
# the caller of __init__ has provided an inventory,
244
# we assume they know what they are doing - as its only
245
# the Format factory and creation methods that are
246
# permitted to do this.
247
self._set_inventory(_inventory, dirty=False)
248
self._detect_case_handling()
249
self._rules_searcher = None
251
def _detect_case_handling(self):
252
wt_trans = self.bzrdir.get_workingtree_transport(None)
254
wt_trans.stat("FoRMaT")
255
except errors.NoSuchFile:
256
self.case_sensitive = True
258
self.case_sensitive = False
260
self._setup_directory_is_tree_reference()
263
fget=lambda self: self._branch,
264
doc="""The branch this WorkingTree is connected to.
266
This cannot be set - it is reflective of the actual disk structure
267
the working tree has been constructed from.
270
def break_lock(self):
271
"""Break a lock if one is present from another instance.
273
Uses the ui factory to ask for confirmation if the lock may be from
276
This will probe the repository for its lock as well.
278
self._control_files.break_lock()
279
self.branch.break_lock()
281
def requires_rich_root(self):
282
return self._format.requires_rich_root
284
def supports_tree_reference(self):
287
def _set_inventory(self, inv, dirty):
288
"""Set the internal cached inventory.
290
:param inv: The inventory to set.
291
:param dirty: A boolean indicating whether the inventory is the same
292
logical inventory as whats on disk. If True the inventory is not
293
the same and should be written to disk or data will be lost, if
294
False then the inventory is the same as that on disk and any
295
serialisation would be unneeded overhead.
297
self._inventory = inv
298
self._inventory_is_modified = dirty
301
def open(path=None, _unsupported=False):
302
"""Open an existing working tree at path.
306
path = osutils.getcwd()
307
control = bzrdir.BzrDir.open(path, _unsupported)
308
return control.open_workingtree(_unsupported)
311
def open_containing(path=None):
312
"""Open an existing working tree which has its root about path.
314
This probes for a working tree at path and searches upwards from there.
316
Basically we keep looking up until we find the control directory or
317
run into /. If there isn't one, raises NotBranchError.
318
TODO: give this a new exception.
319
If there is one, it is returned, along with the unused portion of path.
321
:return: The WorkingTree that contains 'path', and the rest of path
324
path = osutils.getcwd()
325
control, relpath = bzrdir.BzrDir.open_containing(path)
327
return control.open_workingtree(), relpath
330
def open_downlevel(path=None):
331
"""Open an unsupported working tree.
333
Only intended for advanced situations like upgrading part of a bzrdir.
335
return WorkingTree.open(path, _unsupported=True)
338
def find_trees(location):
339
def list_current(transport):
340
return [d for d in transport.list_dir('') if d != '.bzr']
341
def evaluate(bzrdir):
343
tree = bzrdir.open_workingtree()
344
except errors.NoWorkingTree:
348
transport = get_transport(location)
349
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
350
list_current=list_current)
351
return [t for t in iterator if t is not None]
353
# should be deprecated - this is slow and in any case treating them as a
354
# container is (we now know) bad style -- mbp 20070302
355
## @deprecated_method(zero_fifteen)
357
"""Iterate through file_ids for this tree.
359
file_ids are in a WorkingTree if they are in the working inventory
360
and the working file exists.
362
inv = self._inventory
363
for path, ie in inv.iter_entries():
364
if osutils.lexists(self.abspath(path)):
367
def all_file_ids(self):
368
"""See Tree.iter_all_file_ids"""
369
return set(self.inventory)
372
return "<%s of %s>" % (self.__class__.__name__,
373
getattr(self, 'basedir', None))
375
def abspath(self, filename):
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling
383
repository.revision_tree(NULL_REVISION).
386
revision_id = self.get_parent_ids()[0]
388
# no parents, return an empty revision tree.
389
# in the future this should return the tree for
390
# 'empty:' - the implicit root empty tree.
391
return self.branch.repository.revision_tree(
392
_mod_revision.NULL_REVISION)
394
return self.revision_tree(revision_id)
395
except errors.NoSuchRevision:
397
# No cached copy available, retrieve from the repository.
398
# FIXME? RBC 20060403 should we cache the inventory locally
401
return self.branch.repository.revision_tree(revision_id)
402
except (errors.RevisionNotPresent, errors.NoSuchRevision):
403
# the basis tree *may* be a ghost or a low level error may have
404
# occured. If the revision is present, its a problem, if its not
406
if self.branch.repository.has_revision(revision_id):
408
# the basis tree is a ghost so return an empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
413
self._flush_ignore_list_cache()
415
def relpath(self, path):
416
"""Return the local path portion from a given path.
418
The path may be absolute or relative. If its a relative path it is
419
interpreted relative to the python current working directory.
421
return osutils.relpath(self.basedir, path)
423
def has_filename(self, filename):
424
return osutils.lexists(self.abspath(filename))
426
def get_file(self, file_id, path=None):
427
return self.get_file_with_stat(file_id, path)[0]
429
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
430
"""See MutableTree.get_file_with_stat."""
432
path = self.id2path(file_id)
433
file_obj = self.get_file_byname(path)
434
return (file_obj, _fstat(file_obj.fileno()))
436
def get_file_byname(self, filename):
437
return file(self.abspath(filename), 'rb')
439
def get_file_lines(self, file_id, path=None):
440
"""See Tree.get_file_lines()"""
441
file = self.get_file(file_id, path)
443
return file.readlines()
448
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
449
"""See Tree.annotate_iter
451
This implementation will use the basis tree implementation if possible.
452
Lines not in the basis are attributed to CURRENT_REVISION
454
If there are pending merges, lines added by those merges will be
455
incorrectly attributed to CURRENT_REVISION (but after committing, the
456
attribution will be correct).
458
basis = self.basis_tree()
461
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
462
require_versioned=True).next()
463
changed_content, kind = changes[2], changes[6]
464
if not changed_content:
465
return basis.annotate_iter(file_id)
469
if kind[0] != 'file':
472
old_lines = list(basis.annotate_iter(file_id))
474
for tree in self.branch.repository.revision_trees(
475
self.get_parent_ids()[1:]):
476
if file_id not in tree:
478
old.append(list(tree.annotate_iter(file_id)))
479
return annotate.reannotate(old, self.get_file(file_id).readlines(),
484
def _get_ancestors(self, default_revision):
485
ancestors = set([default_revision])
486
for parent_id in self.get_parent_ids():
487
ancestors.update(self.branch.repository.get_ancestry(
488
parent_id, topo_sorted=False))
491
def get_parent_ids(self):
492
"""See Tree.get_parent_ids.
494
This implementation reads the pending merges list and last_revision
495
value and uses that to decide what the parents list should be.
497
last_rev = _mod_revision.ensure_null(self._last_revision())
498
if _mod_revision.NULL_REVISION == last_rev:
503
merges_file = self._transport.get('pending-merges')
504
except errors.NoSuchFile:
507
for l in merges_file.readlines():
508
revision_id = l.rstrip('\n')
509
parents.append(revision_id)
513
def get_root_id(self):
514
"""Return the id of this trees root"""
515
return self._inventory.root.file_id
517
def _get_store_filename(self, file_id):
518
## XXX: badly named; this is not in the store at all
519
return self.abspath(self.id2path(file_id))
522
def clone(self, to_bzrdir, revision_id=None):
523
"""Duplicate this working tree into to_bzr, including all state.
525
Specifically modified files are kept as modified, but
526
ignored and unknown files are discarded.
528
If you want to make a new line of development, see bzrdir.sprout()
531
If not None, the cloned tree will have its last revision set to
532
revision, and and difference between the source trees last revision
533
and this one merged in.
535
# assumes the target bzr dir format is compatible.
536
result = to_bzrdir.create_workingtree()
537
self.copy_content_into(result, revision_id)
541
def copy_content_into(self, tree, revision_id=None):
542
"""Copy the current content and user files of this tree into tree."""
543
tree.set_root_id(self.get_root_id())
544
if revision_id is None:
545
merge.transform_tree(tree, self)
547
# TODO now merge from tree.last_revision to revision (to preserve
548
# user local changes)
549
merge.transform_tree(tree, self)
550
tree.set_parent_ids([revision_id])
552
def id2abspath(self, file_id):
553
return self.abspath(self.id2path(file_id))
555
def has_id(self, file_id):
556
# files that have been deleted are excluded
558
if not inv.has_id(file_id):
560
path = inv.id2path(file_id)
561
return osutils.lexists(self.abspath(path))
563
def has_or_had_id(self, file_id):
564
if file_id == self.inventory.root.file_id:
566
return self.inventory.has_id(file_id)
568
__contains__ = has_id
570
def get_file_size(self, file_id):
571
"""See Tree.get_file_size"""
573
return os.path.getsize(self.id2abspath(file_id))
575
if e.errno != errno.ENOENT:
581
def get_file_sha1(self, file_id, path=None, stat_value=None):
583
path = self._inventory.id2path(file_id)
584
return self._hashcache.get_sha1(path, stat_value)
586
def get_file_mtime(self, file_id, path=None):
588
path = self.inventory.id2path(file_id)
589
return os.lstat(self.abspath(path)).st_mtime
591
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
592
file_id = self.path2id(path)
593
return self._inventory[file_id].executable
595
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
596
mode = stat_result.st_mode
597
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
599
if not supports_executable():
600
def is_executable(self, file_id, path=None):
601
return self._inventory[file_id].executable
603
_is_executable_from_path_and_stat = \
604
_is_executable_from_path_and_stat_from_basis
606
def is_executable(self, file_id, path=None):
608
path = self.id2path(file_id)
609
mode = os.lstat(self.abspath(path)).st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
612
_is_executable_from_path_and_stat = \
613
_is_executable_from_path_and_stat_from_stat
615
@needs_tree_write_lock
616
def _add(self, files, ids, kinds):
617
"""See MutableTree._add."""
618
# TODO: Re-adding a file that is removed in the working copy
619
# should probably put it back with the previous ID.
620
# the read and write working inventory should not occur in this
621
# function - they should be part of lock_write and unlock.
623
for f, file_id, kind in zip(files, ids, kinds):
625
inv.add_path(f, kind=kind)
627
inv.add_path(f, kind=kind, file_id=file_id)
628
self._inventory_is_modified = True
630
@needs_tree_write_lock
631
def _gather_kinds(self, files, kinds):
632
"""See MutableTree._gather_kinds."""
633
for pos, f in enumerate(files):
634
if kinds[pos] is None:
635
fullpath = normpath(self.abspath(f))
637
kinds[pos] = file_kind(fullpath)
639
if e.errno == errno.ENOENT:
640
raise errors.NoSuchFile(fullpath)
643
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
644
"""Add revision_id as a parent.
646
This is equivalent to retrieving the current list of parent ids
647
and setting the list to its value plus revision_id.
649
:param revision_id: The revision id to add to the parent list. It may
650
be a ghost revision as long as its not the first parent to be added,
651
or the allow_leftmost_as_ghost parameter is set True.
652
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
654
parents = self.get_parent_ids() + [revision_id]
655
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
656
or allow_leftmost_as_ghost)
658
@needs_tree_write_lock
659
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
660
"""Add revision_id, tree tuple as a parent.
662
This is equivalent to retrieving the current list of parent trees
663
and setting the list to its value plus parent_tuple. See also
664
add_parent_tree_id - if you only have a parent id available it will be
665
simpler to use that api. If you have the parent already available, using
666
this api is preferred.
668
:param parent_tuple: The (revision id, tree) to add to the parent list.
669
If the revision_id is a ghost, pass None for the tree.
670
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
672
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
673
if len(parent_ids) > 1:
674
# the leftmost may have already been a ghost, preserve that if it
676
allow_leftmost_as_ghost = True
677
self.set_parent_ids(parent_ids,
678
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
680
@needs_tree_write_lock
681
def add_pending_merge(self, *revision_ids):
682
# TODO: Perhaps should check at this point that the
683
# history of the revision is actually present?
684
parents = self.get_parent_ids()
686
for rev_id in revision_ids:
687
if rev_id in parents:
689
parents.append(rev_id)
692
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
694
def path_content_summary(self, path, _lstat=os.lstat,
695
_mapper=osutils.file_kind_from_stat_mode):
696
"""See Tree.path_content_summary."""
697
abspath = self.abspath(path)
699
stat_result = _lstat(abspath)
701
if getattr(e, 'errno', None) == errno.ENOENT:
703
return ('missing', None, None, None)
704
# propagate other errors
706
kind = _mapper(stat_result.st_mode)
708
size = stat_result.st_size
709
# try for a stat cache lookup
710
executable = self._is_executable_from_path_and_stat(path, stat_result)
711
return (kind, size, executable, self._sha_from_stat(
713
elif kind == 'directory':
714
# perhaps it looks like a plain directory, but it's really a
716
if self._directory_is_tree_reference(path):
717
kind = 'tree-reference'
718
return kind, None, None, None
719
elif kind == 'symlink':
720
return ('symlink', None, None, os.readlink(abspath))
722
return (kind, None, None, None)
724
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
725
"""Common ghost checking functionality from set_parent_*.
727
This checks that the left hand-parent exists if there are any
730
if len(revision_ids) > 0:
731
leftmost_id = revision_ids[0]
732
if (not allow_leftmost_as_ghost and not
733
self.branch.repository.has_revision(leftmost_id)):
734
raise errors.GhostRevisionUnusableHere(leftmost_id)
736
def _set_merges_from_parent_ids(self, parent_ids):
737
merges = parent_ids[1:]
738
self._transport.put_bytes('pending-merges', '\n'.join(merges),
739
mode=self._control_files._file_mode)
741
def _filter_parent_ids_by_ancestry(self, revision_ids):
742
"""Check that all merged revisions are proper 'heads'.
744
This will always return the first revision_id, and any merged revisions
747
if len(revision_ids) == 0:
749
graph = self.branch.repository.get_graph()
750
heads = graph.heads(revision_ids)
751
new_revision_ids = revision_ids[:1]
752
for revision_id in revision_ids[1:]:
753
if revision_id in heads and revision_id not in new_revision_ids:
754
new_revision_ids.append(revision_id)
755
if new_revision_ids != revision_ids:
756
trace.mutter('requested to set revision_ids = %s,'
757
' but filtered to %s', revision_ids, new_revision_ids)
758
return new_revision_ids
760
@needs_tree_write_lock
761
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
762
"""Set the parent ids to revision_ids.
764
See also set_parent_trees. This api will try to retrieve the tree data
765
for each element of revision_ids from the trees repository. If you have
766
tree data already available, it is more efficient to use
767
set_parent_trees rather than set_parent_ids. set_parent_ids is however
768
an easier API to use.
770
:param revision_ids: The revision_ids to set as the parent ids of this
771
working tree. Any of these may be ghosts.
773
self._check_parents_for_ghosts(revision_ids,
774
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
775
for revision_id in revision_ids:
776
_mod_revision.check_not_reserved_id(revision_id)
778
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
780
if len(revision_ids) > 0:
781
self.set_last_revision(revision_ids[0])
783
self.set_last_revision(_mod_revision.NULL_REVISION)
785
self._set_merges_from_parent_ids(revision_ids)
787
@needs_tree_write_lock
788
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
789
"""See MutableTree.set_parent_trees."""
790
parent_ids = [rev for (rev, tree) in parents_list]
791
for revision_id in parent_ids:
792
_mod_revision.check_not_reserved_id(revision_id)
794
self._check_parents_for_ghosts(parent_ids,
795
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
797
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
799
if len(parent_ids) == 0:
800
leftmost_parent_id = _mod_revision.NULL_REVISION
801
leftmost_parent_tree = None
803
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
805
if self._change_last_revision(leftmost_parent_id):
806
if leftmost_parent_tree is None:
807
# If we don't have a tree, fall back to reading the
808
# parent tree from the repository.
809
self._cache_basis_inventory(leftmost_parent_id)
811
inv = leftmost_parent_tree.inventory
812
xml = self._create_basis_xml_from_inventory(
813
leftmost_parent_id, inv)
814
self._write_basis_inventory(xml)
815
self._set_merges_from_parent_ids(parent_ids)
817
@needs_tree_write_lock
818
def set_pending_merges(self, rev_list):
819
parents = self.get_parent_ids()
820
leftmost = parents[:1]
821
new_parents = leftmost + rev_list
822
self.set_parent_ids(new_parents)
824
@needs_tree_write_lock
825
def set_merge_modified(self, modified_hashes):
827
for file_id, hash in modified_hashes.iteritems():
828
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
829
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
831
def _sha_from_stat(self, path, stat_result):
832
"""Get a sha digest from the tree's stat cache.
834
The default implementation assumes no stat cache is present.
836
:param path: The path.
837
:param stat_result: The stat result being looked up.
841
def _put_rio(self, filename, stanzas, header):
842
self._must_be_locked()
843
my_file = rio_file(stanzas, header)
844
self._transport.put_file(filename, my_file,
845
mode=self._control_files._file_mode)
847
@needs_write_lock # because merge pulls data into the branch.
848
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
850
"""Merge from a branch into this working tree.
852
:param branch: The branch to merge from.
853
:param to_revision: If non-None, the merge will merge to to_revision,
854
but not beyond it. to_revision does not need to be in the history
855
of the branch when it is supplied. If None, to_revision defaults to
856
branch.last_revision().
858
from bzrlib.merge import Merger, Merge3Merger
859
pb = bzrlib.ui.ui_factory.nested_progress_bar()
861
merger = Merger(self.branch, this_tree=self, pb=pb)
862
merger.pp = ProgressPhase("Merge phase", 5, pb)
863
merger.pp.next_phase()
864
# check that there are no
866
merger.check_basis(check_clean=True, require_commits=False)
867
if to_revision is None:
868
to_revision = _mod_revision.ensure_null(branch.last_revision())
869
merger.other_rev_id = to_revision
870
if _mod_revision.is_null(merger.other_rev_id):
871
raise errors.NoCommits(branch)
872
self.branch.fetch(branch, last_revision=merger.other_rev_id)
873
merger.other_basis = merger.other_rev_id
874
merger.other_tree = self.branch.repository.revision_tree(
876
merger.other_branch = branch
877
merger.pp.next_phase()
878
if from_revision is None:
881
merger.set_base_revision(from_revision, branch)
882
if merger.base_rev_id == merger.other_rev_id:
883
raise errors.PointlessMerge
884
merger.backup_files = False
885
if merge_type is None:
886
merger.merge_type = Merge3Merger
888
merger.merge_type = merge_type
889
merger.set_interesting_files(None)
890
merger.show_base = False
891
merger.reprocess = False
892
conflicts = merger.do_merge()
899
def merge_modified(self):
900
"""Return a dictionary of files modified by a merge.
902
The list is initialized by WorkingTree.set_merge_modified, which is
903
typically called after we make some automatic updates to the tree
906
This returns a map of file_id->sha1, containing only files which are
907
still in the working inventory and have that text hash.
910
hashfile = self._transport.get('merge-hashes')
911
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
933
def mkdir(self, path, file_id=None):
934
"""See MutableTree.mkdir()."""
936
file_id = generate_ids.gen_file_id(os.path.basename(path))
937
os.mkdir(self.abspath(path))
938
self.add(path, file_id, 'directory')
941
def get_symlink_target(self, file_id):
942
return os.readlink(self.id2abspath(file_id))
945
def subsume(self, other_tree):
946
def add_children(inventory, entry):
947
for child_entry in entry.children.values():
948
inventory._byid[child_entry.file_id] = child_entry
949
if child_entry.kind == 'directory':
950
add_children(inventory, child_entry)
951
if other_tree.get_root_id() == self.get_root_id():
952
raise errors.BadSubsumeSource(self, other_tree,
953
'Trees have the same root')
955
other_tree_path = self.relpath(other_tree.basedir)
956
except errors.PathNotChild:
957
raise errors.BadSubsumeSource(self, other_tree,
958
'Tree is not contained by the other')
959
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
960
if new_root_parent is None:
961
raise errors.BadSubsumeSource(self, other_tree,
962
'Parent directory is not versioned.')
963
# We need to ensure that the result of a fetch will have a
964
# versionedfile for the other_tree root, and only fetching into
965
# RepositoryKnit2 guarantees that.
966
if not self.branch.repository.supports_rich_root():
967
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
968
other_tree.lock_tree_write()
970
new_parents = other_tree.get_parent_ids()
971
other_root = other_tree.inventory.root
972
other_root.parent_id = new_root_parent
973
other_root.name = osutils.basename(other_tree_path)
974
self.inventory.add(other_root)
975
add_children(self.inventory, other_root)
976
self._write_inventory(self.inventory)
977
# normally we don't want to fetch whole repositories, but i think
978
# here we really do want to consolidate the whole thing.
979
for parent_id in other_tree.get_parent_ids():
980
self.branch.fetch(other_tree.branch, parent_id)
981
self.add_parent_tree_id(parent_id)
984
other_tree.bzrdir.retire_bzrdir()
986
def _setup_directory_is_tree_reference(self):
987
if self._branch.repository._format.supports_tree_reference:
988
self._directory_is_tree_reference = \
989
self._directory_may_be_tree_reference
991
self._directory_is_tree_reference = \
992
self._directory_is_never_tree_reference
994
def _directory_is_never_tree_reference(self, relpath):
997
def _directory_may_be_tree_reference(self, relpath):
998
# as a special case, if a directory contains control files then
999
# it's a tree reference, except that the root of the tree is not
1000
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1001
# TODO: We could ask all the control formats whether they
1002
# recognize this directory, but at the moment there's no cheap api
1003
# to do that. Since we probably can only nest bzr checkouts and
1004
# they always use this name it's ok for now. -- mbp 20060306
1006
# FIXME: There is an unhandled case here of a subdirectory
1007
# containing .bzr but not a branch; that will probably blow up
1008
# when you try to commit it. It might happen if there is a
1009
# checkout in a subdirectory. This can be avoided by not adding
1012
@needs_tree_write_lock
1013
def extract(self, file_id, format=None):
1014
"""Extract a subtree from this tree.
1016
A new branch will be created, relative to the path for this tree.
1020
segments = osutils.splitpath(path)
1021
transport = self.branch.bzrdir.root_transport
1022
for name in segments:
1023
transport = transport.clone(name)
1024
transport.ensure_base()
1027
sub_path = self.id2path(file_id)
1028
branch_transport = mkdirs(sub_path)
1030
format = self.bzrdir.cloning_metadir()
1031
branch_transport.ensure_base()
1032
branch_bzrdir = format.initialize_on_transport(branch_transport)
1034
repo = branch_bzrdir.find_repository()
1035
except errors.NoRepositoryPresent:
1036
repo = branch_bzrdir.create_repository()
1037
if not repo.supports_rich_root():
1038
raise errors.RootNotRich()
1039
new_branch = branch_bzrdir.create_branch()
1040
new_branch.pull(self.branch)
1041
for parent_id in self.get_parent_ids():
1042
new_branch.fetch(self.branch, parent_id)
1043
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1044
if tree_transport.base != branch_transport.base:
1045
tree_bzrdir = format.initialize_on_transport(tree_transport)
1046
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1048
tree_bzrdir = branch_bzrdir
1049
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1050
wt.set_parent_ids(self.get_parent_ids())
1051
my_inv = self.inventory
1052
child_inv = Inventory(root_id=None)
1053
new_root = my_inv[file_id]
1054
my_inv.remove_recursive_id(file_id)
1055
new_root.parent_id = None
1056
child_inv.add(new_root)
1057
self._write_inventory(my_inv)
1058
wt._write_inventory(child_inv)
1061
def _serialize(self, inventory, out_file):
1062
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1065
def _deserialize(selt, in_file):
1066
return xml5.serializer_v5.read_inventory(in_file)
1069
"""Write the in memory inventory to disk."""
1070
# TODO: Maybe this should only write on dirty ?
1071
if self._control_files._lock_mode != 'w':
1072
raise errors.NotWriteLocked(self)
1074
self._serialize(self._inventory, sio)
1076
self._transport.put_file('inventory', sio,
1077
mode=self._control_files._file_mode)
1078
self._inventory_is_modified = False
1080
def _kind(self, relpath):
1081
return osutils.file_kind(self.abspath(relpath))
1083
def list_files(self, include_root=False):
1084
"""Recursively list all files as (path, class, kind, id, entry).
1086
Lists, but does not descend into unversioned directories.
1088
This does not include files that have been deleted in this
1091
Skips the control directory.
1093
# list_files is an iterator, so @needs_read_lock doesn't work properly
1094
# with it. So callers should be careful to always read_lock the tree.
1095
if not self.is_locked():
1096
raise errors.ObjectNotLocked(self)
1098
inv = self.inventory
1099
if include_root is True:
1100
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1101
# Convert these into local objects to save lookup times
1102
pathjoin = osutils.pathjoin
1103
file_kind = self._kind
1105
# transport.base ends in a slash, we want the piece
1106
# between the last two slashes
1107
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1109
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1111
# directory file_id, relative path, absolute path, reverse sorted children
1112
children = os.listdir(self.basedir)
1114
# jam 20060527 The kernel sized tree seems equivalent whether we
1115
# use a deque and popleft to keep them sorted, or if we use a plain
1116
# list and just reverse() them.
1117
children = collections.deque(children)
1118
stack = [(inv.root.file_id, u'', self.basedir, children)]
1120
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1123
f = children.popleft()
1124
## TODO: If we find a subdirectory with its own .bzr
1125
## directory, then that is a separate tree and we
1126
## should exclude it.
1128
# the bzrdir for this tree
1129
if transport_base_dir == f:
1132
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1133
# and 'f' doesn't begin with one, we can do a string op, rather
1134
# than the checks of pathjoin(), all relative paths will have an extra slash
1136
fp = from_dir_relpath + '/' + f
1139
fap = from_dir_abspath + '/' + f
1141
f_ie = inv.get_child(from_dir_id, f)
1144
elif self.is_ignored(fp[1:]):
1147
# we may not have found this file, because of a unicode issue
1148
f_norm, can_access = osutils.normalized_filename(f)
1149
if f == f_norm or not can_access:
1150
# No change, so treat this file normally
1153
# this file can be accessed by a normalized path
1154
# check again if it is versioned
1155
# these lines are repeated here for performance
1157
fp = from_dir_relpath + '/' + f
1158
fap = from_dir_abspath + '/' + f
1159
f_ie = inv.get_child(from_dir_id, f)
1162
elif self.is_ignored(fp[1:]):
1169
# make a last minute entry
1171
yield fp[1:], c, fk, f_ie.file_id, f_ie
1174
yield fp[1:], c, fk, None, fk_entries[fk]()
1176
yield fp[1:], c, fk, None, TreeEntry()
1179
if fk != 'directory':
1182
# But do this child first
1183
new_children = os.listdir(fap)
1185
new_children = collections.deque(new_children)
1186
stack.append((f_ie.file_id, fp, fap, new_children))
1187
# Break out of inner loop,
1188
# so that we start outer loop with child
1191
# if we finished all children, pop it off the stack
1194
@needs_tree_write_lock
1195
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1198
to_dir must exist in the inventory.
1200
If to_dir exists and is a directory, the files are moved into
1201
it, keeping their old names.
1203
Note that to_dir is only the last component of the new name;
1204
this doesn't change the directory.
1206
For each entry in from_paths the move mode will be determined
1209
The first mode moves the file in the filesystem and updates the
1210
inventory. The second mode only updates the inventory without
1211
touching the file on the filesystem. This is the new mode introduced
1214
move uses the second mode if 'after == True' and the target is not
1215
versioned but present in the working tree.
1217
move uses the second mode if 'after == False' and the source is
1218
versioned but no longer in the working tree, and the target is not
1219
versioned but present in the working tree.
1221
move uses the first mode if 'after == False' and the source is
1222
versioned and present in the working tree, and the target is not
1223
versioned and not present in the working tree.
1225
Everything else results in an error.
1227
This returns a list of (from_path, to_path) pairs for each
1228
entry that is moved.
1233
# check for deprecated use of signature
1235
to_dir = kwargs.get('to_name', None)
1237
raise TypeError('You must supply a target directory')
1239
symbol_versioning.warn('The parameter to_name was deprecated'
1240
' in version 0.13. Use to_dir instead',
1243
# check destination directory
1244
if isinstance(from_paths, basestring):
1246
inv = self.inventory
1247
to_abs = self.abspath(to_dir)
1248
if not isdir(to_abs):
1249
raise errors.BzrMoveFailedError('',to_dir,
1250
errors.NotADirectory(to_abs))
1251
if not self.has_filename(to_dir):
1252
raise errors.BzrMoveFailedError('',to_dir,
1253
errors.NotInWorkingDirectory(to_dir))
1254
to_dir_id = inv.path2id(to_dir)
1255
if to_dir_id is None:
1256
raise errors.BzrMoveFailedError('',to_dir,
1257
errors.NotVersionedError(path=str(to_dir)))
1259
to_dir_ie = inv[to_dir_id]
1260
if to_dir_ie.kind != 'directory':
1261
raise errors.BzrMoveFailedError('',to_dir,
1262
errors.NotADirectory(to_abs))
1264
# create rename entries and tuples
1265
for from_rel in from_paths:
1266
from_tail = splitpath(from_rel)[-1]
1267
from_id = inv.path2id(from_rel)
1269
raise errors.BzrMoveFailedError(from_rel,to_dir,
1270
errors.NotVersionedError(path=str(from_rel)))
1272
from_entry = inv[from_id]
1273
from_parent_id = from_entry.parent_id
1274
to_rel = pathjoin(to_dir, from_tail)
1275
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1277
from_tail=from_tail,
1278
from_parent_id=from_parent_id,
1279
to_rel=to_rel, to_tail=from_tail,
1280
to_parent_id=to_dir_id)
1281
rename_entries.append(rename_entry)
1282
rename_tuples.append((from_rel, to_rel))
1284
# determine which move mode to use. checks also for movability
1285
rename_entries = self._determine_mv_mode(rename_entries, after)
1287
original_modified = self._inventory_is_modified
1290
self._inventory_is_modified = True
1291
self._move(rename_entries)
1293
# restore the inventory on error
1294
self._inventory_is_modified = original_modified
1296
self._write_inventory(inv)
1297
return rename_tuples
1299
def _determine_mv_mode(self, rename_entries, after=False):
1300
"""Determines for each from-to pair if both inventory and working tree
1301
or only the inventory has to be changed.
1303
Also does basic plausability tests.
1305
inv = self.inventory
1307
for rename_entry in rename_entries:
1308
# store to local variables for easier reference
1309
from_rel = rename_entry.from_rel
1310
from_id = rename_entry.from_id
1311
to_rel = rename_entry.to_rel
1312
to_id = inv.path2id(to_rel)
1313
only_change_inv = False
1315
# check the inventory for source and destination
1317
raise errors.BzrMoveFailedError(from_rel,to_rel,
1318
errors.NotVersionedError(path=str(from_rel)))
1319
if to_id is not None:
1320
raise errors.BzrMoveFailedError(from_rel,to_rel,
1321
errors.AlreadyVersionedError(path=str(to_rel)))
1323
# try to determine the mode for rename (only change inv or change
1324
# inv and file system)
1326
if not self.has_filename(to_rel):
1327
raise errors.BzrMoveFailedError(from_id,to_rel,
1328
errors.NoSuchFile(path=str(to_rel),
1329
extra="New file has not been created yet"))
1330
only_change_inv = True
1331
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1332
only_change_inv = True
1333
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1334
only_change_inv = False
1335
elif (not self.case_sensitive
1336
and from_rel.lower() == to_rel.lower()
1337
and self.has_filename(from_rel)):
1338
only_change_inv = False
1340
# something is wrong, so lets determine what exactly
1341
if not self.has_filename(from_rel) and \
1342
not self.has_filename(to_rel):
1343
raise errors.BzrRenameFailedError(from_rel,to_rel,
1344
errors.PathsDoNotExist(paths=(str(from_rel),
1347
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1348
rename_entry.only_change_inv = only_change_inv
1349
return rename_entries
1351
def _move(self, rename_entries):
1352
"""Moves a list of files.
1354
Depending on the value of the flag 'only_change_inv', the
1355
file will be moved on the file system or not.
1357
inv = self.inventory
1360
for entry in rename_entries:
1362
self._move_entry(entry)
1364
self._rollback_move(moved)
1368
def _rollback_move(self, moved):
1369
"""Try to rollback a previous move in case of an filesystem error."""
1370
inv = self.inventory
1373
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1374
entry.to_tail, entry.to_parent_id, entry.from_rel,
1375
entry.from_tail, entry.from_parent_id,
1376
entry.only_change_inv))
1377
except errors.BzrMoveFailedError, e:
1378
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1379
" The working tree is in an inconsistent state."
1380
" Please consider doing a 'bzr revert'."
1381
" Error message is: %s" % e)
1383
def _move_entry(self, entry):
1384
inv = self.inventory
1385
from_rel_abs = self.abspath(entry.from_rel)
1386
to_rel_abs = self.abspath(entry.to_rel)
1387
if from_rel_abs == to_rel_abs:
1388
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1389
"Source and target are identical.")
1391
if not entry.only_change_inv:
1393
osutils.rename(from_rel_abs, to_rel_abs)
1395
raise errors.BzrMoveFailedError(entry.from_rel,
1397
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1399
@needs_tree_write_lock
1400
def rename_one(self, from_rel, to_rel, after=False):
1403
This can change the directory or the filename or both.
1405
rename_one has several 'modes' to work. First, it can rename a physical
1406
file and change the file_id. That is the normal mode. Second, it can
1407
only change the file_id without touching any physical file. This is
1408
the new mode introduced in version 0.15.
1410
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1411
versioned but present in the working tree.
1413
rename_one uses the second mode if 'after == False' and 'from_rel' is
1414
versioned but no longer in the working tree, and 'to_rel' is not
1415
versioned but present in the working tree.
1417
rename_one uses the first mode if 'after == False' and 'from_rel' is
1418
versioned and present in the working tree, and 'to_rel' is not
1419
versioned and not present in the working tree.
1421
Everything else results in an error.
1423
inv = self.inventory
1426
# create rename entries and tuples
1427
from_tail = splitpath(from_rel)[-1]
1428
from_id = inv.path2id(from_rel)
1430
raise errors.BzrRenameFailedError(from_rel,to_rel,
1431
errors.NotVersionedError(path=str(from_rel)))
1432
from_entry = inv[from_id]
1433
from_parent_id = from_entry.parent_id
1434
to_dir, to_tail = os.path.split(to_rel)
1435
to_dir_id = inv.path2id(to_dir)
1436
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1438
from_tail=from_tail,
1439
from_parent_id=from_parent_id,
1440
to_rel=to_rel, to_tail=to_tail,
1441
to_parent_id=to_dir_id)
1442
rename_entries.append(rename_entry)
1444
# determine which move mode to use. checks also for movability
1445
rename_entries = self._determine_mv_mode(rename_entries, after)
1447
# check if the target changed directory and if the target directory is
1449
if to_dir_id is None:
1450
raise errors.BzrMoveFailedError(from_rel,to_rel,
1451
errors.NotVersionedError(path=str(to_dir)))
1453
# all checks done. now we can continue with our actual work
1454
mutter('rename_one:\n'
1459
' to_dir_id {%s}\n',
1460
from_id, from_rel, to_rel, to_dir, to_dir_id)
1462
self._move(rename_entries)
1463
self._write_inventory(inv)
1465
class _RenameEntry(object):
1466
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1467
to_rel, to_tail, to_parent_id, only_change_inv=False):
1468
self.from_rel = from_rel
1469
self.from_id = from_id
1470
self.from_tail = from_tail
1471
self.from_parent_id = from_parent_id
1472
self.to_rel = to_rel
1473
self.to_tail = to_tail
1474
self.to_parent_id = to_parent_id
1475
self.only_change_inv = only_change_inv
1479
"""Return all unknown files.
1481
These are files in the working directory that are not versioned or
1482
control files or ignored.
1484
# force the extras method to be fully executed before returning, to
1485
# prevent race conditions with the lock
1487
[subp for subp in self.extras() if not self.is_ignored(subp)])
1489
@needs_tree_write_lock
1490
def unversion(self, file_ids):
1491
"""Remove the file ids in file_ids from the current versioned set.
1493
When a file_id is unversioned, all of its children are automatically
1496
:param file_ids: The file ids to stop versioning.
1497
:raises: NoSuchId if any fileid is not currently versioned.
1499
for file_id in file_ids:
1500
if self._inventory.has_id(file_id):
1501
self._inventory.remove_recursive_id(file_id)
1503
raise errors.NoSuchId(self, file_id)
1505
# in the future this should just set a dirty bit to wait for the
1506
# final unlock. However, until all methods of workingtree start
1507
# with the current in -memory inventory rather than triggering
1508
# a read, it is more complex - we need to teach read_inventory
1509
# to know when to read, and when to not read first... and possibly
1510
# to save first when the in memory one may be corrupted.
1511
# so for now, we just only write it if it is indeed dirty.
1513
self._write_inventory(self._inventory)
1515
def _iter_conflicts(self):
1517
for info in self.list_files():
1519
stem = get_conflicted_stem(path)
1522
if stem not in conflicted:
1523
conflicted.add(stem)
1527
def pull(self, source, overwrite=False, stop_revision=None,
1528
change_reporter=None, possible_transports=None):
1529
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1532
pp = ProgressPhase("Pull phase", 2, top_pb)
1534
old_revision_info = self.branch.last_revision_info()
1535
basis_tree = self.basis_tree()
1536
count = self.branch.pull(source, overwrite, stop_revision,
1537
possible_transports=possible_transports)
1538
new_revision_info = self.branch.last_revision_info()
1539
if new_revision_info != old_revision_info:
1541
repository = self.branch.repository
1542
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1543
basis_tree.lock_read()
1545
new_basis_tree = self.branch.basis_tree()
1552
change_reporter=change_reporter)
1553
if (basis_tree.inventory.root is None and
1554
new_basis_tree.inventory.root is not None):
1555
self.set_root_id(new_basis_tree.get_root_id())
1559
# TODO - dedup parents list with things merged by pull ?
1560
# reuse the revisiontree we merged against to set the new
1562
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1563
# we have to pull the merge trees out again, because
1564
# merge_inner has set the ids. - this corner is not yet
1565
# layered well enough to prevent double handling.
1566
# XXX TODO: Fix the double handling: telling the tree about
1567
# the already known parent data is wasteful.
1568
merges = self.get_parent_ids()[1:]
1569
parent_trees.extend([
1570
(parent, repository.revision_tree(parent)) for
1572
self.set_parent_trees(parent_trees)
1579
def put_file_bytes_non_atomic(self, file_id, bytes):
1580
"""See MutableTree.put_file_bytes_non_atomic."""
1581
stream = file(self.id2abspath(file_id), 'wb')
1586
# TODO: update the hashcache here ?
1589
"""Yield all unversioned files in this WorkingTree.
1591
If there are any unversioned directories then only the directory is
1592
returned, not all its children. But if there are unversioned files
1593
under a versioned subdirectory, they are returned.
1595
Currently returned depth-first, sorted by name within directories.
1596
This is the same order used by 'osutils.walkdirs'.
1598
## TODO: Work from given directory downwards
1599
for path, dir_entry in self.inventory.directories():
1600
# mutter("search for unknowns in %r", path)
1601
dirabs = self.abspath(path)
1602
if not isdir(dirabs):
1603
# e.g. directory deleted
1607
for subf in os.listdir(dirabs):
1610
if subf not in dir_entry.children:
1613
can_access) = osutils.normalized_filename(subf)
1614
except UnicodeDecodeError:
1615
path_os_enc = path.encode(osutils._fs_enc)
1616
relpath = path_os_enc + '/' + subf
1617
raise errors.BadFilenameEncoding(relpath,
1619
if subf_norm != subf and can_access:
1620
if subf_norm not in dir_entry.children:
1621
fl.append(subf_norm)
1627
subp = pathjoin(path, subf)
1630
def ignored_files(self):
1631
"""Yield list of PATH, IGNORE_PATTERN"""
1632
for subp in self.extras():
1633
pat = self.is_ignored(subp)
1637
def get_ignore_list(self):
1638
"""Return list of ignore patterns.
1640
Cached in the Tree object after the first call.
1642
ignoreset = getattr(self, '_ignoreset', None)
1643
if ignoreset is not None:
1646
ignore_globs = set()
1647
ignore_globs.update(ignores.get_runtime_ignores())
1648
ignore_globs.update(ignores.get_user_ignores())
1649
if self.has_filename(bzrlib.IGNORE_FILENAME):
1650
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1652
ignore_globs.update(ignores.parse_ignore_file(f))
1655
self._ignoreset = ignore_globs
1658
def _flush_ignore_list_cache(self):
1659
"""Resets the cached ignore list to force a cache rebuild."""
1660
self._ignoreset = None
1661
self._ignoreglobster = None
1663
def is_ignored(self, filename):
1664
r"""Check whether the filename matches an ignore pattern.
1666
Patterns containing '/' or '\' need to match the whole path;
1667
others match against only the last component.
1669
If the file is ignored, returns the pattern which caused it to
1670
be ignored, otherwise None. So this can simply be used as a
1671
boolean if desired."""
1672
if getattr(self, '_ignoreglobster', None) is None:
1673
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1674
return self._ignoreglobster.match(filename)
1676
def kind(self, file_id):
1677
return file_kind(self.id2abspath(file_id))
1679
def stored_kind(self, file_id):
1680
"""See Tree.stored_kind"""
1681
return self.inventory[file_id].kind
1683
def _comparison_data(self, entry, path):
1684
abspath = self.abspath(path)
1686
stat_value = os.lstat(abspath)
1688
if getattr(e, 'errno', None) == errno.ENOENT:
1695
mode = stat_value.st_mode
1696
kind = osutils.file_kind_from_stat_mode(mode)
1697
if not supports_executable():
1698
executable = entry is not None and entry.executable
1700
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1701
return kind, executable, stat_value
1703
def _file_size(self, entry, stat_value):
1704
return stat_value.st_size
1706
def last_revision(self):
1707
"""Return the last revision of the branch for this tree.
1709
This format tree does not support a separate marker for last-revision
1710
compared to the branch.
1712
See MutableTree.last_revision
1714
return self._last_revision()
1717
def _last_revision(self):
1718
"""helper for get_parent_ids."""
1719
return _mod_revision.ensure_null(self.branch.last_revision())
1721
def is_locked(self):
1722
return self._control_files.is_locked()
1724
def _must_be_locked(self):
1725
if not self.is_locked():
1726
raise errors.ObjectNotLocked(self)
1728
def lock_read(self):
1729
"""See Branch.lock_read, and WorkingTree.unlock."""
1730
if not self.is_locked():
1732
self.branch.lock_read()
1734
return self._control_files.lock_read()
1736
self.branch.unlock()
1739
def lock_tree_write(self):
1740
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1741
if not self.is_locked():
1743
self.branch.lock_read()
1745
return self._control_files.lock_write()
1747
self.branch.unlock()
1750
def lock_write(self):
1751
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1752
if not self.is_locked():
1754
self.branch.lock_write()
1756
return self._control_files.lock_write()
1758
self.branch.unlock()
1761
def get_physical_lock_status(self):
1762
return self._control_files.get_physical_lock_status()
1764
def _basis_inventory_name(self):
1765
return 'basis-inventory-cache'
1767
def _reset_data(self):
1768
"""Reset transient data that cannot be revalidated."""
1769
self._inventory_is_modified = False
1770
result = self._deserialize(self._transport.get('inventory'))
1771
self._set_inventory(result, dirty=False)
1773
@needs_tree_write_lock
1774
def set_last_revision(self, new_revision):
1775
"""Change the last revision in the working tree."""
1776
if self._change_last_revision(new_revision):
1777
self._cache_basis_inventory(new_revision)
1779
def _change_last_revision(self, new_revision):
1780
"""Template method part of set_last_revision to perform the change.
1782
This is used to allow WorkingTree3 instances to not affect branch
1783
when their last revision is set.
1785
if _mod_revision.is_null(new_revision):
1786
self.branch.set_revision_history([])
1789
self.branch.generate_revision_history(new_revision)
1790
except errors.NoSuchRevision:
1791
# not present in the repo - dont try to set it deeper than the tip
1792
self.branch.set_revision_history([new_revision])
1795
def _write_basis_inventory(self, xml):
1796
"""Write the basis inventory XML to the basis-inventory file"""
1797
path = self._basis_inventory_name()
1799
self._transport.put_file(path, sio,
1800
mode=self._control_files._file_mode)
1802
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1803
"""Create the text that will be saved in basis-inventory"""
1804
inventory.revision_id = revision_id
1805
return xml7.serializer_v7.write_inventory_to_string(inventory)
1807
def _cache_basis_inventory(self, new_revision):
1808
"""Cache new_revision as the basis inventory."""
1809
# TODO: this should allow the ready-to-use inventory to be passed in,
1810
# as commit already has that ready-to-use [while the format is the
1813
# this double handles the inventory - unpack and repack -
1814
# but is easier to understand. We can/should put a conditional
1815
# in here based on whether the inventory is in the latest format
1816
# - perhaps we should repack all inventories on a repository
1818
# the fast path is to copy the raw xml from the repository. If the
1819
# xml contains 'revision_id="', then we assume the right
1820
# revision_id is set. We must check for this full string, because a
1821
# root node id can legitimately look like 'revision_id' but cannot
1823
xml = self.branch.repository.get_inventory_xml(new_revision)
1824
firstline = xml.split('\n', 1)[0]
1825
if (not 'revision_id="' in firstline or
1826
'format="7"' not in firstline):
1827
inv = self.branch.repository.deserialise_inventory(
1829
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1830
self._write_basis_inventory(xml)
1831
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1834
def read_basis_inventory(self):
1835
"""Read the cached basis inventory."""
1836
path = self._basis_inventory_name()
1837
return self._transport.get_bytes(path)
1840
def read_working_inventory(self):
1841
"""Read the working inventory.
1843
:raises errors.InventoryModified: read_working_inventory will fail
1844
when the current in memory inventory has been modified.
1846
# conceptually this should be an implementation detail of the tree.
1847
# XXX: Deprecate this.
1848
# ElementTree does its own conversion from UTF-8, so open in
1850
if self._inventory_is_modified:
1851
raise errors.InventoryModified(self)
1852
result = self._deserialize(self._transport.get('inventory'))
1853
self._set_inventory(result, dirty=False)
1856
@needs_tree_write_lock
1857
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1859
"""Remove nominated files from the working inventory.
1861
:files: File paths relative to the basedir.
1862
:keep_files: If true, the files will also be kept.
1863
:force: Delete files and directories, even if they are changed and
1864
even if the directories are not empty.
1866
if isinstance(files, basestring):
1872
unknown_nested_files=set()
1874
def recurse_directory_to_add_files(directory):
1875
# Recurse directory and add all files
1876
# so we can check if they have changed.
1877
for parent_info, file_infos in\
1878
self.walkdirs(directory):
1879
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1880
# Is it versioned or ignored?
1881
if self.path2id(relpath) or self.is_ignored(relpath):
1882
# Add nested content for deletion.
1883
new_files.add(relpath)
1885
# Files which are not versioned and not ignored
1886
# should be treated as unknown.
1887
unknown_nested_files.add((relpath, None, kind))
1889
for filename in files:
1890
# Get file name into canonical form.
1891
abspath = self.abspath(filename)
1892
filename = self.relpath(abspath)
1893
if len(filename) > 0:
1894
new_files.add(filename)
1895
recurse_directory_to_add_files(filename)
1897
files = list(new_files)
1900
return # nothing to do
1902
# Sort needed to first handle directory content before the directory
1903
files.sort(reverse=True)
1905
# Bail out if we are going to delete files we shouldn't
1906
if not keep_files and not force:
1907
has_changed_files = len(unknown_nested_files) > 0
1908
if not has_changed_files:
1909
for (file_id, path, content_change, versioned, parent_id, name,
1910
kind, executable) in self.iter_changes(self.basis_tree(),
1911
include_unchanged=True, require_versioned=False,
1912
want_unversioned=True, specific_files=files):
1913
if versioned == (False, False):
1914
# The record is unknown ...
1915
if not self.is_ignored(path[1]):
1916
# ... but not ignored
1917
has_changed_files = True
1919
elif content_change and (kind[1] is not None):
1920
# Versioned and changed, but not deleted
1921
has_changed_files = True
1924
if has_changed_files:
1925
# Make delta show ALL applicable changes in error message.
1926
tree_delta = self.changes_from(self.basis_tree(),
1927
require_versioned=False, want_unversioned=True,
1928
specific_files=files)
1929
for unknown_file in unknown_nested_files:
1930
if unknown_file not in tree_delta.unversioned:
1931
tree_delta.unversioned.extend((unknown_file,))
1932
raise errors.BzrRemoveChangedFilesError(tree_delta)
1934
# Build inv_delta and delete files where applicaple,
1935
# do this before any modifications to inventory.
1937
fid = self.path2id(f)
1940
message = "%s is not versioned." % (f,)
1943
# having removed it, it must be either ignored or unknown
1944
if self.is_ignored(f):
1948
textui.show_status(new_status, self.kind(fid), f,
1951
inv_delta.append((f, None, fid, None))
1952
message = "removed %s" % (f,)
1955
abs_path = self.abspath(f)
1956
if osutils.lexists(abs_path):
1957
if (osutils.isdir(abs_path) and
1958
len(os.listdir(abs_path)) > 0):
1960
osutils.rmtree(abs_path)
1962
message = "%s is not an empty directory "\
1963
"and won't be deleted." % (f,)
1965
osutils.delete_any(abs_path)
1966
message = "deleted %s" % (f,)
1967
elif message is not None:
1968
# Only care if we haven't done anything yet.
1969
message = "%s does not exist." % (f,)
1971
# Print only one message (if any) per file.
1972
if message is not None:
1974
self.apply_inventory_delta(inv_delta)
1976
@needs_tree_write_lock
1977
def revert(self, filenames=None, old_tree=None, backups=True,
1978
pb=DummyProgress(), report_changes=False):
1979
from bzrlib.conflicts import resolve
1982
symbol_versioning.warn('Using [] to revert all files is deprecated'
1983
' as of bzr 0.91. Please use None (the default) instead.',
1984
DeprecationWarning, stacklevel=2)
1985
if old_tree is None:
1986
basis_tree = self.basis_tree()
1987
basis_tree.lock_read()
1988
old_tree = basis_tree
1992
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1994
if filenames is None and len(self.get_parent_ids()) > 1:
1996
last_revision = self.last_revision()
1997
if last_revision != NULL_REVISION:
1998
if basis_tree is None:
1999
basis_tree = self.basis_tree()
2000
basis_tree.lock_read()
2001
parent_trees.append((last_revision, basis_tree))
2002
self.set_parent_trees(parent_trees)
2005
resolve(self, filenames, ignore_misses=True, recursive=True)
2007
if basis_tree is not None:
2011
def revision_tree(self, revision_id):
2012
"""See Tree.revision_tree.
2014
WorkingTree can supply revision_trees for the basis revision only
2015
because there is only one cached inventory in the bzr directory.
2017
if revision_id == self.last_revision():
2019
xml = self.read_basis_inventory()
2020
except errors.NoSuchFile:
2024
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2025
# dont use the repository revision_tree api because we want
2026
# to supply the inventory.
2027
if inv.revision_id == revision_id:
2028
return revisiontree.RevisionTree(self.branch.repository,
2030
except errors.BadInventoryFormat:
2032
# raise if there was no inventory, or if we read the wrong inventory.
2033
raise errors.NoSuchRevisionInTree(self, revision_id)
2035
# XXX: This method should be deprecated in favour of taking in a proper
2036
# new Inventory object.
2037
@needs_tree_write_lock
2038
def set_inventory(self, new_inventory_list):
2039
from bzrlib.inventory import (Inventory,
2044
inv = Inventory(self.get_root_id())
2045
for path, file_id, parent, kind in new_inventory_list:
2046
name = os.path.basename(path)
2049
# fixme, there should be a factory function inv,add_??
2050
if kind == 'directory':
2051
inv.add(InventoryDirectory(file_id, name, parent))
2052
elif kind == 'file':
2053
inv.add(InventoryFile(file_id, name, parent))
2054
elif kind == 'symlink':
2055
inv.add(InventoryLink(file_id, name, parent))
2057
raise errors.BzrError("unknown kind %r" % kind)
2058
self._write_inventory(inv)
2060
@needs_tree_write_lock
2061
def set_root_id(self, file_id):
2062
"""Set the root id for this tree."""
2066
'WorkingTree.set_root_id with fileid=None')
2067
file_id = osutils.safe_file_id(file_id)
2068
self._set_root_id(file_id)
2070
def _set_root_id(self, file_id):
2071
"""Set the root id for this tree, in a format specific manner.
2073
:param file_id: The file id to assign to the root. It must not be
2074
present in the current inventory or an error will occur. It must
2075
not be None, but rather a valid file id.
2077
inv = self._inventory
2078
orig_root_id = inv.root.file_id
2079
# TODO: it might be nice to exit early if there was nothing
2080
# to do, saving us from trigger a sync on unlock.
2081
self._inventory_is_modified = True
2082
# we preserve the root inventory entry object, but
2083
# unlinkit from the byid index
2084
del inv._byid[inv.root.file_id]
2085
inv.root.file_id = file_id
2086
# and link it into the index with the new changed id.
2087
inv._byid[inv.root.file_id] = inv.root
2088
# and finally update all children to reference the new id.
2089
# XXX: this should be safe to just look at the root.children
2090
# list, not the WHOLE INVENTORY.
2093
if entry.parent_id == orig_root_id:
2094
entry.parent_id = inv.root.file_id
2097
"""See Branch.unlock.
2099
WorkingTree locking just uses the Branch locking facilities.
2100
This is current because all working trees have an embedded branch
2101
within them. IF in the future, we were to make branch data shareable
2102
between multiple working trees, i.e. via shared storage, then we
2103
would probably want to lock both the local tree, and the branch.
2105
raise NotImplementedError(self.unlock)
2107
def update(self, change_reporter=None, possible_transports=None):
2108
"""Update a working tree along its branch.
2110
This will update the branch if its bound too, which means we have
2111
multiple trees involved:
2113
- The new basis tree of the master.
2114
- The old basis tree of the branch.
2115
- The old basis tree of the working tree.
2116
- The current working tree state.
2118
Pathologically, all three may be different, and non-ancestors of each
2119
other. Conceptually we want to:
2121
- Preserve the wt.basis->wt.state changes
2122
- Transform the wt.basis to the new master basis.
2123
- Apply a merge of the old branch basis to get any 'local' changes from
2125
- Restore the wt.basis->wt.state changes.
2127
There isn't a single operation at the moment to do that, so we:
2128
- Merge current state -> basis tree of the master w.r.t. the old tree
2130
- Do a 'normal' merge of the old branch basis if it is relevant.
2132
if self.branch.get_bound_location() is not None:
2134
update_branch = True
2136
self.lock_tree_write()
2137
update_branch = False
2140
old_tip = self.branch.update(possible_transports)
2143
return self._update_tree(old_tip, change_reporter)
2147
@needs_tree_write_lock
2148
def _update_tree(self, old_tip=None, change_reporter=None):
2149
"""Update a tree to the master branch.
2151
:param old_tip: if supplied, the previous tip revision the branch,
2152
before it was changed to the master branch's tip.
2154
# here if old_tip is not None, it is the old tip of the branch before
2155
# it was updated from the master branch. This should become a pending
2156
# merge in the working tree to preserve the user existing work. we
2157
# cant set that until we update the working trees last revision to be
2158
# one from the new branch, because it will just get absorbed by the
2159
# parent de-duplication logic.
2161
# We MUST save it even if an error occurs, because otherwise the users
2162
# local work is unreferenced and will appear to have been lost.
2166
last_rev = self.get_parent_ids()[0]
2168
last_rev = _mod_revision.NULL_REVISION
2169
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2170
# merge tree state up to new branch tip.
2171
basis = self.basis_tree()
2174
to_tree = self.branch.basis_tree()
2175
if basis.inventory.root is None:
2176
self.set_root_id(to_tree.get_root_id())
2178
result += merge.merge_inner(
2183
change_reporter=change_reporter)
2186
# TODO - dedup parents list with things merged by pull ?
2187
# reuse the tree we've updated to to set the basis:
2188
parent_trees = [(self.branch.last_revision(), to_tree)]
2189
merges = self.get_parent_ids()[1:]
2190
# Ideally we ask the tree for the trees here, that way the working
2191
# tree can decide whether to give us teh entire tree or give us a
2192
# lazy initialised tree. dirstate for instance will have the trees
2193
# in ram already, whereas a last-revision + basis-inventory tree
2194
# will not, but also does not need them when setting parents.
2195
for parent in merges:
2196
parent_trees.append(
2197
(parent, self.branch.repository.revision_tree(parent)))
2198
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2199
parent_trees.append(
2200
(old_tip, self.branch.repository.revision_tree(old_tip)))
2201
self.set_parent_trees(parent_trees)
2202
last_rev = parent_trees[0][0]
2204
# the working tree had the same last-revision as the master
2205
# branch did. We may still have pivot local work from the local
2206
# branch into old_tip:
2207
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2208
self.add_parent_tree_id(old_tip)
2209
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2210
and old_tip != last_rev):
2211
# our last revision was not the prior branch last revision
2212
# and we have converted that last revision to a pending merge.
2213
# base is somewhere between the branch tip now
2214
# and the now pending merge
2216
# Since we just modified the working tree and inventory, flush out
2217
# the current state, before we modify it again.
2218
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2219
# requires it only because TreeTransform directly munges the
2220
# inventory and calls tree._write_inventory(). Ultimately we
2221
# should be able to remove this extra flush.
2223
graph = self.branch.repository.get_graph()
2224
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2226
base_tree = self.branch.repository.revision_tree(base_rev_id)
2227
other_tree = self.branch.repository.revision_tree(old_tip)
2228
result += merge.merge_inner(
2233
change_reporter=change_reporter)
2236
def _write_hashcache_if_dirty(self):
2237
"""Write out the hashcache if it is dirty."""
2238
if self._hashcache.needs_write:
2240
self._hashcache.write()
2242
if e.errno not in (errno.EPERM, errno.EACCES):
2244
# TODO: jam 20061219 Should this be a warning? A single line
2245
# warning might be sufficient to let the user know what
2247
mutter('Could not write hashcache for %s\nError: %s',
2248
self._hashcache.cache_file_name(), e)
2250
@needs_tree_write_lock
2251
def _write_inventory(self, inv):
2252
"""Write inventory as the current inventory."""
2253
self._set_inventory(inv, dirty=True)
2256
def set_conflicts(self, arg):
2257
raise errors.UnsupportedOperation(self.set_conflicts, self)
2259
def add_conflicts(self, arg):
2260
raise errors.UnsupportedOperation(self.add_conflicts, self)
2263
def conflicts(self):
2264
conflicts = _mod_conflicts.ConflictList()
2265
for conflicted in self._iter_conflicts():
2268
if file_kind(self.abspath(conflicted)) != "file":
2270
except errors.NoSuchFile:
2273
for suffix in ('.THIS', '.OTHER'):
2275
kind = file_kind(self.abspath(conflicted+suffix))
2278
except errors.NoSuchFile:
2282
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2283
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2285
file_id=self.path2id(conflicted)))
2288
def walkdirs(self, prefix=""):
2289
"""Walk the directories of this tree.
2291
returns a generator which yields items in the form:
2292
((curren_directory_path, fileid),
2293
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2296
This API returns a generator, which is only valid during the current
2297
tree transaction - within a single lock_read or lock_write duration.
2299
If the tree is not locked, it may cause an error to be raised,
2300
depending on the tree implementation.
2302
disk_top = self.abspath(prefix)
2303
if disk_top.endswith('/'):
2304
disk_top = disk_top[:-1]
2305
top_strip_len = len(disk_top) + 1
2306
inventory_iterator = self._walkdirs(prefix)
2307
disk_iterator = osutils.walkdirs(disk_top, prefix)
2309
current_disk = disk_iterator.next()
2310
disk_finished = False
2312
if not (e.errno == errno.ENOENT or
2313
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2316
disk_finished = True
2318
current_inv = inventory_iterator.next()
2319
inv_finished = False
2320
except StopIteration:
2323
while not inv_finished or not disk_finished:
2325
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2326
cur_disk_dir_content) = current_disk
2328
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2329
cur_disk_dir_content) = ((None, None), None)
2330
if not disk_finished:
2331
# strip out .bzr dirs
2332
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2333
len(cur_disk_dir_content) > 0):
2334
# osutils.walkdirs can be made nicer -
2335
# yield the path-from-prefix rather than the pathjoined
2337
bzrdir_loc = bisect_left(cur_disk_dir_content,
2339
if (bzrdir_loc < len(cur_disk_dir_content)
2340
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2341
# we dont yield the contents of, or, .bzr itself.
2342
del cur_disk_dir_content[bzrdir_loc]
2344
# everything is unknown
2347
# everything is missing
2350
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2352
# disk is before inventory - unknown
2353
dirblock = [(relpath, basename, kind, stat, None, None) for
2354
relpath, basename, kind, stat, top_path in
2355
cur_disk_dir_content]
2356
yield (cur_disk_dir_relpath, None), dirblock
2358
current_disk = disk_iterator.next()
2359
except StopIteration:
2360
disk_finished = True
2362
# inventory is before disk - missing.
2363
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2364
for relpath, basename, dkind, stat, fileid, kind in
2366
yield (current_inv[0][0], current_inv[0][1]), dirblock
2368
current_inv = inventory_iterator.next()
2369
except StopIteration:
2372
# versioned present directory
2373
# merge the inventory and disk data together
2375
for relpath, subiterator in itertools.groupby(sorted(
2376
current_inv[1] + cur_disk_dir_content,
2377
key=operator.itemgetter(0)), operator.itemgetter(1)):
2378
path_elements = list(subiterator)
2379
if len(path_elements) == 2:
2380
inv_row, disk_row = path_elements
2381
# versioned, present file
2382
dirblock.append((inv_row[0],
2383
inv_row[1], disk_row[2],
2384
disk_row[3], inv_row[4],
2386
elif len(path_elements[0]) == 5:
2388
dirblock.append((path_elements[0][0],
2389
path_elements[0][1], path_elements[0][2],
2390
path_elements[0][3], None, None))
2391
elif len(path_elements[0]) == 6:
2392
# versioned, absent file.
2393
dirblock.append((path_elements[0][0],
2394
path_elements[0][1], 'unknown', None,
2395
path_elements[0][4], path_elements[0][5]))
2397
raise NotImplementedError('unreachable code')
2398
yield current_inv[0], dirblock
2400
current_inv = inventory_iterator.next()
2401
except StopIteration:
2404
current_disk = disk_iterator.next()
2405
except StopIteration:
2406
disk_finished = True
2408
def _walkdirs(self, prefix=""):
2409
"""Walk the directories of this tree.
2411
:prefix: is used as the directrory to start with.
2412
returns a generator which yields items in the form:
2413
((curren_directory_path, fileid),
2414
[(file1_path, file1_name, file1_kind, None, file1_id,
2417
_directory = 'directory'
2418
# get the root in the inventory
2419
inv = self.inventory
2420
top_id = inv.path2id(prefix)
2424
pending = [(prefix, '', _directory, None, top_id, None)]
2427
currentdir = pending.pop()
2428
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2429
top_id = currentdir[4]
2431
relroot = currentdir[0] + '/'
2434
# FIXME: stash the node in pending
2436
if entry.kind == 'directory':
2437
for name, child in entry.sorted_children():
2438
dirblock.append((relroot + name, name, child.kind, None,
2439
child.file_id, child.kind
2441
yield (currentdir[0], entry.file_id), dirblock
2442
# push the user specified dirs from dirblock
2443
for dir in reversed(dirblock):
2444
if dir[2] == _directory:
2447
@needs_tree_write_lock
2448
def auto_resolve(self):
2449
"""Automatically resolve text conflicts according to contents.
2451
Only text conflicts are auto_resolvable. Files with no conflict markers
2452
are considered 'resolved', because bzr always puts conflict markers
2453
into files that have text conflicts. The corresponding .THIS .BASE and
2454
.OTHER files are deleted, as per 'resolve'.
2455
:return: a tuple of ConflictLists: (un_resolved, resolved).
2457
un_resolved = _mod_conflicts.ConflictList()
2458
resolved = _mod_conflicts.ConflictList()
2459
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2460
for conflict in self.conflicts():
2461
if (conflict.typestring != 'text conflict' or
2462
self.kind(conflict.file_id) != 'file'):
2463
un_resolved.append(conflict)
2465
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2467
for line in my_file:
2468
if conflict_re.search(line):
2469
un_resolved.append(conflict)
2472
resolved.append(conflict)
2475
resolved.remove_files(self)
2476
self.set_conflicts(un_resolved)
2477
return un_resolved, resolved
2481
tree_basis = self.basis_tree()
2482
tree_basis.lock_read()
2484
repo_basis = self.branch.repository.revision_tree(
2485
self.last_revision())
2486
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2487
raise errors.BzrCheckError(
2488
"Mismatched basis inventory content.")
2493
def _validate(self):
2494
"""Validate internal structures.
2496
This is meant mostly for the test suite. To give it a chance to detect
2497
corruption after actions have occurred. The default implementation is a
2500
:return: None. An exception should be raised if there is an error.
2505
def _get_rules_searcher(self, default_searcher):
2506
"""See Tree._get_rules_searcher."""
2507
if self._rules_searcher is None:
2508
self._rules_searcher = super(WorkingTree,
2509
self)._get_rules_searcher(default_searcher)
2510
return self._rules_searcher
2513
class WorkingTree2(WorkingTree):
2514
"""This is the Format 2 working tree.
2516
This was the first weave based working tree.
2517
- uses os locks for locking.
2518
- uses the branch last-revision.
2521
def __init__(self, *args, **kwargs):
2522
super(WorkingTree2, self).__init__(*args, **kwargs)
2523
# WorkingTree2 has more of a constraint that self._inventory must
2524
# exist. Because this is an older format, we don't mind the overhead
2525
# caused by the extra computation here.
2527
# Newer WorkingTree's should only have self._inventory set when they
2529
if self._inventory is None:
2530
self.read_working_inventory()
2532
def lock_tree_write(self):
2533
"""See WorkingTree.lock_tree_write().
2535
In Format2 WorkingTrees we have a single lock for the branch and tree
2536
so lock_tree_write() degrades to lock_write().
2538
self.branch.lock_write()
2540
return self._control_files.lock_write()
2542
self.branch.unlock()
2546
# do non-implementation specific cleanup
2549
# we share control files:
2550
if self._control_files._lock_count == 3:
2551
# _inventory_is_modified is always False during a read lock.
2552
if self._inventory_is_modified:
2554
self._write_hashcache_if_dirty()
2556
# reverse order of locking.
2558
return self._control_files.unlock()
2560
self.branch.unlock()
2563
class WorkingTree3(WorkingTree):
2564
"""This is the Format 3 working tree.
2566
This differs from the base WorkingTree by:
2567
- having its own file lock
2568
- having its own last-revision property.
2570
This is new in bzr 0.8
2574
def _last_revision(self):
2575
"""See Mutable.last_revision."""
2577
return self._transport.get_bytes('last-revision')
2578
except errors.NoSuchFile:
2579
return _mod_revision.NULL_REVISION
2581
def _change_last_revision(self, revision_id):
2582
"""See WorkingTree._change_last_revision."""
2583
if revision_id is None or revision_id == NULL_REVISION:
2585
self._transport.delete('last-revision')
2586
except errors.NoSuchFile:
2590
self._transport.put_bytes('last-revision', revision_id,
2591
mode=self._control_files._file_mode)
2594
@needs_tree_write_lock
2595
def set_conflicts(self, conflicts):
2596
self._put_rio('conflicts', conflicts.to_stanzas(),
2599
@needs_tree_write_lock
2600
def add_conflicts(self, new_conflicts):
2601
conflict_set = set(self.conflicts())
2602
conflict_set.update(set(list(new_conflicts)))
2603
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2604
key=_mod_conflicts.Conflict.sort_key)))
2607
def conflicts(self):
2609
confile = self._transport.get('conflicts')
2610
except errors.NoSuchFile:
2611
return _mod_conflicts.ConflictList()
2614
if confile.next() != CONFLICT_HEADER_1 + '\n':
2615
raise errors.ConflictFormatError()
2616
except StopIteration:
2617
raise errors.ConflictFormatError()
2618
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2623
# do non-implementation specific cleanup
2625
if self._control_files._lock_count == 1:
2626
# _inventory_is_modified is always False during a read lock.
2627
if self._inventory_is_modified:
2629
self._write_hashcache_if_dirty()
2630
# reverse order of locking.
2632
return self._control_files.unlock()
2634
self.branch.unlock()
2637
def get_conflicted_stem(path):
2638
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2639
if path.endswith(suffix):
2640
return path[:-len(suffix)]
2643
class WorkingTreeFormat(object):
2644
"""An encapsulation of the initialization and open routines for a format.
2646
Formats provide three things:
2647
* An initialization routine,
2651
Formats are placed in an dict by their format string for reference
2652
during workingtree opening. Its not required that these be instances, they
2653
can be classes themselves with class methods - it simply depends on
2654
whether state is needed for a given format or not.
2656
Once a format is deprecated, just deprecate the initialize and open
2657
methods on the format class. Do not deprecate the object, as the
2658
object will be created every time regardless.
2661
_default_format = None
2662
"""The default format used for new trees."""
2665
"""The known formats."""
2667
requires_rich_root = False
2669
upgrade_recommended = False
2672
def find_format(klass, a_bzrdir):
2673
"""Return the format for the working tree object in a_bzrdir."""
2675
transport = a_bzrdir.get_workingtree_transport(None)
2676
format_string = transport.get("format").read()
2677
return klass._formats[format_string]
2678
except errors.NoSuchFile:
2679
raise errors.NoWorkingTree(base=transport.base)
2681
raise errors.UnknownFormatError(format=format_string,
2682
kind="working tree")
2684
def __eq__(self, other):
2685
return self.__class__ is other.__class__
2687
def __ne__(self, other):
2688
return not (self == other)
2691
def get_default_format(klass):
2692
"""Return the current default format."""
2693
return klass._default_format
2695
def get_format_string(self):
2696
"""Return the ASCII format string that identifies this format."""
2697
raise NotImplementedError(self.get_format_string)
2699
def get_format_description(self):
2700
"""Return the short description for this format."""
2701
raise NotImplementedError(self.get_format_description)
2703
def is_supported(self):
2704
"""Is this format supported?
2706
Supported formats can be initialized and opened.
2707
Unsupported formats may not support initialization or committing or
2708
some other features depending on the reason for not being supported.
2713
def register_format(klass, format):
2714
klass._formats[format.get_format_string()] = format
2717
def set_default_format(klass, format):
2718
klass._default_format = format
2721
def unregister_format(klass, format):
2722
del klass._formats[format.get_format_string()]
2725
class WorkingTreeFormat2(WorkingTreeFormat):
2726
"""The second working tree format.
2728
This format modified the hash cache from the format 1 hash cache.
2731
upgrade_recommended = True
2733
def get_format_description(self):
2734
"""See WorkingTreeFormat.get_format_description()."""
2735
return "Working tree format 2"
2737
def _stub_initialize_on_transport(self, transport, file_mode):
2738
"""Workaround: create control files for a remote working tree.
2740
This ensures that it can later be updated and dealt with locally,
2741
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2742
no working tree. (See bug #43064).
2746
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2748
transport.put_file('inventory', sio, file_mode)
2749
transport.put_bytes('pending-merges', '', file_mode)
2751
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2752
accelerator_tree=None, hardlink=False):
2753
"""See WorkingTreeFormat.initialize()."""
2754
if not isinstance(a_bzrdir.transport, LocalTransport):
2755
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2756
if from_branch is not None:
2757
branch = from_branch
2759
branch = a_bzrdir.open_branch()
2760
if revision_id is None:
2761
revision_id = _mod_revision.ensure_null(branch.last_revision())
2764
branch.generate_revision_history(revision_id)
2768
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2774
basis_tree = branch.repository.revision_tree(revision_id)
2775
if basis_tree.inventory.root is not None:
2776
wt.set_root_id(basis_tree.get_root_id())
2777
# set the parent list and cache the basis tree.
2778
if _mod_revision.is_null(revision_id):
2781
parent_trees = [(revision_id, basis_tree)]
2782
wt.set_parent_trees(parent_trees)
2783
transform.build_tree(basis_tree, wt)
2787
super(WorkingTreeFormat2, self).__init__()
2788
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2790
def open(self, a_bzrdir, _found=False):
2791
"""Return the WorkingTree object for a_bzrdir
2793
_found is a private parameter, do not use it. It is used to indicate
2794
if format probing has already been done.
2797
# we are being called directly and must probe.
2798
raise NotImplementedError
2799
if not isinstance(a_bzrdir.transport, LocalTransport):
2800
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2801
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2807
class WorkingTreeFormat3(WorkingTreeFormat):
2808
"""The second working tree format updated to record a format marker.
2811
- exists within a metadir controlling .bzr
2812
- includes an explicit version marker for the workingtree control
2813
files, separate from the BzrDir format
2814
- modifies the hash cache format
2816
- uses a LockDir to guard access for writes.
2819
upgrade_recommended = True
2821
def get_format_string(self):
2822
"""See WorkingTreeFormat.get_format_string()."""
2823
return "Bazaar-NG Working Tree format 3"
2825
def get_format_description(self):
2826
"""See WorkingTreeFormat.get_format_description()."""
2827
return "Working tree format 3"
2829
_lock_file_name = 'lock'
2830
_lock_class = LockDir
2832
_tree_class = WorkingTree3
2834
def __get_matchingbzrdir(self):
2835
return bzrdir.BzrDirMetaFormat1()
2837
_matchingbzrdir = property(__get_matchingbzrdir)
2839
def _open_control_files(self, a_bzrdir):
2840
transport = a_bzrdir.get_workingtree_transport(None)
2841
return LockableFiles(transport, self._lock_file_name,
2844
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2845
accelerator_tree=None, hardlink=False):
2846
"""See WorkingTreeFormat.initialize().
2848
:param revision_id: if supplied, create a working tree at a different
2849
revision than the branch is at.
2850
:param accelerator_tree: A tree which can be used for retrieving file
2851
contents more quickly than the revision tree, i.e. a workingtree.
2852
The revision tree will be used for cases where accelerator_tree's
2853
content is different.
2854
:param hardlink: If true, hard-link files from accelerator_tree,
2857
if not isinstance(a_bzrdir.transport, LocalTransport):
2858
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2859
transport = a_bzrdir.get_workingtree_transport(self)
2860
control_files = self._open_control_files(a_bzrdir)
2861
control_files.create_lock()
2862
control_files.lock_write()
2863
transport.put_bytes('format', self.get_format_string(),
2864
mode=control_files._file_mode)
2865
if from_branch is not None:
2866
branch = from_branch
2868
branch = a_bzrdir.open_branch()
2869
if revision_id is None:
2870
revision_id = _mod_revision.ensure_null(branch.last_revision())
2871
# WorkingTree3 can handle an inventory which has a unique root id.
2872
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2873
# those trees. And because there isn't a format bump inbetween, we
2874
# are maintaining compatibility with older clients.
2875
# inv = Inventory(root_id=gen_root_id())
2876
inv = self._initial_inventory()
2877
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2883
_control_files=control_files)
2884
wt.lock_tree_write()
2886
basis_tree = branch.repository.revision_tree(revision_id)
2887
# only set an explicit root id if there is one to set.
2888
if basis_tree.inventory.root is not None:
2889
wt.set_root_id(basis_tree.get_root_id())
2890
if revision_id == NULL_REVISION:
2891
wt.set_parent_trees([])
2893
wt.set_parent_trees([(revision_id, basis_tree)])
2894
transform.build_tree(basis_tree, wt)
2896
# Unlock in this order so that the unlock-triggers-flush in
2897
# WorkingTree is given a chance to fire.
2898
control_files.unlock()
2902
def _initial_inventory(self):
2906
super(WorkingTreeFormat3, self).__init__()
2908
def open(self, a_bzrdir, _found=False):
2909
"""Return the WorkingTree object for a_bzrdir
2911
_found is a private parameter, do not use it. It is used to indicate
2912
if format probing has already been done.
2915
# we are being called directly and must probe.
2916
raise NotImplementedError
2917
if not isinstance(a_bzrdir.transport, LocalTransport):
2918
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2919
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2922
def _open(self, a_bzrdir, control_files):
2923
"""Open the tree itself.
2925
:param a_bzrdir: the dir for the tree.
2926
:param control_files: the control files for the tree.
2928
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2932
_control_files=control_files)
2935
return self.get_format_string()
2938
__default_format = WorkingTreeFormat4()
2939
WorkingTreeFormat.register_format(__default_format)
2940
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2941
WorkingTreeFormat.set_default_format(__default_format)
2942
# formats which have no format string are not discoverable
2943
# and not independently creatable, so are not registered.
2944
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
