1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
59
conflicts as _mod_conflicts,
67
revision as _mod_revision,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib import osutils
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
class TreeEntry(object):
124
"""An entry that implements the minimum interface used by commands.
126
This needs further inspection, it may be better to have
127
InventoryEntries without ids - though that seems wrong. For now,
128
this is a parallel hierarchy to InventoryEntry, and needs to become
129
one of several things: decorates to that hierarchy, children of, or
131
Another note is that these objects are currently only used when there is
132
no InventoryEntry available - i.e. for unversioned objects.
133
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
136
def __eq__(self, other):
137
# yes, this us ugly, TODO: best practice __eq__ style.
138
return (isinstance(other, TreeEntry)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeDirectory(TreeEntry):
146
"""See TreeEntry. This is a directory in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeDirectory)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeFile(TreeEntry):
157
"""See TreeEntry. This is a regular file in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeFile)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class TreeLink(TreeEntry):
168
"""See TreeEntry. This is a symlink in a working tree."""
170
def __eq__(self, other):
171
return (isinstance(other, TreeLink)
172
and other.__class__ == self.__class__)
174
def kind_character(self):
178
class WorkingTree(bzrlib.mutabletree.MutableTree):
179
"""Working copy tree.
181
The inventory is held in the `Branch` working-inventory, and the
182
files are in a directory on disk.
184
It is possible for a `WorkingTree` to have a filename which is
185
not listed in the Inventory and vice versa.
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode())
231
# is this scan needed ? it makes things kinda slow.
238
if _inventory is None:
239
# This will be acquired on lock_read() or lock_write()
240
self._inventory_is_modified = False
241
self._inventory = None
243
# the caller of __init__ has provided an inventory,
244
# we assume they know what they are doing - as its only
245
# the Format factory and creation methods that are
246
# permitted to do this.
247
self._set_inventory(_inventory, dirty=False)
248
self._detect_case_handling()
249
self._rules_searcher = None
251
def _detect_case_handling(self):
252
wt_trans = self.bzrdir.get_workingtree_transport(None)
254
wt_trans.stat("FoRMaT")
255
except errors.NoSuchFile:
256
self.case_sensitive = True
258
self.case_sensitive = False
260
self._setup_directory_is_tree_reference()
263
fget=lambda self: self._branch,
264
doc="""The branch this WorkingTree is connected to.
266
This cannot be set - it is reflective of the actual disk structure
267
the working tree has been constructed from.
270
def break_lock(self):
271
"""Break a lock if one is present from another instance.
273
Uses the ui factory to ask for confirmation if the lock may be from
276
This will probe the repository for its lock as well.
278
self._control_files.break_lock()
279
self.branch.break_lock()
281
def requires_rich_root(self):
282
return self._format.requires_rich_root
284
def supports_tree_reference(self):
287
def _set_inventory(self, inv, dirty):
288
"""Set the internal cached inventory.
290
:param inv: The inventory to set.
291
:param dirty: A boolean indicating whether the inventory is the same
292
logical inventory as whats on disk. If True the inventory is not
293
the same and should be written to disk or data will be lost, if
294
False then the inventory is the same as that on disk and any
295
serialisation would be unneeded overhead.
297
self._inventory = inv
298
self._inventory_is_modified = dirty
301
def open(path=None, _unsupported=False):
302
"""Open an existing working tree at path.
306
path = os.path.getcwdu()
307
control = bzrdir.BzrDir.open(path, _unsupported)
308
return control.open_workingtree(_unsupported)
311
def open_containing(path=None):
312
"""Open an existing working tree which has its root about path.
314
This probes for a working tree at path and searches upwards from there.
316
Basically we keep looking up until we find the control directory or
317
run into /. If there isn't one, raises NotBranchError.
318
TODO: give this a new exception.
319
If there is one, it is returned, along with the unused portion of path.
321
:return: The WorkingTree that contains 'path', and the rest of path
324
path = osutils.getcwd()
325
control, relpath = bzrdir.BzrDir.open_containing(path)
327
return control.open_workingtree(), relpath
330
def open_downlevel(path=None):
331
"""Open an unsupported working tree.
333
Only intended for advanced situations like upgrading part of a bzrdir.
335
return WorkingTree.open(path, _unsupported=True)
338
def find_trees(location):
339
def list_current(transport):
340
return [d for d in transport.list_dir('') if d != '.bzr']
341
def evaluate(bzrdir):
343
tree = bzrdir.open_workingtree()
344
except errors.NoWorkingTree:
348
transport = get_transport(location)
349
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
350
list_current=list_current)
351
return [t for t in iterator if t is not None]
353
# should be deprecated - this is slow and in any case treating them as a
354
# container is (we now know) bad style -- mbp 20070302
355
## @deprecated_method(zero_fifteen)
357
"""Iterate through file_ids for this tree.
359
file_ids are in a WorkingTree if they are in the working inventory
360
and the working file exists.
362
inv = self._inventory
363
for path, ie in inv.iter_entries():
364
if osutils.lexists(self.abspath(path)):
367
def all_file_ids(self):
368
"""See Tree.iter_all_file_ids"""
369
return set(self.inventory)
372
return "<%s of %s>" % (self.__class__.__name__,
373
getattr(self, 'basedir', None))
375
def abspath(self, filename):
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling repository.revision_tree(None).
385
revision_id = self.get_parent_ids()[0]
387
# no parents, return an empty revision tree.
388
# in the future this should return the tree for
389
# 'empty:' - the implicit root empty tree.
390
return self.branch.repository.revision_tree(None)
392
return self.revision_tree(revision_id)
393
except errors.NoSuchRevision:
395
# No cached copy available, retrieve from the repository.
396
# FIXME? RBC 20060403 should we cache the inventory locally
399
return self.branch.repository.revision_tree(revision_id)
400
except (errors.RevisionNotPresent, errors.NoSuchRevision):
401
# the basis tree *may* be a ghost or a low level error may have
402
# occured. If the revision is present, its a problem, if its not
404
if self.branch.repository.has_revision(revision_id):
406
# the basis tree is a ghost so return an empty tree.
407
return self.branch.repository.revision_tree(None)
410
self._flush_ignore_list_cache()
412
def relpath(self, path):
413
"""Return the local path portion from a given path.
415
The path may be absolute or relative. If its a relative path it is
416
interpreted relative to the python current working directory.
418
return osutils.relpath(self.basedir, path)
420
def has_filename(self, filename):
421
return osutils.lexists(self.abspath(filename))
423
def get_file(self, file_id, path=None):
425
path = self.id2path(file_id)
426
return self.get_file_byname(path)
428
def get_file_text(self, file_id):
429
return self.get_file(file_id).read()
431
def get_file_byname(self, filename):
432
return file(self.abspath(filename), 'rb')
435
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
436
"""See Tree.annotate_iter
438
This implementation will use the basis tree implementation if possible.
439
Lines not in the basis are attributed to CURRENT_REVISION
441
If there are pending merges, lines added by those merges will be
442
incorrectly attributed to CURRENT_REVISION (but after committing, the
443
attribution will be correct).
445
basis = self.basis_tree()
448
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
449
require_versioned=True).next()
450
changed_content, kind = changes[2], changes[6]
451
if not changed_content:
452
return basis.annotate_iter(file_id)
456
if kind[0] != 'file':
459
old_lines = list(basis.annotate_iter(file_id))
461
for tree in self.branch.repository.revision_trees(
462
self.get_parent_ids()[1:]):
463
if file_id not in tree:
465
old.append(list(tree.annotate_iter(file_id)))
466
return annotate.reannotate(old, self.get_file(file_id).readlines(),
471
def _get_ancestors(self, default_revision):
472
ancestors = set([default_revision])
473
for parent_id in self.get_parent_ids():
474
ancestors.update(self.branch.repository.get_ancestry(
475
parent_id, topo_sorted=False))
478
def get_parent_ids(self):
479
"""See Tree.get_parent_ids.
481
This implementation reads the pending merges list and last_revision
482
value and uses that to decide what the parents list should be.
484
last_rev = _mod_revision.ensure_null(self._last_revision())
485
if _mod_revision.NULL_REVISION == last_rev:
490
merges_file = self._transport.get('pending-merges')
491
except errors.NoSuchFile:
494
for l in merges_file.readlines():
495
revision_id = l.rstrip('\n')
496
parents.append(revision_id)
500
def get_root_id(self):
501
"""Return the id of this trees root"""
502
return self._inventory.root.file_id
504
def _get_store_filename(self, file_id):
505
## XXX: badly named; this is not in the store at all
506
return self.abspath(self.id2path(file_id))
509
def clone(self, to_bzrdir, revision_id=None):
510
"""Duplicate this working tree into to_bzr, including all state.
512
Specifically modified files are kept as modified, but
513
ignored and unknown files are discarded.
515
If you want to make a new line of development, see bzrdir.sprout()
518
If not None, the cloned tree will have its last revision set to
519
revision, and and difference between the source trees last revision
520
and this one merged in.
522
# assumes the target bzr dir format is compatible.
523
result = self._format.initialize(to_bzrdir)
524
self.copy_content_into(result, revision_id)
528
def copy_content_into(self, tree, revision_id=None):
529
"""Copy the current content and user files of this tree into tree."""
530
tree.set_root_id(self.get_root_id())
531
if revision_id is None:
532
merge.transform_tree(tree, self)
534
# TODO now merge from tree.last_revision to revision (to preserve
535
# user local changes)
536
merge.transform_tree(tree, self)
537
tree.set_parent_ids([revision_id])
539
def id2abspath(self, file_id):
540
return self.abspath(self.id2path(file_id))
542
def has_id(self, file_id):
543
# files that have been deleted are excluded
545
if not inv.has_id(file_id):
547
path = inv.id2path(file_id)
548
return osutils.lexists(self.abspath(path))
550
def has_or_had_id(self, file_id):
551
if file_id == self.inventory.root.file_id:
553
return self.inventory.has_id(file_id)
555
__contains__ = has_id
557
def get_file_size(self, file_id):
558
"""See Tree.get_file_size"""
560
return os.path.getsize(self.id2abspath(file_id))
562
if e.errno != errno.ENOENT:
568
def get_file_sha1(self, file_id, path=None, stat_value=None):
570
path = self._inventory.id2path(file_id)
571
return self._hashcache.get_sha1(path, stat_value)
573
def get_file_mtime(self, file_id, path=None):
575
path = self.inventory.id2path(file_id)
576
return os.lstat(self.abspath(path)).st_mtime
578
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
579
file_id = self.path2id(path)
580
return self._inventory[file_id].executable
582
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
583
mode = stat_result.st_mode
584
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
586
if not supports_executable():
587
def is_executable(self, file_id, path=None):
588
return self._inventory[file_id].executable
590
_is_executable_from_path_and_stat = \
591
_is_executable_from_path_and_stat_from_basis
593
def is_executable(self, file_id, path=None):
595
path = self.id2path(file_id)
596
mode = os.lstat(self.abspath(path)).st_mode
597
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
599
_is_executable_from_path_and_stat = \
600
_is_executable_from_path_and_stat_from_stat
602
@needs_tree_write_lock
603
def _add(self, files, ids, kinds):
604
"""See MutableTree._add."""
605
# TODO: Re-adding a file that is removed in the working copy
606
# should probably put it back with the previous ID.
607
# the read and write working inventory should not occur in this
608
# function - they should be part of lock_write and unlock.
610
for f, file_id, kind in zip(files, ids, kinds):
612
inv.add_path(f, kind=kind)
614
inv.add_path(f, kind=kind, file_id=file_id)
615
self._inventory_is_modified = True
617
@needs_tree_write_lock
618
def _gather_kinds(self, files, kinds):
619
"""See MutableTree._gather_kinds."""
620
for pos, f in enumerate(files):
621
if kinds[pos] is None:
622
fullpath = normpath(self.abspath(f))
624
kinds[pos] = file_kind(fullpath)
626
if e.errno == errno.ENOENT:
627
raise errors.NoSuchFile(fullpath)
630
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
631
"""Add revision_id as a parent.
633
This is equivalent to retrieving the current list of parent ids
634
and setting the list to its value plus revision_id.
636
:param revision_id: The revision id to add to the parent list. It may
637
be a ghost revision as long as its not the first parent to be added,
638
or the allow_leftmost_as_ghost parameter is set True.
639
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
641
parents = self.get_parent_ids() + [revision_id]
642
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
643
or allow_leftmost_as_ghost)
645
@needs_tree_write_lock
646
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
647
"""Add revision_id, tree tuple as a parent.
649
This is equivalent to retrieving the current list of parent trees
650
and setting the list to its value plus parent_tuple. See also
651
add_parent_tree_id - if you only have a parent id available it will be
652
simpler to use that api. If you have the parent already available, using
653
this api is preferred.
655
:param parent_tuple: The (revision id, tree) to add to the parent list.
656
If the revision_id is a ghost, pass None for the tree.
657
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
659
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
660
if len(parent_ids) > 1:
661
# the leftmost may have already been a ghost, preserve that if it
663
allow_leftmost_as_ghost = True
664
self.set_parent_ids(parent_ids,
665
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
667
@needs_tree_write_lock
668
def add_pending_merge(self, *revision_ids):
669
# TODO: Perhaps should check at this point that the
670
# history of the revision is actually present?
671
parents = self.get_parent_ids()
673
for rev_id in revision_ids:
674
if rev_id in parents:
676
parents.append(rev_id)
679
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
681
def path_content_summary(self, path, _lstat=os.lstat,
682
_mapper=osutils.file_kind_from_stat_mode):
683
"""See Tree.path_content_summary."""
684
abspath = self.abspath(path)
686
stat_result = _lstat(abspath)
688
if getattr(e, 'errno', None) == errno.ENOENT:
690
return ('missing', None, None, None)
691
# propagate other errors
693
kind = _mapper(stat_result.st_mode)
695
size = stat_result.st_size
696
# try for a stat cache lookup
697
executable = self._is_executable_from_path_and_stat(path, stat_result)
698
return (kind, size, executable, self._sha_from_stat(
700
elif kind == 'directory':
701
# perhaps it looks like a plain directory, but it's really a
703
if self._directory_is_tree_reference(path):
704
kind = 'tree-reference'
705
return kind, None, None, None
706
elif kind == 'symlink':
707
return ('symlink', None, None, os.readlink(abspath))
709
return (kind, None, None, None)
711
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
712
"""Common ghost checking functionality from set_parent_*.
714
This checks that the left hand-parent exists if there are any
717
if len(revision_ids) > 0:
718
leftmost_id = revision_ids[0]
719
if (not allow_leftmost_as_ghost and not
720
self.branch.repository.has_revision(leftmost_id)):
721
raise errors.GhostRevisionUnusableHere(leftmost_id)
723
def _set_merges_from_parent_ids(self, parent_ids):
724
merges = parent_ids[1:]
725
self._transport.put_bytes('pending-merges', '\n'.join(merges),
726
mode=self._control_files._file_mode)
728
def _filter_parent_ids_by_ancestry(self, revision_ids):
729
"""Check that all merged revisions are proper 'heads'.
731
This will always return the first revision_id, and any merged revisions
734
if len(revision_ids) == 0:
736
graph = self.branch.repository.get_graph()
737
heads = graph.heads(revision_ids)
738
new_revision_ids = revision_ids[:1]
739
for revision_id in revision_ids[1:]:
740
if revision_id in heads and revision_id not in new_revision_ids:
741
new_revision_ids.append(revision_id)
742
if new_revision_ids != revision_ids:
743
trace.mutter('requested to set revision_ids = %s,'
744
' but filtered to %s', revision_ids, new_revision_ids)
745
return new_revision_ids
747
@needs_tree_write_lock
748
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
749
"""Set the parent ids to revision_ids.
751
See also set_parent_trees. This api will try to retrieve the tree data
752
for each element of revision_ids from the trees repository. If you have
753
tree data already available, it is more efficient to use
754
set_parent_trees rather than set_parent_ids. set_parent_ids is however
755
an easier API to use.
757
:param revision_ids: The revision_ids to set as the parent ids of this
758
working tree. Any of these may be ghosts.
760
self._check_parents_for_ghosts(revision_ids,
761
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
762
for revision_id in revision_ids:
763
_mod_revision.check_not_reserved_id(revision_id)
765
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
767
if len(revision_ids) > 0:
768
self.set_last_revision(revision_ids[0])
770
self.set_last_revision(_mod_revision.NULL_REVISION)
772
self._set_merges_from_parent_ids(revision_ids)
774
@needs_tree_write_lock
775
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
776
"""See MutableTree.set_parent_trees."""
777
parent_ids = [rev for (rev, tree) in parents_list]
778
for revision_id in parent_ids:
779
_mod_revision.check_not_reserved_id(revision_id)
781
self._check_parents_for_ghosts(parent_ids,
782
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
784
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
786
if len(parent_ids) == 0:
787
leftmost_parent_id = _mod_revision.NULL_REVISION
788
leftmost_parent_tree = None
790
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
792
if self._change_last_revision(leftmost_parent_id):
793
if leftmost_parent_tree is None:
794
# If we don't have a tree, fall back to reading the
795
# parent tree from the repository.
796
self._cache_basis_inventory(leftmost_parent_id)
798
inv = leftmost_parent_tree.inventory
799
xml = self._create_basis_xml_from_inventory(
800
leftmost_parent_id, inv)
801
self._write_basis_inventory(xml)
802
self._set_merges_from_parent_ids(parent_ids)
804
@needs_tree_write_lock
805
def set_pending_merges(self, rev_list):
806
parents = self.get_parent_ids()
807
leftmost = parents[:1]
808
new_parents = leftmost + rev_list
809
self.set_parent_ids(new_parents)
811
@needs_tree_write_lock
812
def set_merge_modified(self, modified_hashes):
814
for file_id, hash in modified_hashes.iteritems():
815
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
816
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
818
def _sha_from_stat(self, path, stat_result):
819
"""Get a sha digest from the tree's stat cache.
821
The default implementation assumes no stat cache is present.
823
:param path: The path.
824
:param stat_result: The stat result being looked up.
828
def _put_rio(self, filename, stanzas, header):
829
self._must_be_locked()
830
my_file = rio_file(stanzas, header)
831
self._transport.put_file(filename, my_file,
832
mode=self._control_files._file_mode)
834
@needs_write_lock # because merge pulls data into the branch.
835
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
837
"""Merge from a branch into this working tree.
839
:param branch: The branch to merge from.
840
:param to_revision: If non-None, the merge will merge to to_revision,
841
but not beyond it. to_revision does not need to be in the history
842
of the branch when it is supplied. If None, to_revision defaults to
843
branch.last_revision().
845
from bzrlib.merge import Merger, Merge3Merger
846
pb = bzrlib.ui.ui_factory.nested_progress_bar()
848
merger = Merger(self.branch, this_tree=self, pb=pb)
849
merger.pp = ProgressPhase("Merge phase", 5, pb)
850
merger.pp.next_phase()
851
# check that there are no
853
merger.check_basis(check_clean=True, require_commits=False)
854
if to_revision is None:
855
to_revision = _mod_revision.ensure_null(branch.last_revision())
856
merger.other_rev_id = to_revision
857
if _mod_revision.is_null(merger.other_rev_id):
858
raise errors.NoCommits(branch)
859
self.branch.fetch(branch, last_revision=merger.other_rev_id)
860
merger.other_basis = merger.other_rev_id
861
merger.other_tree = self.branch.repository.revision_tree(
863
merger.other_branch = branch
864
merger.pp.next_phase()
865
if from_revision is None:
868
merger.set_base_revision(from_revision, branch)
869
if merger.base_rev_id == merger.other_rev_id:
870
raise errors.PointlessMerge
871
merger.backup_files = False
872
if merge_type is None:
873
merger.merge_type = Merge3Merger
875
merger.merge_type = merge_type
876
merger.set_interesting_files(None)
877
merger.show_base = False
878
merger.reprocess = False
879
conflicts = merger.do_merge()
886
def merge_modified(self):
887
"""Return a dictionary of files modified by a merge.
889
The list is initialized by WorkingTree.set_merge_modified, which is
890
typically called after we make some automatic updates to the tree
893
This returns a map of file_id->sha1, containing only files which are
894
still in the working inventory and have that text hash.
897
hashfile = self._transport.get('merge-hashes')
898
except errors.NoSuchFile:
902
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
903
raise errors.MergeModifiedFormatError()
904
except StopIteration:
905
raise errors.MergeModifiedFormatError()
906
for s in RioReader(hashfile):
907
# RioReader reads in Unicode, so convert file_ids back to utf8
908
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
909
if file_id not in self.inventory:
911
text_hash = s.get("hash")
912
if text_hash == self.get_file_sha1(file_id):
913
merge_hashes[file_id] = text_hash
917
def mkdir(self, path, file_id=None):
918
"""See MutableTree.mkdir()."""
920
file_id = generate_ids.gen_file_id(os.path.basename(path))
921
os.mkdir(self.abspath(path))
922
self.add(path, file_id, 'directory')
925
def get_symlink_target(self, file_id):
926
return os.readlink(self.id2abspath(file_id))
929
def subsume(self, other_tree):
930
def add_children(inventory, entry):
931
for child_entry in entry.children.values():
932
inventory._byid[child_entry.file_id] = child_entry
933
if child_entry.kind == 'directory':
934
add_children(inventory, child_entry)
935
if other_tree.get_root_id() == self.get_root_id():
936
raise errors.BadSubsumeSource(self, other_tree,
937
'Trees have the same root')
939
other_tree_path = self.relpath(other_tree.basedir)
940
except errors.PathNotChild:
941
raise errors.BadSubsumeSource(self, other_tree,
942
'Tree is not contained by the other')
943
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
944
if new_root_parent is None:
945
raise errors.BadSubsumeSource(self, other_tree,
946
'Parent directory is not versioned.')
947
# We need to ensure that the result of a fetch will have a
948
# versionedfile for the other_tree root, and only fetching into
949
# RepositoryKnit2 guarantees that.
950
if not self.branch.repository.supports_rich_root():
951
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
952
other_tree.lock_tree_write()
954
new_parents = other_tree.get_parent_ids()
955
other_root = other_tree.inventory.root
956
other_root.parent_id = new_root_parent
957
other_root.name = osutils.basename(other_tree_path)
958
self.inventory.add(other_root)
959
add_children(self.inventory, other_root)
960
self._write_inventory(self.inventory)
961
# normally we don't want to fetch whole repositories, but i think
962
# here we really do want to consolidate the whole thing.
963
for parent_id in other_tree.get_parent_ids():
964
self.branch.fetch(other_tree.branch, parent_id)
965
self.add_parent_tree_id(parent_id)
968
other_tree.bzrdir.retire_bzrdir()
970
def _setup_directory_is_tree_reference(self):
971
if self._branch.repository._format.supports_tree_reference:
972
self._directory_is_tree_reference = \
973
self._directory_may_be_tree_reference
975
self._directory_is_tree_reference = \
976
self._directory_is_never_tree_reference
978
def _directory_is_never_tree_reference(self, relpath):
981
def _directory_may_be_tree_reference(self, relpath):
982
# as a special case, if a directory contains control files then
983
# it's a tree reference, except that the root of the tree is not
984
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
985
# TODO: We could ask all the control formats whether they
986
# recognize this directory, but at the moment there's no cheap api
987
# to do that. Since we probably can only nest bzr checkouts and
988
# they always use this name it's ok for now. -- mbp 20060306
990
# FIXME: There is an unhandled case here of a subdirectory
991
# containing .bzr but not a branch; that will probably blow up
992
# when you try to commit it. It might happen if there is a
993
# checkout in a subdirectory. This can be avoided by not adding
996
@needs_tree_write_lock
997
def extract(self, file_id, format=None):
998
"""Extract a subtree from this tree.
1000
A new branch will be created, relative to the path for this tree.
1004
segments = osutils.splitpath(path)
1005
transport = self.branch.bzrdir.root_transport
1006
for name in segments:
1007
transport = transport.clone(name)
1008
transport.ensure_base()
1011
sub_path = self.id2path(file_id)
1012
branch_transport = mkdirs(sub_path)
1014
format = self.bzrdir.cloning_metadir()
1015
branch_transport.ensure_base()
1016
branch_bzrdir = format.initialize_on_transport(branch_transport)
1018
repo = branch_bzrdir.find_repository()
1019
except errors.NoRepositoryPresent:
1020
repo = branch_bzrdir.create_repository()
1021
if not repo.supports_rich_root():
1022
raise errors.RootNotRich()
1023
new_branch = branch_bzrdir.create_branch()
1024
new_branch.pull(self.branch)
1025
for parent_id in self.get_parent_ids():
1026
new_branch.fetch(self.branch, parent_id)
1027
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1028
if tree_transport.base != branch_transport.base:
1029
tree_bzrdir = format.initialize_on_transport(tree_transport)
1030
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1032
tree_bzrdir = branch_bzrdir
1033
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1034
wt.set_parent_ids(self.get_parent_ids())
1035
my_inv = self.inventory
1036
child_inv = Inventory(root_id=None)
1037
new_root = my_inv[file_id]
1038
my_inv.remove_recursive_id(file_id)
1039
new_root.parent_id = None
1040
child_inv.add(new_root)
1041
self._write_inventory(my_inv)
1042
wt._write_inventory(child_inv)
1045
def _serialize(self, inventory, out_file):
1046
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._transport.put_file('inventory', sio,
1061
mode=self._control_files._file_mode)
1062
self._inventory_is_modified = False
1064
def _kind(self, relpath):
1065
return osutils.file_kind(self.abspath(relpath))
1067
def list_files(self, include_root=False):
1068
"""Recursively list all files as (path, class, kind, id, entry).
1070
Lists, but does not descend into unversioned directories.
1072
This does not include files that have been deleted in this
1075
Skips the control directory.
1077
# list_files is an iterator, so @needs_read_lock doesn't work properly
1078
# with it. So callers should be careful to always read_lock the tree.
1079
if not self.is_locked():
1080
raise errors.ObjectNotLocked(self)
1082
inv = self.inventory
1083
if include_root is True:
1084
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1085
# Convert these into local objects to save lookup times
1086
pathjoin = osutils.pathjoin
1087
file_kind = self._kind
1089
# transport.base ends in a slash, we want the piece
1090
# between the last two slashes
1091
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1093
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1095
# directory file_id, relative path, absolute path, reverse sorted children
1096
children = os.listdir(self.basedir)
1098
# jam 20060527 The kernel sized tree seems equivalent whether we
1099
# use a deque and popleft to keep them sorted, or if we use a plain
1100
# list and just reverse() them.
1101
children = collections.deque(children)
1102
stack = [(inv.root.file_id, u'', self.basedir, children)]
1104
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1107
f = children.popleft()
1108
## TODO: If we find a subdirectory with its own .bzr
1109
## directory, then that is a separate tree and we
1110
## should exclude it.
1112
# the bzrdir for this tree
1113
if transport_base_dir == f:
1116
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1117
# and 'f' doesn't begin with one, we can do a string op, rather
1118
# than the checks of pathjoin(), all relative paths will have an extra slash
1120
fp = from_dir_relpath + '/' + f
1123
fap = from_dir_abspath + '/' + f
1125
f_ie = inv.get_child(from_dir_id, f)
1128
elif self.is_ignored(fp[1:]):
1131
# we may not have found this file, because of a unicode issue
1132
f_norm, can_access = osutils.normalized_filename(f)
1133
if f == f_norm or not can_access:
1134
# No change, so treat this file normally
1137
# this file can be accessed by a normalized path
1138
# check again if it is versioned
1139
# these lines are repeated here for performance
1141
fp = from_dir_relpath + '/' + f
1142
fap = from_dir_abspath + '/' + f
1143
f_ie = inv.get_child(from_dir_id, f)
1146
elif self.is_ignored(fp[1:]):
1153
# make a last minute entry
1155
yield fp[1:], c, fk, f_ie.file_id, f_ie
1158
yield fp[1:], c, fk, None, fk_entries[fk]()
1160
yield fp[1:], c, fk, None, TreeEntry()
1163
if fk != 'directory':
1166
# But do this child first
1167
new_children = os.listdir(fap)
1169
new_children = collections.deque(new_children)
1170
stack.append((f_ie.file_id, fp, fap, new_children))
1171
# Break out of inner loop,
1172
# so that we start outer loop with child
1175
# if we finished all children, pop it off the stack
1178
@needs_tree_write_lock
1179
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1182
to_dir must exist in the inventory.
1184
If to_dir exists and is a directory, the files are moved into
1185
it, keeping their old names.
1187
Note that to_dir is only the last component of the new name;
1188
this doesn't change the directory.
1190
For each entry in from_paths the move mode will be determined
1193
The first mode moves the file in the filesystem and updates the
1194
inventory. The second mode only updates the inventory without
1195
touching the file on the filesystem. This is the new mode introduced
1198
move uses the second mode if 'after == True' and the target is not
1199
versioned but present in the working tree.
1201
move uses the second mode if 'after == False' and the source is
1202
versioned but no longer in the working tree, and the target is not
1203
versioned but present in the working tree.
1205
move uses the first mode if 'after == False' and the source is
1206
versioned and present in the working tree, and the target is not
1207
versioned and not present in the working tree.
1209
Everything else results in an error.
1211
This returns a list of (from_path, to_path) pairs for each
1212
entry that is moved.
1217
# check for deprecated use of signature
1219
to_dir = kwargs.get('to_name', None)
1221
raise TypeError('You must supply a target directory')
1223
symbol_versioning.warn('The parameter to_name was deprecated'
1224
' in version 0.13. Use to_dir instead',
1227
# check destination directory
1228
if isinstance(from_paths, basestring):
1230
inv = self.inventory
1231
to_abs = self.abspath(to_dir)
1232
if not isdir(to_abs):
1233
raise errors.BzrMoveFailedError('',to_dir,
1234
errors.NotADirectory(to_abs))
1235
if not self.has_filename(to_dir):
1236
raise errors.BzrMoveFailedError('',to_dir,
1237
errors.NotInWorkingDirectory(to_dir))
1238
to_dir_id = inv.path2id(to_dir)
1239
if to_dir_id is None:
1240
raise errors.BzrMoveFailedError('',to_dir,
1241
errors.NotVersionedError(path=str(to_dir)))
1243
to_dir_ie = inv[to_dir_id]
1244
if to_dir_ie.kind != 'directory':
1245
raise errors.BzrMoveFailedError('',to_dir,
1246
errors.NotADirectory(to_abs))
1248
# create rename entries and tuples
1249
for from_rel in from_paths:
1250
from_tail = splitpath(from_rel)[-1]
1251
from_id = inv.path2id(from_rel)
1253
raise errors.BzrMoveFailedError(from_rel,to_dir,
1254
errors.NotVersionedError(path=str(from_rel)))
1256
from_entry = inv[from_id]
1257
from_parent_id = from_entry.parent_id
1258
to_rel = pathjoin(to_dir, from_tail)
1259
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1261
from_tail=from_tail,
1262
from_parent_id=from_parent_id,
1263
to_rel=to_rel, to_tail=from_tail,
1264
to_parent_id=to_dir_id)
1265
rename_entries.append(rename_entry)
1266
rename_tuples.append((from_rel, to_rel))
1268
# determine which move mode to use. checks also for movability
1269
rename_entries = self._determine_mv_mode(rename_entries, after)
1271
original_modified = self._inventory_is_modified
1274
self._inventory_is_modified = True
1275
self._move(rename_entries)
1277
# restore the inventory on error
1278
self._inventory_is_modified = original_modified
1280
self._write_inventory(inv)
1281
return rename_tuples
1283
def _determine_mv_mode(self, rename_entries, after=False):
1284
"""Determines for each from-to pair if both inventory and working tree
1285
or only the inventory has to be changed.
1287
Also does basic plausability tests.
1289
inv = self.inventory
1291
for rename_entry in rename_entries:
1292
# store to local variables for easier reference
1293
from_rel = rename_entry.from_rel
1294
from_id = rename_entry.from_id
1295
to_rel = rename_entry.to_rel
1296
to_id = inv.path2id(to_rel)
1297
only_change_inv = False
1299
# check the inventory for source and destination
1301
raise errors.BzrMoveFailedError(from_rel,to_rel,
1302
errors.NotVersionedError(path=str(from_rel)))
1303
if to_id is not None:
1304
raise errors.BzrMoveFailedError(from_rel,to_rel,
1305
errors.AlreadyVersionedError(path=str(to_rel)))
1307
# try to determine the mode for rename (only change inv or change
1308
# inv and file system)
1310
if not self.has_filename(to_rel):
1311
raise errors.BzrMoveFailedError(from_id,to_rel,
1312
errors.NoSuchFile(path=str(to_rel),
1313
extra="New file has not been created yet"))
1314
only_change_inv = True
1315
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1316
only_change_inv = True
1317
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1318
only_change_inv = False
1319
elif (sys.platform == 'win32'
1320
and from_rel.lower() == to_rel.lower()
1321
and self.has_filename(from_rel)):
1322
only_change_inv = False
1324
# something is wrong, so lets determine what exactly
1325
if not self.has_filename(from_rel) and \
1326
not self.has_filename(to_rel):
1327
raise errors.BzrRenameFailedError(from_rel,to_rel,
1328
errors.PathsDoNotExist(paths=(str(from_rel),
1331
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1332
rename_entry.only_change_inv = only_change_inv
1333
return rename_entries
1335
def _move(self, rename_entries):
1336
"""Moves a list of files.
1338
Depending on the value of the flag 'only_change_inv', the
1339
file will be moved on the file system or not.
1341
inv = self.inventory
1344
for entry in rename_entries:
1346
self._move_entry(entry)
1348
self._rollback_move(moved)
1352
def _rollback_move(self, moved):
1353
"""Try to rollback a previous move in case of an filesystem error."""
1354
inv = self.inventory
1357
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1358
entry.to_tail, entry.to_parent_id, entry.from_rel,
1359
entry.from_tail, entry.from_parent_id,
1360
entry.only_change_inv))
1361
except errors.BzrMoveFailedError, e:
1362
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1363
" The working tree is in an inconsistent state."
1364
" Please consider doing a 'bzr revert'."
1365
" Error message is: %s" % e)
1367
def _move_entry(self, entry):
1368
inv = self.inventory
1369
from_rel_abs = self.abspath(entry.from_rel)
1370
to_rel_abs = self.abspath(entry.to_rel)
1371
if from_rel_abs == to_rel_abs:
1372
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1373
"Source and target are identical.")
1375
if not entry.only_change_inv:
1377
osutils.rename(from_rel_abs, to_rel_abs)
1379
raise errors.BzrMoveFailedError(entry.from_rel,
1381
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1383
@needs_tree_write_lock
1384
def rename_one(self, from_rel, to_rel, after=False):
1387
This can change the directory or the filename or both.
1389
rename_one has several 'modes' to work. First, it can rename a physical
1390
file and change the file_id. That is the normal mode. Second, it can
1391
only change the file_id without touching any physical file. This is
1392
the new mode introduced in version 0.15.
1394
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1395
versioned but present in the working tree.
1397
rename_one uses the second mode if 'after == False' and 'from_rel' is
1398
versioned but no longer in the working tree, and 'to_rel' is not
1399
versioned but present in the working tree.
1401
rename_one uses the first mode if 'after == False' and 'from_rel' is
1402
versioned and present in the working tree, and 'to_rel' is not
1403
versioned and not present in the working tree.
1405
Everything else results in an error.
1407
inv = self.inventory
1410
# create rename entries and tuples
1411
from_tail = splitpath(from_rel)[-1]
1412
from_id = inv.path2id(from_rel)
1414
raise errors.BzrRenameFailedError(from_rel,to_rel,
1415
errors.NotVersionedError(path=str(from_rel)))
1416
from_entry = inv[from_id]
1417
from_parent_id = from_entry.parent_id
1418
to_dir, to_tail = os.path.split(to_rel)
1419
to_dir_id = inv.path2id(to_dir)
1420
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1422
from_tail=from_tail,
1423
from_parent_id=from_parent_id,
1424
to_rel=to_rel, to_tail=to_tail,
1425
to_parent_id=to_dir_id)
1426
rename_entries.append(rename_entry)
1428
# determine which move mode to use. checks also for movability
1429
rename_entries = self._determine_mv_mode(rename_entries, after)
1431
# check if the target changed directory and if the target directory is
1433
if to_dir_id is None:
1434
raise errors.BzrMoveFailedError(from_rel,to_rel,
1435
errors.NotVersionedError(path=str(to_dir)))
1437
# all checks done. now we can continue with our actual work
1438
mutter('rename_one:\n'
1443
' to_dir_id {%s}\n',
1444
from_id, from_rel, to_rel, to_dir, to_dir_id)
1446
self._move(rename_entries)
1447
self._write_inventory(inv)
1449
class _RenameEntry(object):
1450
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1451
to_rel, to_tail, to_parent_id, only_change_inv=False):
1452
self.from_rel = from_rel
1453
self.from_id = from_id
1454
self.from_tail = from_tail
1455
self.from_parent_id = from_parent_id
1456
self.to_rel = to_rel
1457
self.to_tail = to_tail
1458
self.to_parent_id = to_parent_id
1459
self.only_change_inv = only_change_inv
1463
"""Return all unknown files.
1465
These are files in the working directory that are not versioned or
1466
control files or ignored.
1468
# force the extras method to be fully executed before returning, to
1469
# prevent race conditions with the lock
1471
[subp for subp in self.extras() if not self.is_ignored(subp)])
1473
@needs_tree_write_lock
1474
def unversion(self, file_ids):
1475
"""Remove the file ids in file_ids from the current versioned set.
1477
When a file_id is unversioned, all of its children are automatically
1480
:param file_ids: The file ids to stop versioning.
1481
:raises: NoSuchId if any fileid is not currently versioned.
1483
for file_id in file_ids:
1484
if self._inventory.has_id(file_id):
1485
self._inventory.remove_recursive_id(file_id)
1487
raise errors.NoSuchId(self, file_id)
1489
# in the future this should just set a dirty bit to wait for the
1490
# final unlock. However, until all methods of workingtree start
1491
# with the current in -memory inventory rather than triggering
1492
# a read, it is more complex - we need to teach read_inventory
1493
# to know when to read, and when to not read first... and possibly
1494
# to save first when the in memory one may be corrupted.
1495
# so for now, we just only write it if it is indeed dirty.
1497
self._write_inventory(self._inventory)
1499
def _iter_conflicts(self):
1501
for info in self.list_files():
1503
stem = get_conflicted_stem(path)
1506
if stem not in conflicted:
1507
conflicted.add(stem)
1511
def pull(self, source, overwrite=False, stop_revision=None,
1512
change_reporter=None, possible_transports=None):
1513
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1516
pp = ProgressPhase("Pull phase", 2, top_pb)
1518
old_revision_info = self.branch.last_revision_info()
1519
basis_tree = self.basis_tree()
1520
count = self.branch.pull(source, overwrite, stop_revision,
1521
possible_transports=possible_transports)
1522
new_revision_info = self.branch.last_revision_info()
1523
if new_revision_info != old_revision_info:
1525
repository = self.branch.repository
1526
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1527
basis_tree.lock_read()
1529
new_basis_tree = self.branch.basis_tree()
1536
change_reporter=change_reporter)
1537
if (basis_tree.inventory.root is None and
1538
new_basis_tree.inventory.root is not None):
1539
self.set_root_id(new_basis_tree.get_root_id())
1543
# TODO - dedup parents list with things merged by pull ?
1544
# reuse the revisiontree we merged against to set the new
1546
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1547
# we have to pull the merge trees out again, because
1548
# merge_inner has set the ids. - this corner is not yet
1549
# layered well enough to prevent double handling.
1550
# XXX TODO: Fix the double handling: telling the tree about
1551
# the already known parent data is wasteful.
1552
merges = self.get_parent_ids()[1:]
1553
parent_trees.extend([
1554
(parent, repository.revision_tree(parent)) for
1556
self.set_parent_trees(parent_trees)
1563
def put_file_bytes_non_atomic(self, file_id, bytes):
1564
"""See MutableTree.put_file_bytes_non_atomic."""
1565
stream = file(self.id2abspath(file_id), 'wb')
1570
# TODO: update the hashcache here ?
1573
"""Yield all unversioned files in this WorkingTree.
1575
If there are any unversioned directories then only the directory is
1576
returned, not all its children. But if there are unversioned files
1577
under a versioned subdirectory, they are returned.
1579
Currently returned depth-first, sorted by name within directories.
1580
This is the same order used by 'osutils.walkdirs'.
1582
## TODO: Work from given directory downwards
1583
for path, dir_entry in self.inventory.directories():
1584
# mutter("search for unknowns in %r", path)
1585
dirabs = self.abspath(path)
1586
if not isdir(dirabs):
1587
# e.g. directory deleted
1591
for subf in os.listdir(dirabs):
1594
if subf not in dir_entry.children:
1595
subf_norm, can_access = osutils.normalized_filename(subf)
1596
if subf_norm != subf and can_access:
1597
if subf_norm not in dir_entry.children:
1598
fl.append(subf_norm)
1604
subp = pathjoin(path, subf)
1607
def ignored_files(self):
1608
"""Yield list of PATH, IGNORE_PATTERN"""
1609
for subp in self.extras():
1610
pat = self.is_ignored(subp)
1614
def get_ignore_list(self):
1615
"""Return list of ignore patterns.
1617
Cached in the Tree object after the first call.
1619
ignoreset = getattr(self, '_ignoreset', None)
1620
if ignoreset is not None:
1623
ignore_globs = set()
1624
ignore_globs.update(ignores.get_runtime_ignores())
1625
ignore_globs.update(ignores.get_user_ignores())
1626
if self.has_filename(bzrlib.IGNORE_FILENAME):
1627
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1629
ignore_globs.update(ignores.parse_ignore_file(f))
1632
self._ignoreset = ignore_globs
1635
def _flush_ignore_list_cache(self):
1636
"""Resets the cached ignore list to force a cache rebuild."""
1637
self._ignoreset = None
1638
self._ignoreglobster = None
1640
def is_ignored(self, filename):
1641
r"""Check whether the filename matches an ignore pattern.
1643
Patterns containing '/' or '\' need to match the whole path;
1644
others match against only the last component.
1646
If the file is ignored, returns the pattern which caused it to
1647
be ignored, otherwise None. So this can simply be used as a
1648
boolean if desired."""
1649
if getattr(self, '_ignoreglobster', None) is None:
1650
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1651
return self._ignoreglobster.match(filename)
1653
def kind(self, file_id):
1654
return file_kind(self.id2abspath(file_id))
1656
def stored_kind(self, file_id):
1657
"""See Tree.stored_kind"""
1658
return self.inventory[file_id].kind
1660
def _comparison_data(self, entry, path):
1661
abspath = self.abspath(path)
1663
stat_value = os.lstat(abspath)
1665
if getattr(e, 'errno', None) == errno.ENOENT:
1672
mode = stat_value.st_mode
1673
kind = osutils.file_kind_from_stat_mode(mode)
1674
if not supports_executable():
1675
executable = entry is not None and entry.executable
1677
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1678
return kind, executable, stat_value
1680
def _file_size(self, entry, stat_value):
1681
return stat_value.st_size
1683
def last_revision(self):
1684
"""Return the last revision of the branch for this tree.
1686
This format tree does not support a separate marker for last-revision
1687
compared to the branch.
1689
See MutableTree.last_revision
1691
return self._last_revision()
1694
def _last_revision(self):
1695
"""helper for get_parent_ids."""
1696
return _mod_revision.ensure_null(self.branch.last_revision())
1698
def is_locked(self):
1699
return self._control_files.is_locked()
1701
def _must_be_locked(self):
1702
if not self.is_locked():
1703
raise errors.ObjectNotLocked(self)
1705
def lock_read(self):
1706
"""See Branch.lock_read, and WorkingTree.unlock."""
1707
if not self.is_locked():
1709
self.branch.lock_read()
1711
return self._control_files.lock_read()
1713
self.branch.unlock()
1716
def lock_tree_write(self):
1717
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1718
if not self.is_locked():
1720
self.branch.lock_read()
1722
return self._control_files.lock_write()
1724
self.branch.unlock()
1727
def lock_write(self):
1728
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1729
if not self.is_locked():
1731
self.branch.lock_write()
1733
return self._control_files.lock_write()
1735
self.branch.unlock()
1738
def get_physical_lock_status(self):
1739
return self._control_files.get_physical_lock_status()
1741
def _basis_inventory_name(self):
1742
return 'basis-inventory-cache'
1744
def _reset_data(self):
1745
"""Reset transient data that cannot be revalidated."""
1746
self._inventory_is_modified = False
1747
result = self._deserialize(self._transport.get('inventory'))
1748
self._set_inventory(result, dirty=False)
1750
@needs_tree_write_lock
1751
def set_last_revision(self, new_revision):
1752
"""Change the last revision in the working tree."""
1753
if self._change_last_revision(new_revision):
1754
self._cache_basis_inventory(new_revision)
1756
def _change_last_revision(self, new_revision):
1757
"""Template method part of set_last_revision to perform the change.
1759
This is used to allow WorkingTree3 instances to not affect branch
1760
when their last revision is set.
1762
if _mod_revision.is_null(new_revision):
1763
self.branch.set_revision_history([])
1766
self.branch.generate_revision_history(new_revision)
1767
except errors.NoSuchRevision:
1768
# not present in the repo - dont try to set it deeper than the tip
1769
self.branch.set_revision_history([new_revision])
1772
def _write_basis_inventory(self, xml):
1773
"""Write the basis inventory XML to the basis-inventory file"""
1774
path = self._basis_inventory_name()
1776
self._transport.put_file(path, sio,
1777
mode=self._control_files._file_mode)
1779
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1780
"""Create the text that will be saved in basis-inventory"""
1781
inventory.revision_id = revision_id
1782
return xml7.serializer_v7.write_inventory_to_string(inventory)
1784
def _cache_basis_inventory(self, new_revision):
1785
"""Cache new_revision as the basis inventory."""
1786
# TODO: this should allow the ready-to-use inventory to be passed in,
1787
# as commit already has that ready-to-use [while the format is the
1790
# this double handles the inventory - unpack and repack -
1791
# but is easier to understand. We can/should put a conditional
1792
# in here based on whether the inventory is in the latest format
1793
# - perhaps we should repack all inventories on a repository
1795
# the fast path is to copy the raw xml from the repository. If the
1796
# xml contains 'revision_id="', then we assume the right
1797
# revision_id is set. We must check for this full string, because a
1798
# root node id can legitimately look like 'revision_id' but cannot
1800
xml = self.branch.repository.get_inventory_xml(new_revision)
1801
firstline = xml.split('\n', 1)[0]
1802
if (not 'revision_id="' in firstline or
1803
'format="7"' not in firstline):
1804
inv = self.branch.repository.deserialise_inventory(
1806
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1807
self._write_basis_inventory(xml)
1808
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1811
def read_basis_inventory(self):
1812
"""Read the cached basis inventory."""
1813
path = self._basis_inventory_name()
1814
return self._transport.get_bytes(path)
1817
def read_working_inventory(self):
1818
"""Read the working inventory.
1820
:raises errors.InventoryModified: read_working_inventory will fail
1821
when the current in memory inventory has been modified.
1823
# conceptually this should be an implementation detail of the tree.
1824
# XXX: Deprecate this.
1825
# ElementTree does its own conversion from UTF-8, so open in
1827
if self._inventory_is_modified:
1828
raise errors.InventoryModified(self)
1829
result = self._deserialize(self._transport.get('inventory'))
1830
self._set_inventory(result, dirty=False)
1833
@needs_tree_write_lock
1834
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1836
"""Remove nominated files from the working inventory.
1838
:files: File paths relative to the basedir.
1839
:keep_files: If true, the files will also be kept.
1840
:force: Delete files and directories, even if they are changed and
1841
even if the directories are not empty.
1843
if isinstance(files, basestring):
1849
unknown_nested_files=set()
1851
def recurse_directory_to_add_files(directory):
1852
# Recurse directory and add all files
1853
# so we can check if they have changed.
1854
for parent_info, file_infos in\
1855
osutils.walkdirs(self.abspath(directory),
1857
for relpath, basename, kind, lstat, abspath in file_infos:
1858
# Is it versioned or ignored?
1859
if self.path2id(relpath) or self.is_ignored(relpath):
1860
# Add nested content for deletion.
1861
new_files.add(relpath)
1863
# Files which are not versioned and not ignored
1864
# should be treated as unknown.
1865
unknown_nested_files.add((relpath, None, kind))
1867
for filename in files:
1868
# Get file name into canonical form.
1869
abspath = self.abspath(filename)
1870
filename = self.relpath(abspath)
1871
if len(filename) > 0:
1872
new_files.add(filename)
1873
if osutils.isdir(abspath):
1874
recurse_directory_to_add_files(filename)
1876
files = list(new_files)
1879
return # nothing to do
1881
# Sort needed to first handle directory content before the directory
1882
files.sort(reverse=True)
1884
# Bail out if we are going to delete files we shouldn't
1885
if not keep_files and not force:
1886
has_changed_files = len(unknown_nested_files) > 0
1887
if not has_changed_files:
1888
for (file_id, path, content_change, versioned, parent_id, name,
1889
kind, executable) in self.iter_changes(self.basis_tree(),
1890
include_unchanged=True, require_versioned=False,
1891
want_unversioned=True, specific_files=files):
1892
if versioned == (False, False):
1893
# The record is unknown ...
1894
if not self.is_ignored(path[1]):
1895
# ... but not ignored
1896
has_changed_files = True
1898
elif content_change and (kind[1] is not None):
1899
# Versioned and changed, but not deleted
1900
has_changed_files = True
1903
if has_changed_files:
1904
# Make delta show ALL applicable changes in error message.
1905
tree_delta = self.changes_from(self.basis_tree(),
1906
require_versioned=False, want_unversioned=True,
1907
specific_files=files)
1908
for unknown_file in unknown_nested_files:
1909
if unknown_file not in tree_delta.unversioned:
1910
tree_delta.unversioned.extend((unknown_file,))
1911
raise errors.BzrRemoveChangedFilesError(tree_delta)
1913
# Build inv_delta and delete files where applicaple,
1914
# do this before any modifications to inventory.
1916
fid = self.path2id(f)
1919
message = "%s is not versioned." % (f,)
1922
# having removed it, it must be either ignored or unknown
1923
if self.is_ignored(f):
1927
textui.show_status(new_status, self.kind(fid), f,
1930
inv_delta.append((f, None, fid, None))
1931
message = "removed %s" % (f,)
1934
abs_path = self.abspath(f)
1935
if osutils.lexists(abs_path):
1936
if (osutils.isdir(abs_path) and
1937
len(os.listdir(abs_path)) > 0):
1939
osutils.rmtree(abs_path)
1941
message = "%s is not an empty directory "\
1942
"and won't be deleted." % (f,)
1944
osutils.delete_any(abs_path)
1945
message = "deleted %s" % (f,)
1946
elif message is not None:
1947
# Only care if we haven't done anything yet.
1948
message = "%s does not exist." % (f,)
1950
# Print only one message (if any) per file.
1951
if message is not None:
1953
self.apply_inventory_delta(inv_delta)
1955
@needs_tree_write_lock
1956
def revert(self, filenames=None, old_tree=None, backups=True,
1957
pb=DummyProgress(), report_changes=False):
1958
from bzrlib.conflicts import resolve
1961
symbol_versioning.warn('Using [] to revert all files is deprecated'
1962
' as of bzr 0.91. Please use None (the default) instead.',
1963
DeprecationWarning, stacklevel=2)
1964
if old_tree is None:
1965
basis_tree = self.basis_tree()
1966
basis_tree.lock_read()
1967
old_tree = basis_tree
1971
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1973
if filenames is None and len(self.get_parent_ids()) > 1:
1975
last_revision = self.last_revision()
1976
if last_revision != NULL_REVISION:
1977
if basis_tree is None:
1978
basis_tree = self.basis_tree()
1979
basis_tree.lock_read()
1980
parent_trees.append((last_revision, basis_tree))
1981
self.set_parent_trees(parent_trees)
1984
resolve(self, filenames, ignore_misses=True, recursive=True)
1986
if basis_tree is not None:
1990
def revision_tree(self, revision_id):
1991
"""See Tree.revision_tree.
1993
WorkingTree can supply revision_trees for the basis revision only
1994
because there is only one cached inventory in the bzr directory.
1996
if revision_id == self.last_revision():
1998
xml = self.read_basis_inventory()
1999
except errors.NoSuchFile:
2003
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2004
# dont use the repository revision_tree api because we want
2005
# to supply the inventory.
2006
if inv.revision_id == revision_id:
2007
return revisiontree.RevisionTree(self.branch.repository,
2009
except errors.BadInventoryFormat:
2011
# raise if there was no inventory, or if we read the wrong inventory.
2012
raise errors.NoSuchRevisionInTree(self, revision_id)
2014
# XXX: This method should be deprecated in favour of taking in a proper
2015
# new Inventory object.
2016
@needs_tree_write_lock
2017
def set_inventory(self, new_inventory_list):
2018
from bzrlib.inventory import (Inventory,
2023
inv = Inventory(self.get_root_id())
2024
for path, file_id, parent, kind in new_inventory_list:
2025
name = os.path.basename(path)
2028
# fixme, there should be a factory function inv,add_??
2029
if kind == 'directory':
2030
inv.add(InventoryDirectory(file_id, name, parent))
2031
elif kind == 'file':
2032
inv.add(InventoryFile(file_id, name, parent))
2033
elif kind == 'symlink':
2034
inv.add(InventoryLink(file_id, name, parent))
2036
raise errors.BzrError("unknown kind %r" % kind)
2037
self._write_inventory(inv)
2039
@needs_tree_write_lock
2040
def set_root_id(self, file_id):
2041
"""Set the root id for this tree."""
2045
'WorkingTree.set_root_id with fileid=None')
2046
file_id = osutils.safe_file_id(file_id)
2047
self._set_root_id(file_id)
2049
def _set_root_id(self, file_id):
2050
"""Set the root id for this tree, in a format specific manner.
2052
:param file_id: The file id to assign to the root. It must not be
2053
present in the current inventory or an error will occur. It must
2054
not be None, but rather a valid file id.
2056
inv = self._inventory
2057
orig_root_id = inv.root.file_id
2058
# TODO: it might be nice to exit early if there was nothing
2059
# to do, saving us from trigger a sync on unlock.
2060
self._inventory_is_modified = True
2061
# we preserve the root inventory entry object, but
2062
# unlinkit from the byid index
2063
del inv._byid[inv.root.file_id]
2064
inv.root.file_id = file_id
2065
# and link it into the index with the new changed id.
2066
inv._byid[inv.root.file_id] = inv.root
2067
# and finally update all children to reference the new id.
2068
# XXX: this should be safe to just look at the root.children
2069
# list, not the WHOLE INVENTORY.
2072
if entry.parent_id == orig_root_id:
2073
entry.parent_id = inv.root.file_id
2076
"""See Branch.unlock.
2078
WorkingTree locking just uses the Branch locking facilities.
2079
This is current because all working trees have an embedded branch
2080
within them. IF in the future, we were to make branch data shareable
2081
between multiple working trees, i.e. via shared storage, then we
2082
would probably want to lock both the local tree, and the branch.
2084
raise NotImplementedError(self.unlock)
2086
def update(self, change_reporter=None, possible_transports=None):
2087
"""Update a working tree along its branch.
2089
This will update the branch if its bound too, which means we have
2090
multiple trees involved:
2092
- The new basis tree of the master.
2093
- The old basis tree of the branch.
2094
- The old basis tree of the working tree.
2095
- The current working tree state.
2097
Pathologically, all three may be different, and non-ancestors of each
2098
other. Conceptually we want to:
2100
- Preserve the wt.basis->wt.state changes
2101
- Transform the wt.basis to the new master basis.
2102
- Apply a merge of the old branch basis to get any 'local' changes from
2104
- Restore the wt.basis->wt.state changes.
2106
There isn't a single operation at the moment to do that, so we:
2107
- Merge current state -> basis tree of the master w.r.t. the old tree
2109
- Do a 'normal' merge of the old branch basis if it is relevant.
2111
if self.branch.get_bound_location() is not None:
2113
update_branch = True
2115
self.lock_tree_write()
2116
update_branch = False
2119
old_tip = self.branch.update(possible_transports)
2122
return self._update_tree(old_tip, change_reporter)
2126
@needs_tree_write_lock
2127
def _update_tree(self, old_tip=None, change_reporter=None):
2128
"""Update a tree to the master branch.
2130
:param old_tip: if supplied, the previous tip revision the branch,
2131
before it was changed to the master branch's tip.
2133
# here if old_tip is not None, it is the old tip of the branch before
2134
# it was updated from the master branch. This should become a pending
2135
# merge in the working tree to preserve the user existing work. we
2136
# cant set that until we update the working trees last revision to be
2137
# one from the new branch, because it will just get absorbed by the
2138
# parent de-duplication logic.
2140
# We MUST save it even if an error occurs, because otherwise the users
2141
# local work is unreferenced and will appear to have been lost.
2145
last_rev = self.get_parent_ids()[0]
2147
last_rev = _mod_revision.NULL_REVISION
2148
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2149
# merge tree state up to new branch tip.
2150
basis = self.basis_tree()
2153
to_tree = self.branch.basis_tree()
2154
if basis.inventory.root is None:
2155
self.set_root_id(to_tree.get_root_id())
2157
result += merge.merge_inner(
2162
change_reporter=change_reporter)
2165
# TODO - dedup parents list with things merged by pull ?
2166
# reuse the tree we've updated to to set the basis:
2167
parent_trees = [(self.branch.last_revision(), to_tree)]
2168
merges = self.get_parent_ids()[1:]
2169
# Ideally we ask the tree for the trees here, that way the working
2170
# tree can decide whether to give us teh entire tree or give us a
2171
# lazy initialised tree. dirstate for instance will have the trees
2172
# in ram already, whereas a last-revision + basis-inventory tree
2173
# will not, but also does not need them when setting parents.
2174
for parent in merges:
2175
parent_trees.append(
2176
(parent, self.branch.repository.revision_tree(parent)))
2177
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2178
parent_trees.append(
2179
(old_tip, self.branch.repository.revision_tree(old_tip)))
2180
self.set_parent_trees(parent_trees)
2181
last_rev = parent_trees[0][0]
2183
# the working tree had the same last-revision as the master
2184
# branch did. We may still have pivot local work from the local
2185
# branch into old_tip:
2186
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2187
self.add_parent_tree_id(old_tip)
2188
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2189
and old_tip != last_rev):
2190
# our last revision was not the prior branch last revision
2191
# and we have converted that last revision to a pending merge.
2192
# base is somewhere between the branch tip now
2193
# and the now pending merge
2195
# Since we just modified the working tree and inventory, flush out
2196
# the current state, before we modify it again.
2197
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2198
# requires it only because TreeTransform directly munges the
2199
# inventory and calls tree._write_inventory(). Ultimately we
2200
# should be able to remove this extra flush.
2202
graph = self.branch.repository.get_graph()
2203
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2205
base_tree = self.branch.repository.revision_tree(base_rev_id)
2206
other_tree = self.branch.repository.revision_tree(old_tip)
2207
result += merge.merge_inner(
2212
change_reporter=change_reporter)
2215
def _write_hashcache_if_dirty(self):
2216
"""Write out the hashcache if it is dirty."""
2217
if self._hashcache.needs_write:
2219
self._hashcache.write()
2221
if e.errno not in (errno.EPERM, errno.EACCES):
2223
# TODO: jam 20061219 Should this be a warning? A single line
2224
# warning might be sufficient to let the user know what
2226
mutter('Could not write hashcache for %s\nError: %s',
2227
self._hashcache.cache_file_name(), e)
2229
@needs_tree_write_lock
2230
def _write_inventory(self, inv):
2231
"""Write inventory as the current inventory."""
2232
self._set_inventory(inv, dirty=True)
2235
def set_conflicts(self, arg):
2236
raise errors.UnsupportedOperation(self.set_conflicts, self)
2238
def add_conflicts(self, arg):
2239
raise errors.UnsupportedOperation(self.add_conflicts, self)
2242
def conflicts(self):
2243
conflicts = _mod_conflicts.ConflictList()
2244
for conflicted in self._iter_conflicts():
2247
if file_kind(self.abspath(conflicted)) != "file":
2249
except errors.NoSuchFile:
2252
for suffix in ('.THIS', '.OTHER'):
2254
kind = file_kind(self.abspath(conflicted+suffix))
2257
except errors.NoSuchFile:
2261
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2262
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2264
file_id=self.path2id(conflicted)))
2267
def walkdirs(self, prefix=""):
2268
"""Walk the directories of this tree.
2270
returns a generator which yields items in the form:
2271
((curren_directory_path, fileid),
2272
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2275
This API returns a generator, which is only valid during the current
2276
tree transaction - within a single lock_read or lock_write duration.
2278
If the tree is not locked, it may cause an error to be raised,
2279
depending on the tree implementation.
2281
disk_top = self.abspath(prefix)
2282
if disk_top.endswith('/'):
2283
disk_top = disk_top[:-1]
2284
top_strip_len = len(disk_top) + 1
2285
inventory_iterator = self._walkdirs(prefix)
2286
disk_iterator = osutils.walkdirs(disk_top, prefix)
2288
current_disk = disk_iterator.next()
2289
disk_finished = False
2291
if not (e.errno == errno.ENOENT or
2292
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2295
disk_finished = True
2297
current_inv = inventory_iterator.next()
2298
inv_finished = False
2299
except StopIteration:
2302
while not inv_finished or not disk_finished:
2304
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2305
cur_disk_dir_content) = current_disk
2307
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2308
cur_disk_dir_content) = ((None, None), None)
2309
if not disk_finished:
2310
# strip out .bzr dirs
2311
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2312
len(cur_disk_dir_content) > 0):
2313
# osutils.walkdirs can be made nicer -
2314
# yield the path-from-prefix rather than the pathjoined
2316
bzrdir_loc = bisect_left(cur_disk_dir_content,
2318
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2319
# we dont yield the contents of, or, .bzr itself.
2320
del cur_disk_dir_content[bzrdir_loc]
2322
# everything is unknown
2325
# everything is missing
2328
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2330
# disk is before inventory - unknown
2331
dirblock = [(relpath, basename, kind, stat, None, None) for
2332
relpath, basename, kind, stat, top_path in
2333
cur_disk_dir_content]
2334
yield (cur_disk_dir_relpath, None), dirblock
2336
current_disk = disk_iterator.next()
2337
except StopIteration:
2338
disk_finished = True
2340
# inventory is before disk - missing.
2341
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2342
for relpath, basename, dkind, stat, fileid, kind in
2344
yield (current_inv[0][0], current_inv[0][1]), dirblock
2346
current_inv = inventory_iterator.next()
2347
except StopIteration:
2350
# versioned present directory
2351
# merge the inventory and disk data together
2353
for relpath, subiterator in itertools.groupby(sorted(
2354
current_inv[1] + cur_disk_dir_content,
2355
key=operator.itemgetter(0)), operator.itemgetter(1)):
2356
path_elements = list(subiterator)
2357
if len(path_elements) == 2:
2358
inv_row, disk_row = path_elements
2359
# versioned, present file
2360
dirblock.append((inv_row[0],
2361
inv_row[1], disk_row[2],
2362
disk_row[3], inv_row[4],
2364
elif len(path_elements[0]) == 5:
2366
dirblock.append((path_elements[0][0],
2367
path_elements[0][1], path_elements[0][2],
2368
path_elements[0][3], None, None))
2369
elif len(path_elements[0]) == 6:
2370
# versioned, absent file.
2371
dirblock.append((path_elements[0][0],
2372
path_elements[0][1], 'unknown', None,
2373
path_elements[0][4], path_elements[0][5]))
2375
raise NotImplementedError('unreachable code')
2376
yield current_inv[0], dirblock
2378
current_inv = inventory_iterator.next()
2379
except StopIteration:
2382
current_disk = disk_iterator.next()
2383
except StopIteration:
2384
disk_finished = True
2386
def _walkdirs(self, prefix=""):
2387
"""Walk the directories of this tree.
2389
:prefix: is used as the directrory to start with.
2390
returns a generator which yields items in the form:
2391
((curren_directory_path, fileid),
2392
[(file1_path, file1_name, file1_kind, None, file1_id,
2395
_directory = 'directory'
2396
# get the root in the inventory
2397
inv = self.inventory
2398
top_id = inv.path2id(prefix)
2402
pending = [(prefix, '', _directory, None, top_id, None)]
2405
currentdir = pending.pop()
2406
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2407
top_id = currentdir[4]
2409
relroot = currentdir[0] + '/'
2412
# FIXME: stash the node in pending
2414
for name, child in entry.sorted_children():
2415
dirblock.append((relroot + name, name, child.kind, None,
2416
child.file_id, child.kind
2418
yield (currentdir[0], entry.file_id), dirblock
2419
# push the user specified dirs from dirblock
2420
for dir in reversed(dirblock):
2421
if dir[2] == _directory:
2424
@needs_tree_write_lock
2425
def auto_resolve(self):
2426
"""Automatically resolve text conflicts according to contents.
2428
Only text conflicts are auto_resolvable. Files with no conflict markers
2429
are considered 'resolved', because bzr always puts conflict markers
2430
into files that have text conflicts. The corresponding .THIS .BASE and
2431
.OTHER files are deleted, as per 'resolve'.
2432
:return: a tuple of ConflictLists: (un_resolved, resolved).
2434
un_resolved = _mod_conflicts.ConflictList()
2435
resolved = _mod_conflicts.ConflictList()
2436
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2437
for conflict in self.conflicts():
2438
if (conflict.typestring != 'text conflict' or
2439
self.kind(conflict.file_id) != 'file'):
2440
un_resolved.append(conflict)
2442
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2444
for line in my_file:
2445
if conflict_re.search(line):
2446
un_resolved.append(conflict)
2449
resolved.append(conflict)
2452
resolved.remove_files(self)
2453
self.set_conflicts(un_resolved)
2454
return un_resolved, resolved
2458
tree_basis = self.basis_tree()
2459
tree_basis.lock_read()
2461
repo_basis = self.branch.repository.revision_tree(
2462
self.last_revision())
2463
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2464
raise errors.BzrCheckError(
2465
"Mismatched basis inventory content.")
2470
def _validate(self):
2471
"""Validate internal structures.
2473
This is meant mostly for the test suite. To give it a chance to detect
2474
corruption after actions have occurred. The default implementation is a
2477
:return: None. An exception should be raised if there is an error.
2482
def _get_rules_searcher(self, default_searcher):
2483
"""See Tree._get_rules_searcher."""
2484
if self._rules_searcher is None:
2485
self._rules_searcher = super(WorkingTree,
2486
self)._get_rules_searcher(default_searcher)
2487
return self._rules_searcher
2490
class WorkingTree2(WorkingTree):
2491
"""This is the Format 2 working tree.
2493
This was the first weave based working tree.
2494
- uses os locks for locking.
2495
- uses the branch last-revision.
2498
def __init__(self, *args, **kwargs):
2499
super(WorkingTree2, self).__init__(*args, **kwargs)
2500
# WorkingTree2 has more of a constraint that self._inventory must
2501
# exist. Because this is an older format, we don't mind the overhead
2502
# caused by the extra computation here.
2504
# Newer WorkingTree's should only have self._inventory set when they
2506
if self._inventory is None:
2507
self.read_working_inventory()
2509
def lock_tree_write(self):
2510
"""See WorkingTree.lock_tree_write().
2512
In Format2 WorkingTrees we have a single lock for the branch and tree
2513
so lock_tree_write() degrades to lock_write().
2515
self.branch.lock_write()
2517
return self._control_files.lock_write()
2519
self.branch.unlock()
2523
# do non-implementation specific cleanup
2526
# we share control files:
2527
if self._control_files._lock_count == 3:
2528
# _inventory_is_modified is always False during a read lock.
2529
if self._inventory_is_modified:
2531
self._write_hashcache_if_dirty()
2533
# reverse order of locking.
2535
return self._control_files.unlock()
2537
self.branch.unlock()
2540
class WorkingTree3(WorkingTree):
2541
"""This is the Format 3 working tree.
2543
This differs from the base WorkingTree by:
2544
- having its own file lock
2545
- having its own last-revision property.
2547
This is new in bzr 0.8
2551
def _last_revision(self):
2552
"""See Mutable.last_revision."""
2554
return self._transport.get_bytes('last-revision')
2555
except errors.NoSuchFile:
2556
return _mod_revision.NULL_REVISION
2558
def _change_last_revision(self, revision_id):
2559
"""See WorkingTree._change_last_revision."""
2560
if revision_id is None or revision_id == NULL_REVISION:
2562
self._transport.delete('last-revision')
2563
except errors.NoSuchFile:
2567
self._transport.put_bytes('last-revision', revision_id,
2568
mode=self._control_files._file_mode)
2571
@needs_tree_write_lock
2572
def set_conflicts(self, conflicts):
2573
self._put_rio('conflicts', conflicts.to_stanzas(),
2576
@needs_tree_write_lock
2577
def add_conflicts(self, new_conflicts):
2578
conflict_set = set(self.conflicts())
2579
conflict_set.update(set(list(new_conflicts)))
2580
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2581
key=_mod_conflicts.Conflict.sort_key)))
2584
def conflicts(self):
2586
confile = self._transport.get('conflicts')
2587
except errors.NoSuchFile:
2588
return _mod_conflicts.ConflictList()
2590
if confile.next() != CONFLICT_HEADER_1 + '\n':
2591
raise errors.ConflictFormatError()
2592
except StopIteration:
2593
raise errors.ConflictFormatError()
2594
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2597
# do non-implementation specific cleanup
2599
if self._control_files._lock_count == 1:
2600
# _inventory_is_modified is always False during a read lock.
2601
if self._inventory_is_modified:
2603
self._write_hashcache_if_dirty()
2604
# reverse order of locking.
2606
return self._control_files.unlock()
2608
self.branch.unlock()
2611
def get_conflicted_stem(path):
2612
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2613
if path.endswith(suffix):
2614
return path[:-len(suffix)]
2617
class WorkingTreeFormat(object):
2618
"""An encapsulation of the initialization and open routines for a format.
2620
Formats provide three things:
2621
* An initialization routine,
2625
Formats are placed in an dict by their format string for reference
2626
during workingtree opening. Its not required that these be instances, they
2627
can be classes themselves with class methods - it simply depends on
2628
whether state is needed for a given format or not.
2630
Once a format is deprecated, just deprecate the initialize and open
2631
methods on the format class. Do not deprecate the object, as the
2632
object will be created every time regardless.
2635
_default_format = None
2636
"""The default format used for new trees."""
2639
"""The known formats."""
2641
requires_rich_root = False
2643
upgrade_recommended = False
2646
def find_format(klass, a_bzrdir):
2647
"""Return the format for the working tree object in a_bzrdir."""
2649
transport = a_bzrdir.get_workingtree_transport(None)
2650
format_string = transport.get("format").read()
2651
return klass._formats[format_string]
2652
except errors.NoSuchFile:
2653
raise errors.NoWorkingTree(base=transport.base)
2655
raise errors.UnknownFormatError(format=format_string,
2656
kind="working tree")
2658
def __eq__(self, other):
2659
return self.__class__ is other.__class__
2661
def __ne__(self, other):
2662
return not (self == other)
2665
def get_default_format(klass):
2666
"""Return the current default format."""
2667
return klass._default_format
2669
def get_format_string(self):
2670
"""Return the ASCII format string that identifies this format."""
2671
raise NotImplementedError(self.get_format_string)
2673
def get_format_description(self):
2674
"""Return the short description for this format."""
2675
raise NotImplementedError(self.get_format_description)
2677
def is_supported(self):
2678
"""Is this format supported?
2680
Supported formats can be initialized and opened.
2681
Unsupported formats may not support initialization or committing or
2682
some other features depending on the reason for not being supported.
2687
def register_format(klass, format):
2688
klass._formats[format.get_format_string()] = format
2691
def set_default_format(klass, format):
2692
klass._default_format = format
2695
def unregister_format(klass, format):
2696
del klass._formats[format.get_format_string()]
2699
class WorkingTreeFormat2(WorkingTreeFormat):
2700
"""The second working tree format.
2702
This format modified the hash cache from the format 1 hash cache.
2705
upgrade_recommended = True
2707
def get_format_description(self):
2708
"""See WorkingTreeFormat.get_format_description()."""
2709
return "Working tree format 2"
2711
def _stub_initialize_remote(self, branch):
2712
"""As a special workaround create critical control files for a remote working tree.
2714
This ensures that it can later be updated and dealt with locally,
2715
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2716
no working tree. (See bug #43064).
2720
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2722
branch._transport.put_file('inventory', sio,
2723
mode=branch.control_files._file_mode)
2724
branch._transport.put_bytes('pending-merges', '',
2725
mode=branch.control_files._file_mode)
2728
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2729
accelerator_tree=None, hardlink=False):
2730
"""See WorkingTreeFormat.initialize()."""
2731
if not isinstance(a_bzrdir.transport, LocalTransport):
2732
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2733
if from_branch is not None:
2734
branch = from_branch
2736
branch = a_bzrdir.open_branch()
2737
if revision_id is None:
2738
revision_id = _mod_revision.ensure_null(branch.last_revision())
2741
branch.generate_revision_history(revision_id)
2745
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2751
basis_tree = branch.repository.revision_tree(revision_id)
2752
if basis_tree.inventory.root is not None:
2753
wt.set_root_id(basis_tree.get_root_id())
2754
# set the parent list and cache the basis tree.
2755
if _mod_revision.is_null(revision_id):
2758
parent_trees = [(revision_id, basis_tree)]
2759
wt.set_parent_trees(parent_trees)
2760
transform.build_tree(basis_tree, wt)
2764
super(WorkingTreeFormat2, self).__init__()
2765
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2767
def open(self, a_bzrdir, _found=False):
2768
"""Return the WorkingTree object for a_bzrdir
2770
_found is a private parameter, do not use it. It is used to indicate
2771
if format probing has already been done.
2774
# we are being called directly and must probe.
2775
raise NotImplementedError
2776
if not isinstance(a_bzrdir.transport, LocalTransport):
2777
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2778
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2784
class WorkingTreeFormat3(WorkingTreeFormat):
2785
"""The second working tree format updated to record a format marker.
2788
- exists within a metadir controlling .bzr
2789
- includes an explicit version marker for the workingtree control
2790
files, separate from the BzrDir format
2791
- modifies the hash cache format
2793
- uses a LockDir to guard access for writes.
2796
upgrade_recommended = True
2798
def get_format_string(self):
2799
"""See WorkingTreeFormat.get_format_string()."""
2800
return "Bazaar-NG Working Tree format 3"
2802
def get_format_description(self):
2803
"""See WorkingTreeFormat.get_format_description()."""
2804
return "Working tree format 3"
2806
_lock_file_name = 'lock'
2807
_lock_class = LockDir
2809
_tree_class = WorkingTree3
2811
def __get_matchingbzrdir(self):
2812
return bzrdir.BzrDirMetaFormat1()
2814
_matchingbzrdir = property(__get_matchingbzrdir)
2816
def _open_control_files(self, a_bzrdir):
2817
transport = a_bzrdir.get_workingtree_transport(None)
2818
return LockableFiles(transport, self._lock_file_name,
2821
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2822
accelerator_tree=None, hardlink=False):
2823
"""See WorkingTreeFormat.initialize().
2825
:param revision_id: if supplied, create a working tree at a different
2826
revision than the branch is at.
2827
:param accelerator_tree: A tree which can be used for retrieving file
2828
contents more quickly than the revision tree, i.e. a workingtree.
2829
The revision tree will be used for cases where accelerator_tree's
2830
content is different.
2831
:param hardlink: If true, hard-link files from accelerator_tree,
2834
if not isinstance(a_bzrdir.transport, LocalTransport):
2835
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2836
transport = a_bzrdir.get_workingtree_transport(self)
2837
control_files = self._open_control_files(a_bzrdir)
2838
control_files.create_lock()
2839
control_files.lock_write()
2840
transport.put_bytes('format', self.get_format_string(),
2841
mode=control_files._file_mode)
2842
if from_branch is not None:
2843
branch = from_branch
2845
branch = a_bzrdir.open_branch()
2846
if revision_id is None:
2847
revision_id = _mod_revision.ensure_null(branch.last_revision())
2848
# WorkingTree3 can handle an inventory which has a unique root id.
2849
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2850
# those trees. And because there isn't a format bump inbetween, we
2851
# are maintaining compatibility with older clients.
2852
# inv = Inventory(root_id=gen_root_id())
2853
inv = self._initial_inventory()
2854
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2860
_control_files=control_files)
2861
wt.lock_tree_write()
2863
basis_tree = branch.repository.revision_tree(revision_id)
2864
# only set an explicit root id if there is one to set.
2865
if basis_tree.inventory.root is not None:
2866
wt.set_root_id(basis_tree.get_root_id())
2867
if revision_id == NULL_REVISION:
2868
wt.set_parent_trees([])
2870
wt.set_parent_trees([(revision_id, basis_tree)])
2871
transform.build_tree(basis_tree, wt)
2873
# Unlock in this order so that the unlock-triggers-flush in
2874
# WorkingTree is given a chance to fire.
2875
control_files.unlock()
2879
def _initial_inventory(self):
2883
super(WorkingTreeFormat3, self).__init__()
2885
def open(self, a_bzrdir, _found=False):
2886
"""Return the WorkingTree object for a_bzrdir
2888
_found is a private parameter, do not use it. It is used to indicate
2889
if format probing has already been done.
2892
# we are being called directly and must probe.
2893
raise NotImplementedError
2894
if not isinstance(a_bzrdir.transport, LocalTransport):
2895
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2896
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2899
def _open(self, a_bzrdir, control_files):
2900
"""Open the tree itself.
2902
:param a_bzrdir: the dir for the tree.
2903
:param control_files: the control files for the tree.
2905
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2909
_control_files=control_files)
2912
return self.get_format_string()
2915
__default_format = WorkingTreeFormat4()
2916
WorkingTreeFormat.register_format(__default_format)
2917
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2918
WorkingTreeFormat.set_default_format(__default_format)
2919
# formats which have no format string are not discoverable
2920
# and not independently creatable, so are not registered.
2921
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
