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
# update the whole cache up front and write to disk if anything changed;
219
# in the future we might want to do this more selectively
220
# two possible ways offer themselves : in self._unlock, write the cache
221
# if needed, or, when the cache sees a change, append it to the hash
222
# cache file, and have the parser take the most recent entry for a
224
wt_trans = self.bzrdir.get_workingtree_transport(None)
225
cache_filename = wt_trans.local_abspath('stat-cache')
226
self._hashcache = hashcache.HashCache(basedir, cache_filename,
227
self.bzrdir._get_file_mode())
230
# is this scan needed ? it makes things kinda slow.
237
if _inventory is None:
238
# This will be acquired on lock_read() or lock_write()
239
self._inventory_is_modified = False
240
self._inventory = None
242
# the caller of __init__ has provided an inventory,
243
# we assume they know what they are doing - as its only
244
# the Format factory and creation methods that are
245
# permitted to do this.
246
self._set_inventory(_inventory, dirty=False)
247
self._detect_case_handling()
249
def _detect_case_handling(self):
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
252
wt_trans.stat("FoRMaT")
253
except errors.NoSuchFile:
254
self.case_sensitive = True
256
self.case_sensitive = False
258
self._setup_directory_is_tree_reference()
261
fget=lambda self: self._branch,
262
doc="""The branch this WorkingTree is connected to.
264
This cannot be set - it is reflective of the actual disk structure
265
the working tree has been constructed from.
268
def break_lock(self):
269
"""Break a lock if one is present from another instance.
271
Uses the ui factory to ask for confirmation if the lock may be from
274
This will probe the repository for its lock as well.
276
self._control_files.break_lock()
277
self.branch.break_lock()
279
def requires_rich_root(self):
280
return self._format.requires_rich_root
282
def supports_tree_reference(self):
285
def _set_inventory(self, inv, dirty):
286
"""Set the internal cached inventory.
288
:param inv: The inventory to set.
289
:param dirty: A boolean indicating whether the inventory is the same
290
logical inventory as whats on disk. If True the inventory is not
291
the same and should be written to disk or data will be lost, if
292
False then the inventory is the same as that on disk and any
293
serialisation would be unneeded overhead.
295
self._inventory = inv
296
self._inventory_is_modified = dirty
299
def open(path=None, _unsupported=False):
300
"""Open an existing working tree at path.
304
path = os.path.getcwdu()
305
control = bzrdir.BzrDir.open(path, _unsupported)
306
return control.open_workingtree(_unsupported)
309
def open_containing(path=None):
310
"""Open an existing working tree which has its root about path.
312
This probes for a working tree at path and searches upwards from there.
314
Basically we keep looking up until we find the control directory or
315
run into /. If there isn't one, raises NotBranchError.
316
TODO: give this a new exception.
317
If there is one, it is returned, along with the unused portion of path.
319
:return: The WorkingTree that contains 'path', and the rest of path
322
path = osutils.getcwd()
323
control, relpath = bzrdir.BzrDir.open_containing(path)
325
return control.open_workingtree(), relpath
328
def open_downlevel(path=None):
329
"""Open an unsupported working tree.
331
Only intended for advanced situations like upgrading part of a bzrdir.
333
return WorkingTree.open(path, _unsupported=True)
336
def find_trees(location):
337
def list_current(transport):
338
return [d for d in transport.list_dir('') if d != '.bzr']
339
def evaluate(bzrdir):
341
tree = bzrdir.open_workingtree()
342
except errors.NoWorkingTree:
346
transport = get_transport(location)
347
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
348
list_current=list_current)
349
return [t for t in iterator if t is not None]
351
# should be deprecated - this is slow and in any case treating them as a
352
# container is (we now know) bad style -- mbp 20070302
353
## @deprecated_method(zero_fifteen)
355
"""Iterate through file_ids for this tree.
357
file_ids are in a WorkingTree if they are in the working inventory
358
and the working file exists.
360
inv = self._inventory
361
for path, ie in inv.iter_entries():
362
if osutils.lexists(self.abspath(path)):
365
def all_file_ids(self):
366
"""See Tree.iter_all_file_ids"""
367
return set(self.inventory)
370
return "<%s of %s>" % (self.__class__.__name__,
371
getattr(self, 'basedir', None))
373
def abspath(self, filename):
374
return pathjoin(self.basedir, filename)
376
def basis_tree(self):
377
"""Return RevisionTree for the current last revision.
379
If the left most parent is a ghost then the returned tree will be an
380
empty tree - one obtained by calling repository.revision_tree(None).
383
revision_id = self.get_parent_ids()[0]
385
# no parents, return an empty revision tree.
386
# in the future this should return the tree for
387
# 'empty:' - the implicit root empty tree.
388
return self.branch.repository.revision_tree(None)
390
return self.revision_tree(revision_id)
391
except errors.NoSuchRevision:
393
# No cached copy available, retrieve from the repository.
394
# FIXME? RBC 20060403 should we cache the inventory locally
397
return self.branch.repository.revision_tree(revision_id)
398
except errors.RevisionNotPresent:
399
# the basis tree *may* be a ghost or a low level error may have
400
# occured. If the revision is present, its a problem, if its not
402
if self.branch.repository.has_revision(revision_id):
404
# the basis tree is a ghost so return an empty tree.
405
return self.branch.repository.revision_tree(None)
408
self._flush_ignore_list_cache()
410
def relpath(self, path):
411
"""Return the local path portion from a given path.
413
The path may be absolute or relative. If its a relative path it is
414
interpreted relative to the python current working directory.
416
return osutils.relpath(self.basedir, path)
418
def has_filename(self, filename):
419
return osutils.lexists(self.abspath(filename))
421
def get_file(self, file_id, path=None):
423
path = self.id2path(file_id)
424
return self.get_file_byname(path)
426
def get_file_text(self, file_id):
427
return self.get_file(file_id).read()
429
def get_file_byname(self, filename):
430
return file(self.abspath(filename), 'rb')
433
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
434
"""See Tree.annotate_iter
436
This implementation will use the basis tree implementation if possible.
437
Lines not in the basis are attributed to CURRENT_REVISION
439
If there are pending merges, lines added by those merges will be
440
incorrectly attributed to CURRENT_REVISION (but after committing, the
441
attribution will be correct).
443
basis = self.basis_tree()
446
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
447
require_versioned=True).next()
448
changed_content, kind = changes[2], changes[6]
449
if not changed_content:
450
return basis.annotate_iter(file_id)
454
if kind[0] != 'file':
457
old_lines = list(basis.annotate_iter(file_id))
459
for tree in self.branch.repository.revision_trees(
460
self.get_parent_ids()[1:]):
461
if file_id not in tree:
463
old.append(list(tree.annotate_iter(file_id)))
464
return annotate.reannotate(old, self.get_file(file_id).readlines(),
469
def _get_ancestors(self, default_revision):
470
ancestors = set([default_revision])
471
for parent_id in self.get_parent_ids():
472
ancestors.update(self.branch.repository.get_ancestry(
473
parent_id, topo_sorted=False))
476
def get_parent_ids(self):
477
"""See Tree.get_parent_ids.
479
This implementation reads the pending merges list and last_revision
480
value and uses that to decide what the parents list should be.
482
last_rev = _mod_revision.ensure_null(self._last_revision())
483
if _mod_revision.NULL_REVISION == last_rev:
488
merges_file = self._control_files.get('pending-merges')
489
except errors.NoSuchFile:
492
for l in merges_file.readlines():
493
revision_id = l.rstrip('\n')
494
parents.append(revision_id)
498
def get_root_id(self):
499
"""Return the id of this trees root"""
500
return self._inventory.root.file_id
502
def _get_store_filename(self, file_id):
503
## XXX: badly named; this is not in the store at all
504
return self.abspath(self.id2path(file_id))
507
def clone(self, to_bzrdir, revision_id=None):
508
"""Duplicate this working tree into to_bzr, including all state.
510
Specifically modified files are kept as modified, but
511
ignored and unknown files are discarded.
513
If you want to make a new line of development, see bzrdir.sprout()
516
If not None, the cloned tree will have its last revision set to
517
revision, and and difference between the source trees last revision
518
and this one merged in.
520
# assumes the target bzr dir format is compatible.
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id)
526
def copy_content_into(self, tree, revision_id=None):
527
"""Copy the current content and user files of this tree into tree."""
528
tree.set_root_id(self.get_root_id())
529
if revision_id is None:
530
merge.transform_tree(tree, self)
532
# TODO now merge from tree.last_revision to revision (to preserve
533
# user local changes)
534
merge.transform_tree(tree, self)
535
tree.set_parent_ids([revision_id])
537
def id2abspath(self, file_id):
538
return self.abspath(self.id2path(file_id))
540
def has_id(self, file_id):
541
# files that have been deleted are excluded
543
if not inv.has_id(file_id):
545
path = inv.id2path(file_id)
546
return osutils.lexists(self.abspath(path))
548
def has_or_had_id(self, file_id):
549
if file_id == self.inventory.root.file_id:
551
return self.inventory.has_id(file_id)
553
__contains__ = has_id
555
def get_file_size(self, file_id):
556
"""See Tree.get_file_size"""
558
return os.path.getsize(self.id2abspath(file_id))
560
if e.errno != errno.ENOENT:
566
def get_file_sha1(self, file_id, path=None, stat_value=None):
568
path = self._inventory.id2path(file_id)
569
return self._hashcache.get_sha1(path, stat_value)
571
def get_file_mtime(self, file_id, path=None):
573
path = self.inventory.id2path(file_id)
574
return os.lstat(self.abspath(path)).st_mtime
576
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
577
file_id = self.path2id(path)
578
return self._inventory[file_id].executable
580
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
581
mode = stat_result.st_mode
582
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
584
if not supports_executable():
585
def is_executable(self, file_id, path=None):
586
return self._inventory[file_id].executable
588
_is_executable_from_path_and_stat = \
589
_is_executable_from_path_and_stat_from_basis
591
def is_executable(self, file_id, path=None):
593
path = self.id2path(file_id)
594
mode = os.lstat(self.abspath(path)).st_mode
595
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
597
_is_executable_from_path_and_stat = \
598
_is_executable_from_path_and_stat_from_stat
600
@needs_tree_write_lock
601
def _add(self, files, ids, kinds):
602
"""See MutableTree._add."""
603
# TODO: Re-adding a file that is removed in the working copy
604
# should probably put it back with the previous ID.
605
# the read and write working inventory should not occur in this
606
# function - they should be part of lock_write and unlock.
608
for f, file_id, kind in zip(files, ids, kinds):
610
inv.add_path(f, kind=kind)
612
inv.add_path(f, kind=kind, file_id=file_id)
613
self._inventory_is_modified = True
615
@needs_tree_write_lock
616
def _gather_kinds(self, files, kinds):
617
"""See MutableTree._gather_kinds."""
618
for pos, f in enumerate(files):
619
if kinds[pos] is None:
620
fullpath = normpath(self.abspath(f))
622
kinds[pos] = file_kind(fullpath)
624
if e.errno == errno.ENOENT:
625
raise errors.NoSuchFile(fullpath)
628
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
629
"""Add revision_id as a parent.
631
This is equivalent to retrieving the current list of parent ids
632
and setting the list to its value plus revision_id.
634
:param revision_id: The revision id to add to the parent list. It may
635
be a ghost revision as long as its not the first parent to be added,
636
or the allow_leftmost_as_ghost parameter is set True.
637
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
639
parents = self.get_parent_ids() + [revision_id]
640
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
641
or allow_leftmost_as_ghost)
643
@needs_tree_write_lock
644
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
645
"""Add revision_id, tree tuple as a parent.
647
This is equivalent to retrieving the current list of parent trees
648
and setting the list to its value plus parent_tuple. See also
649
add_parent_tree_id - if you only have a parent id available it will be
650
simpler to use that api. If you have the parent already available, using
651
this api is preferred.
653
:param parent_tuple: The (revision id, tree) to add to the parent list.
654
If the revision_id is a ghost, pass None for the tree.
655
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
657
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
658
if len(parent_ids) > 1:
659
# the leftmost may have already been a ghost, preserve that if it
661
allow_leftmost_as_ghost = True
662
self.set_parent_ids(parent_ids,
663
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
665
@needs_tree_write_lock
666
def add_pending_merge(self, *revision_ids):
667
# TODO: Perhaps should check at this point that the
668
# history of the revision is actually present?
669
parents = self.get_parent_ids()
671
for rev_id in revision_ids:
672
if rev_id in parents:
674
parents.append(rev_id)
677
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
679
def path_content_summary(self, path, _lstat=os.lstat,
680
_mapper=osutils.file_kind_from_stat_mode):
681
"""See Tree.path_content_summary."""
682
abspath = self.abspath(path)
684
stat_result = _lstat(abspath)
686
if getattr(e, 'errno', None) == errno.ENOENT:
688
return ('missing', None, None, None)
689
# propagate other errors
691
kind = _mapper(stat_result.st_mode)
693
size = stat_result.st_size
694
# try for a stat cache lookup
695
executable = self._is_executable_from_path_and_stat(path, stat_result)
696
return (kind, size, executable, self._sha_from_stat(
698
elif kind == 'directory':
699
# perhaps it looks like a plain directory, but it's really a
701
if self._directory_is_tree_reference(path):
702
kind = 'tree-reference'
703
return kind, None, None, None
704
elif kind == 'symlink':
705
return ('symlink', None, None, os.readlink(abspath))
707
return (kind, None, None, None)
709
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
710
"""Common ghost checking functionality from set_parent_*.
712
This checks that the left hand-parent exists if there are any
715
if len(revision_ids) > 0:
716
leftmost_id = revision_ids[0]
717
if (not allow_leftmost_as_ghost and not
718
self.branch.repository.has_revision(leftmost_id)):
719
raise errors.GhostRevisionUnusableHere(leftmost_id)
721
def _set_merges_from_parent_ids(self, parent_ids):
722
merges = parent_ids[1:]
723
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
725
@needs_tree_write_lock
726
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
727
"""Set the parent ids to revision_ids.
729
See also set_parent_trees. This api will try to retrieve the tree data
730
for each element of revision_ids from the trees repository. If you have
731
tree data already available, it is more efficient to use
732
set_parent_trees rather than set_parent_ids. set_parent_ids is however
733
an easier API to use.
735
:param revision_ids: The revision_ids to set as the parent ids of this
736
working tree. Any of these may be ghosts.
738
self._check_parents_for_ghosts(revision_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
for revision_id in revision_ids:
741
_mod_revision.check_not_reserved_id(revision_id)
743
if len(revision_ids) > 0:
744
self.set_last_revision(revision_ids[0])
746
self.set_last_revision(_mod_revision.NULL_REVISION)
748
self._set_merges_from_parent_ids(revision_ids)
750
@needs_tree_write_lock
751
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
752
"""See MutableTree.set_parent_trees."""
753
parent_ids = [rev for (rev, tree) in parents_list]
754
for revision_id in parent_ids:
755
_mod_revision.check_not_reserved_id(revision_id)
757
self._check_parents_for_ghosts(parent_ids,
758
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
760
if len(parent_ids) == 0:
761
leftmost_parent_id = _mod_revision.NULL_REVISION
762
leftmost_parent_tree = None
764
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
766
if self._change_last_revision(leftmost_parent_id):
767
if leftmost_parent_tree is None:
768
# If we don't have a tree, fall back to reading the
769
# parent tree from the repository.
770
self._cache_basis_inventory(leftmost_parent_id)
772
inv = leftmost_parent_tree.inventory
773
xml = self._create_basis_xml_from_inventory(
774
leftmost_parent_id, inv)
775
self._write_basis_inventory(xml)
776
self._set_merges_from_parent_ids(parent_ids)
778
@needs_tree_write_lock
779
def set_pending_merges(self, rev_list):
780
parents = self.get_parent_ids()
781
leftmost = parents[:1]
782
new_parents = leftmost + rev_list
783
self.set_parent_ids(new_parents)
785
@needs_tree_write_lock
786
def set_merge_modified(self, modified_hashes):
788
for file_id, hash in modified_hashes.iteritems():
789
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
790
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
792
def _sha_from_stat(self, path, stat_result):
793
"""Get a sha digest from the tree's stat cache.
795
The default implementation assumes no stat cache is present.
797
:param path: The path.
798
:param stat_result: The stat result being looked up.
802
def _put_rio(self, filename, stanzas, header):
803
self._must_be_locked()
804
my_file = rio_file(stanzas, header)
805
self._control_files.put(filename, my_file)
807
@needs_write_lock # because merge pulls data into the branch.
808
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
810
"""Merge from a branch into this working tree.
812
:param branch: The branch to merge from.
813
:param to_revision: If non-None, the merge will merge to to_revision,
814
but not beyond it. to_revision does not need to be in the history
815
of the branch when it is supplied. If None, to_revision defaults to
816
branch.last_revision().
818
from bzrlib.merge import Merger, Merge3Merger
819
pb = bzrlib.ui.ui_factory.nested_progress_bar()
821
merger = Merger(self.branch, this_tree=self, pb=pb)
822
merger.pp = ProgressPhase("Merge phase", 5, pb)
823
merger.pp.next_phase()
824
# check that there are no
826
merger.check_basis(check_clean=True, require_commits=False)
827
if to_revision is None:
828
to_revision = _mod_revision.ensure_null(branch.last_revision())
829
merger.other_rev_id = to_revision
830
if _mod_revision.is_null(merger.other_rev_id):
831
raise errors.NoCommits(branch)
832
self.branch.fetch(branch, last_revision=merger.other_rev_id)
833
merger.other_basis = merger.other_rev_id
834
merger.other_tree = self.branch.repository.revision_tree(
836
merger.other_branch = branch
837
merger.pp.next_phase()
838
if from_revision is None:
841
merger.set_base_revision(from_revision, branch)
842
if merger.base_rev_id == merger.other_rev_id:
843
raise errors.PointlessMerge
844
merger.backup_files = False
845
if merge_type is None:
846
merger.merge_type = Merge3Merger
848
merger.merge_type = merge_type
849
merger.set_interesting_files(None)
850
merger.show_base = False
851
merger.reprocess = False
852
conflicts = merger.do_merge()
859
def merge_modified(self):
860
"""Return a dictionary of files modified by a merge.
862
The list is initialized by WorkingTree.set_merge_modified, which is
863
typically called after we make some automatic updates to the tree
866
This returns a map of file_id->sha1, containing only files which are
867
still in the working inventory and have that text hash.
870
hashfile = self._control_files.get('merge-hashes')
871
except errors.NoSuchFile:
875
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
876
raise errors.MergeModifiedFormatError()
877
except StopIteration:
878
raise errors.MergeModifiedFormatError()
879
for s in RioReader(hashfile):
880
# RioReader reads in Unicode, so convert file_ids back to utf8
881
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
882
if file_id not in self.inventory:
884
text_hash = s.get("hash")
885
if text_hash == self.get_file_sha1(file_id):
886
merge_hashes[file_id] = text_hash
890
def mkdir(self, path, file_id=None):
891
"""See MutableTree.mkdir()."""
893
file_id = generate_ids.gen_file_id(os.path.basename(path))
894
os.mkdir(self.abspath(path))
895
self.add(path, file_id, 'directory')
898
def get_symlink_target(self, file_id):
899
return os.readlink(self.id2abspath(file_id))
902
def subsume(self, other_tree):
903
def add_children(inventory, entry):
904
for child_entry in entry.children.values():
905
inventory._byid[child_entry.file_id] = child_entry
906
if child_entry.kind == 'directory':
907
add_children(inventory, child_entry)
908
if other_tree.get_root_id() == self.get_root_id():
909
raise errors.BadSubsumeSource(self, other_tree,
910
'Trees have the same root')
912
other_tree_path = self.relpath(other_tree.basedir)
913
except errors.PathNotChild:
914
raise errors.BadSubsumeSource(self, other_tree,
915
'Tree is not contained by the other')
916
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
917
if new_root_parent is None:
918
raise errors.BadSubsumeSource(self, other_tree,
919
'Parent directory is not versioned.')
920
# We need to ensure that the result of a fetch will have a
921
# versionedfile for the other_tree root, and only fetching into
922
# RepositoryKnit2 guarantees that.
923
if not self.branch.repository.supports_rich_root():
924
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
925
other_tree.lock_tree_write()
927
new_parents = other_tree.get_parent_ids()
928
other_root = other_tree.inventory.root
929
other_root.parent_id = new_root_parent
930
other_root.name = osutils.basename(other_tree_path)
931
self.inventory.add(other_root)
932
add_children(self.inventory, other_root)
933
self._write_inventory(self.inventory)
934
# normally we don't want to fetch whole repositories, but i think
935
# here we really do want to consolidate the whole thing.
936
for parent_id in other_tree.get_parent_ids():
937
self.branch.fetch(other_tree.branch, parent_id)
938
self.add_parent_tree_id(parent_id)
941
other_tree.bzrdir.retire_bzrdir()
943
def _setup_directory_is_tree_reference(self):
944
if self._branch.repository._format.supports_tree_reference:
945
self._directory_is_tree_reference = \
946
self._directory_may_be_tree_reference
948
self._directory_is_tree_reference = \
949
self._directory_is_never_tree_reference
951
def _directory_is_never_tree_reference(self, relpath):
954
def _directory_may_be_tree_reference(self, relpath):
955
# as a special case, if a directory contains control files then
956
# it's a tree reference, except that the root of the tree is not
957
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
958
# TODO: We could ask all the control formats whether they
959
# recognize this directory, but at the moment there's no cheap api
960
# to do that. Since we probably can only nest bzr checkouts and
961
# they always use this name it's ok for now. -- mbp 20060306
963
# FIXME: There is an unhandled case here of a subdirectory
964
# containing .bzr but not a branch; that will probably blow up
965
# when you try to commit it. It might happen if there is a
966
# checkout in a subdirectory. This can be avoided by not adding
969
@needs_tree_write_lock
970
def extract(self, file_id, format=None):
971
"""Extract a subtree from this tree.
973
A new branch will be created, relative to the path for this tree.
977
segments = osutils.splitpath(path)
978
transport = self.branch.bzrdir.root_transport
979
for name in segments:
980
transport = transport.clone(name)
981
transport.ensure_base()
984
sub_path = self.id2path(file_id)
985
branch_transport = mkdirs(sub_path)
987
format = self.bzrdir.cloning_metadir()
988
branch_transport.ensure_base()
989
branch_bzrdir = format.initialize_on_transport(branch_transport)
991
repo = branch_bzrdir.find_repository()
992
except errors.NoRepositoryPresent:
993
repo = branch_bzrdir.create_repository()
994
if not repo.supports_rich_root():
995
raise errors.RootNotRich()
996
new_branch = branch_bzrdir.create_branch()
997
new_branch.pull(self.branch)
998
for parent_id in self.get_parent_ids():
999
new_branch.fetch(self.branch, parent_id)
1000
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1001
if tree_transport.base != branch_transport.base:
1002
tree_bzrdir = format.initialize_on_transport(tree_transport)
1003
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1005
tree_bzrdir = branch_bzrdir
1006
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1007
wt.set_parent_ids(self.get_parent_ids())
1008
my_inv = self.inventory
1009
child_inv = Inventory(root_id=None)
1010
new_root = my_inv[file_id]
1011
my_inv.remove_recursive_id(file_id)
1012
new_root.parent_id = None
1013
child_inv.add(new_root)
1014
self._write_inventory(my_inv)
1015
wt._write_inventory(child_inv)
1018
def _serialize(self, inventory, out_file):
1019
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1022
def _deserialize(selt, in_file):
1023
return xml5.serializer_v5.read_inventory(in_file)
1026
"""Write the in memory inventory to disk."""
1027
# TODO: Maybe this should only write on dirty ?
1028
if self._control_files._lock_mode != 'w':
1029
raise errors.NotWriteLocked(self)
1031
self._serialize(self._inventory, sio)
1033
self._control_files.put('inventory', sio)
1034
self._inventory_is_modified = False
1036
def _kind(self, relpath):
1037
return osutils.file_kind(self.abspath(relpath))
1039
def list_files(self, include_root=False):
1040
"""Recursively list all files as (path, class, kind, id, entry).
1042
Lists, but does not descend into unversioned directories.
1044
This does not include files that have been deleted in this
1047
Skips the control directory.
1049
# list_files is an iterator, so @needs_read_lock doesn't work properly
1050
# with it. So callers should be careful to always read_lock the tree.
1051
if not self.is_locked():
1052
raise errors.ObjectNotLocked(self)
1054
inv = self.inventory
1055
if include_root is True:
1056
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1057
# Convert these into local objects to save lookup times
1058
pathjoin = osutils.pathjoin
1059
file_kind = self._kind
1061
# transport.base ends in a slash, we want the piece
1062
# between the last two slashes
1063
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1065
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1067
# directory file_id, relative path, absolute path, reverse sorted children
1068
children = os.listdir(self.basedir)
1070
# jam 20060527 The kernel sized tree seems equivalent whether we
1071
# use a deque and popleft to keep them sorted, or if we use a plain
1072
# list and just reverse() them.
1073
children = collections.deque(children)
1074
stack = [(inv.root.file_id, u'', self.basedir, children)]
1076
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1079
f = children.popleft()
1080
## TODO: If we find a subdirectory with its own .bzr
1081
## directory, then that is a separate tree and we
1082
## should exclude it.
1084
# the bzrdir for this tree
1085
if transport_base_dir == f:
1088
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1089
# and 'f' doesn't begin with one, we can do a string op, rather
1090
# than the checks of pathjoin(), all relative paths will have an extra slash
1092
fp = from_dir_relpath + '/' + f
1095
fap = from_dir_abspath + '/' + f
1097
f_ie = inv.get_child(from_dir_id, f)
1100
elif self.is_ignored(fp[1:]):
1103
# we may not have found this file, because of a unicode issue
1104
f_norm, can_access = osutils.normalized_filename(f)
1105
if f == f_norm or not can_access:
1106
# No change, so treat this file normally
1109
# this file can be accessed by a normalized path
1110
# check again if it is versioned
1111
# these lines are repeated here for performance
1113
fp = from_dir_relpath + '/' + f
1114
fap = from_dir_abspath + '/' + f
1115
f_ie = inv.get_child(from_dir_id, f)
1118
elif self.is_ignored(fp[1:]):
1125
# make a last minute entry
1127
yield fp[1:], c, fk, f_ie.file_id, f_ie
1130
yield fp[1:], c, fk, None, fk_entries[fk]()
1132
yield fp[1:], c, fk, None, TreeEntry()
1135
if fk != 'directory':
1138
# But do this child first
1139
new_children = os.listdir(fap)
1141
new_children = collections.deque(new_children)
1142
stack.append((f_ie.file_id, fp, fap, new_children))
1143
# Break out of inner loop,
1144
# so that we start outer loop with child
1147
# if we finished all children, pop it off the stack
1150
@needs_tree_write_lock
1151
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1154
to_dir must exist in the inventory.
1156
If to_dir exists and is a directory, the files are moved into
1157
it, keeping their old names.
1159
Note that to_dir is only the last component of the new name;
1160
this doesn't change the directory.
1162
For each entry in from_paths the move mode will be determined
1165
The first mode moves the file in the filesystem and updates the
1166
inventory. The second mode only updates the inventory without
1167
touching the file on the filesystem. This is the new mode introduced
1170
move uses the second mode if 'after == True' and the target is not
1171
versioned but present in the working tree.
1173
move uses the second mode if 'after == False' and the source is
1174
versioned but no longer in the working tree, and the target is not
1175
versioned but present in the working tree.
1177
move uses the first mode if 'after == False' and the source is
1178
versioned and present in the working tree, and the target is not
1179
versioned and not present in the working tree.
1181
Everything else results in an error.
1183
This returns a list of (from_path, to_path) pairs for each
1184
entry that is moved.
1189
# check for deprecated use of signature
1191
to_dir = kwargs.get('to_name', None)
1193
raise TypeError('You must supply a target directory')
1195
symbol_versioning.warn('The parameter to_name was deprecated'
1196
' in version 0.13. Use to_dir instead',
1199
# check destination directory
1200
if isinstance(from_paths, basestring):
1202
inv = self.inventory
1203
to_abs = self.abspath(to_dir)
1204
if not isdir(to_abs):
1205
raise errors.BzrMoveFailedError('',to_dir,
1206
errors.NotADirectory(to_abs))
1207
if not self.has_filename(to_dir):
1208
raise errors.BzrMoveFailedError('',to_dir,
1209
errors.NotInWorkingDirectory(to_dir))
1210
to_dir_id = inv.path2id(to_dir)
1211
if to_dir_id is None:
1212
raise errors.BzrMoveFailedError('',to_dir,
1213
errors.NotVersionedError(path=str(to_dir)))
1215
to_dir_ie = inv[to_dir_id]
1216
if to_dir_ie.kind != 'directory':
1217
raise errors.BzrMoveFailedError('',to_dir,
1218
errors.NotADirectory(to_abs))
1220
# create rename entries and tuples
1221
for from_rel in from_paths:
1222
from_tail = splitpath(from_rel)[-1]
1223
from_id = inv.path2id(from_rel)
1225
raise errors.BzrMoveFailedError(from_rel,to_dir,
1226
errors.NotVersionedError(path=str(from_rel)))
1228
from_entry = inv[from_id]
1229
from_parent_id = from_entry.parent_id
1230
to_rel = pathjoin(to_dir, from_tail)
1231
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1233
from_tail=from_tail,
1234
from_parent_id=from_parent_id,
1235
to_rel=to_rel, to_tail=from_tail,
1236
to_parent_id=to_dir_id)
1237
rename_entries.append(rename_entry)
1238
rename_tuples.append((from_rel, to_rel))
1240
# determine which move mode to use. checks also for movability
1241
rename_entries = self._determine_mv_mode(rename_entries, after)
1243
original_modified = self._inventory_is_modified
1246
self._inventory_is_modified = True
1247
self._move(rename_entries)
1249
# restore the inventory on error
1250
self._inventory_is_modified = original_modified
1252
self._write_inventory(inv)
1253
return rename_tuples
1255
def _determine_mv_mode(self, rename_entries, after=False):
1256
"""Determines for each from-to pair if both inventory and working tree
1257
or only the inventory has to be changed.
1259
Also does basic plausability tests.
1261
inv = self.inventory
1263
for rename_entry in rename_entries:
1264
# store to local variables for easier reference
1265
from_rel = rename_entry.from_rel
1266
from_id = rename_entry.from_id
1267
to_rel = rename_entry.to_rel
1268
to_id = inv.path2id(to_rel)
1269
only_change_inv = False
1271
# check the inventory for source and destination
1273
raise errors.BzrMoveFailedError(from_rel,to_rel,
1274
errors.NotVersionedError(path=str(from_rel)))
1275
if to_id is not None:
1276
raise errors.BzrMoveFailedError(from_rel,to_rel,
1277
errors.AlreadyVersionedError(path=str(to_rel)))
1279
# try to determine the mode for rename (only change inv or change
1280
# inv and file system)
1282
if not self.has_filename(to_rel):
1283
raise errors.BzrMoveFailedError(from_id,to_rel,
1284
errors.NoSuchFile(path=str(to_rel),
1285
extra="New file has not been created yet"))
1286
only_change_inv = True
1287
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1288
only_change_inv = True
1289
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1290
only_change_inv = False
1291
elif (sys.platform == 'win32'
1292
and from_rel.lower() == to_rel.lower()
1293
and self.has_filename(from_rel)):
1294
only_change_inv = False
1296
# something is wrong, so lets determine what exactly
1297
if not self.has_filename(from_rel) and \
1298
not self.has_filename(to_rel):
1299
raise errors.BzrRenameFailedError(from_rel,to_rel,
1300
errors.PathsDoNotExist(paths=(str(from_rel),
1303
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1304
rename_entry.only_change_inv = only_change_inv
1305
return rename_entries
1307
def _move(self, rename_entries):
1308
"""Moves a list of files.
1310
Depending on the value of the flag 'only_change_inv', the
1311
file will be moved on the file system or not.
1313
inv = self.inventory
1316
for entry in rename_entries:
1318
self._move_entry(entry)
1320
self._rollback_move(moved)
1324
def _rollback_move(self, moved):
1325
"""Try to rollback a previous move in case of an filesystem error."""
1326
inv = self.inventory
1329
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1330
entry.to_tail, entry.to_parent_id, entry.from_rel,
1331
entry.from_tail, entry.from_parent_id,
1332
entry.only_change_inv))
1333
except errors.BzrMoveFailedError, e:
1334
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1335
" The working tree is in an inconsistent state."
1336
" Please consider doing a 'bzr revert'."
1337
" Error message is: %s" % e)
1339
def _move_entry(self, entry):
1340
inv = self.inventory
1341
from_rel_abs = self.abspath(entry.from_rel)
1342
to_rel_abs = self.abspath(entry.to_rel)
1343
if from_rel_abs == to_rel_abs:
1344
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1345
"Source and target are identical.")
1347
if not entry.only_change_inv:
1349
osutils.rename(from_rel_abs, to_rel_abs)
1351
raise errors.BzrMoveFailedError(entry.from_rel,
1353
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1355
@needs_tree_write_lock
1356
def rename_one(self, from_rel, to_rel, after=False):
1359
This can change the directory or the filename or both.
1361
rename_one has several 'modes' to work. First, it can rename a physical
1362
file and change the file_id. That is the normal mode. Second, it can
1363
only change the file_id without touching any physical file. This is
1364
the new mode introduced in version 0.15.
1366
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1367
versioned but present in the working tree.
1369
rename_one uses the second mode if 'after == False' and 'from_rel' is
1370
versioned but no longer in the working tree, and 'to_rel' is not
1371
versioned but present in the working tree.
1373
rename_one uses the first mode if 'after == False' and 'from_rel' is
1374
versioned and present in the working tree, and 'to_rel' is not
1375
versioned and not present in the working tree.
1377
Everything else results in an error.
1379
inv = self.inventory
1382
# create rename entries and tuples
1383
from_tail = splitpath(from_rel)[-1]
1384
from_id = inv.path2id(from_rel)
1386
raise errors.BzrRenameFailedError(from_rel,to_rel,
1387
errors.NotVersionedError(path=str(from_rel)))
1388
from_entry = inv[from_id]
1389
from_parent_id = from_entry.parent_id
1390
to_dir, to_tail = os.path.split(to_rel)
1391
to_dir_id = inv.path2id(to_dir)
1392
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1394
from_tail=from_tail,
1395
from_parent_id=from_parent_id,
1396
to_rel=to_rel, to_tail=to_tail,
1397
to_parent_id=to_dir_id)
1398
rename_entries.append(rename_entry)
1400
# determine which move mode to use. checks also for movability
1401
rename_entries = self._determine_mv_mode(rename_entries, after)
1403
# check if the target changed directory and if the target directory is
1405
if to_dir_id is None:
1406
raise errors.BzrMoveFailedError(from_rel,to_rel,
1407
errors.NotVersionedError(path=str(to_dir)))
1409
# all checks done. now we can continue with our actual work
1410
mutter('rename_one:\n'
1415
' to_dir_id {%s}\n',
1416
from_id, from_rel, to_rel, to_dir, to_dir_id)
1418
self._move(rename_entries)
1419
self._write_inventory(inv)
1421
class _RenameEntry(object):
1422
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1423
to_rel, to_tail, to_parent_id, only_change_inv=False):
1424
self.from_rel = from_rel
1425
self.from_id = from_id
1426
self.from_tail = from_tail
1427
self.from_parent_id = from_parent_id
1428
self.to_rel = to_rel
1429
self.to_tail = to_tail
1430
self.to_parent_id = to_parent_id
1431
self.only_change_inv = only_change_inv
1435
"""Return all unknown files.
1437
These are files in the working directory that are not versioned or
1438
control files or ignored.
1440
# force the extras method to be fully executed before returning, to
1441
# prevent race conditions with the lock
1443
[subp for subp in self.extras() if not self.is_ignored(subp)])
1445
@needs_tree_write_lock
1446
def unversion(self, file_ids):
1447
"""Remove the file ids in file_ids from the current versioned set.
1449
When a file_id is unversioned, all of its children are automatically
1452
:param file_ids: The file ids to stop versioning.
1453
:raises: NoSuchId if any fileid is not currently versioned.
1455
for file_id in file_ids:
1456
if self._inventory.has_id(file_id):
1457
self._inventory.remove_recursive_id(file_id)
1459
raise errors.NoSuchId(self, file_id)
1461
# in the future this should just set a dirty bit to wait for the
1462
# final unlock. However, until all methods of workingtree start
1463
# with the current in -memory inventory rather than triggering
1464
# a read, it is more complex - we need to teach read_inventory
1465
# to know when to read, and when to not read first... and possibly
1466
# to save first when the in memory one may be corrupted.
1467
# so for now, we just only write it if it is indeed dirty.
1469
self._write_inventory(self._inventory)
1471
def _iter_conflicts(self):
1473
for info in self.list_files():
1475
stem = get_conflicted_stem(path)
1478
if stem not in conflicted:
1479
conflicted.add(stem)
1483
def pull(self, source, overwrite=False, stop_revision=None,
1484
change_reporter=None, possible_transports=None):
1485
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1488
pp = ProgressPhase("Pull phase", 2, top_pb)
1490
old_revision_info = self.branch.last_revision_info()
1491
basis_tree = self.basis_tree()
1492
count = self.branch.pull(source, overwrite, stop_revision,
1493
possible_transports=possible_transports)
1494
new_revision_info = self.branch.last_revision_info()
1495
if new_revision_info != old_revision_info:
1497
repository = self.branch.repository
1498
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1499
basis_tree.lock_read()
1501
new_basis_tree = self.branch.basis_tree()
1508
change_reporter=change_reporter)
1509
if (basis_tree.inventory.root is None and
1510
new_basis_tree.inventory.root is not None):
1511
self.set_root_id(new_basis_tree.get_root_id())
1515
# TODO - dedup parents list with things merged by pull ?
1516
# reuse the revisiontree we merged against to set the new
1518
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1519
# we have to pull the merge trees out again, because
1520
# merge_inner has set the ids. - this corner is not yet
1521
# layered well enough to prevent double handling.
1522
# XXX TODO: Fix the double handling: telling the tree about
1523
# the already known parent data is wasteful.
1524
merges = self.get_parent_ids()[1:]
1525
parent_trees.extend([
1526
(parent, repository.revision_tree(parent)) for
1528
self.set_parent_trees(parent_trees)
1535
def put_file_bytes_non_atomic(self, file_id, bytes):
1536
"""See MutableTree.put_file_bytes_non_atomic."""
1537
stream = file(self.id2abspath(file_id), 'wb')
1542
# TODO: update the hashcache here ?
1545
"""Yield all unversioned files in this WorkingTree.
1547
If there are any unversioned directories then only the directory is
1548
returned, not all its children. But if there are unversioned files
1549
under a versioned subdirectory, they are returned.
1551
Currently returned depth-first, sorted by name within directories.
1552
This is the same order used by 'osutils.walkdirs'.
1554
## TODO: Work from given directory downwards
1555
for path, dir_entry in self.inventory.directories():
1556
# mutter("search for unknowns in %r", path)
1557
dirabs = self.abspath(path)
1558
if not isdir(dirabs):
1559
# e.g. directory deleted
1563
for subf in os.listdir(dirabs):
1566
if subf not in dir_entry.children:
1567
subf_norm, can_access = osutils.normalized_filename(subf)
1568
if subf_norm != subf and can_access:
1569
if subf_norm not in dir_entry.children:
1570
fl.append(subf_norm)
1576
subp = pathjoin(path, subf)
1579
def ignored_files(self):
1580
"""Yield list of PATH, IGNORE_PATTERN"""
1581
for subp in self.extras():
1582
pat = self.is_ignored(subp)
1586
def get_ignore_list(self):
1587
"""Return list of ignore patterns.
1589
Cached in the Tree object after the first call.
1591
ignoreset = getattr(self, '_ignoreset', None)
1592
if ignoreset is not None:
1595
ignore_globs = set()
1596
ignore_globs.update(ignores.get_runtime_ignores())
1597
ignore_globs.update(ignores.get_user_ignores())
1598
if self.has_filename(bzrlib.IGNORE_FILENAME):
1599
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1601
ignore_globs.update(ignores.parse_ignore_file(f))
1604
self._ignoreset = ignore_globs
1607
def _flush_ignore_list_cache(self):
1608
"""Resets the cached ignore list to force a cache rebuild."""
1609
self._ignoreset = None
1610
self._ignoreglobster = None
1612
def is_ignored(self, filename):
1613
r"""Check whether the filename matches an ignore pattern.
1615
Patterns containing '/' or '\' need to match the whole path;
1616
others match against only the last component.
1618
If the file is ignored, returns the pattern which caused it to
1619
be ignored, otherwise None. So this can simply be used as a
1620
boolean if desired."""
1621
if getattr(self, '_ignoreglobster', None) is None:
1622
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1623
return self._ignoreglobster.match(filename)
1625
def kind(self, file_id):
1626
return file_kind(self.id2abspath(file_id))
1628
def stored_kind(self, file_id):
1629
"""See Tree.stored_kind"""
1630
return self.inventory[file_id].kind
1632
def _comparison_data(self, entry, path):
1633
abspath = self.abspath(path)
1635
stat_value = os.lstat(abspath)
1637
if getattr(e, 'errno', None) == errno.ENOENT:
1644
mode = stat_value.st_mode
1645
kind = osutils.file_kind_from_stat_mode(mode)
1646
if not supports_executable():
1647
executable = entry is not None and entry.executable
1649
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1650
return kind, executable, stat_value
1652
def _file_size(self, entry, stat_value):
1653
return stat_value.st_size
1655
def last_revision(self):
1656
"""Return the last revision of the branch for this tree.
1658
This format tree does not support a separate marker for last-revision
1659
compared to the branch.
1661
See MutableTree.last_revision
1663
return self._last_revision()
1666
def _last_revision(self):
1667
"""helper for get_parent_ids."""
1668
return _mod_revision.ensure_null(self.branch.last_revision())
1670
def is_locked(self):
1671
return self._control_files.is_locked()
1673
def _must_be_locked(self):
1674
if not self.is_locked():
1675
raise errors.ObjectNotLocked(self)
1677
def lock_read(self):
1678
"""See Branch.lock_read, and WorkingTree.unlock."""
1679
if not self.is_locked():
1681
self.branch.lock_read()
1683
return self._control_files.lock_read()
1685
self.branch.unlock()
1688
def lock_tree_write(self):
1689
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1690
if not self.is_locked():
1692
self.branch.lock_read()
1694
return self._control_files.lock_write()
1696
self.branch.unlock()
1699
def lock_write(self):
1700
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1701
if not self.is_locked():
1703
self.branch.lock_write()
1705
return self._control_files.lock_write()
1707
self.branch.unlock()
1710
def get_physical_lock_status(self):
1711
return self._control_files.get_physical_lock_status()
1713
def _basis_inventory_name(self):
1714
return 'basis-inventory-cache'
1716
def _reset_data(self):
1717
"""Reset transient data that cannot be revalidated."""
1718
self._inventory_is_modified = False
1719
result = self._deserialize(self._control_files.get('inventory'))
1720
self._set_inventory(result, dirty=False)
1722
@needs_tree_write_lock
1723
def set_last_revision(self, new_revision):
1724
"""Change the last revision in the working tree."""
1725
if self._change_last_revision(new_revision):
1726
self._cache_basis_inventory(new_revision)
1728
def _change_last_revision(self, new_revision):
1729
"""Template method part of set_last_revision to perform the change.
1731
This is used to allow WorkingTree3 instances to not affect branch
1732
when their last revision is set.
1734
if _mod_revision.is_null(new_revision):
1735
self.branch.set_revision_history([])
1738
self.branch.generate_revision_history(new_revision)
1739
except errors.NoSuchRevision:
1740
# not present in the repo - dont try to set it deeper than the tip
1741
self.branch.set_revision_history([new_revision])
1744
def _write_basis_inventory(self, xml):
1745
"""Write the basis inventory XML to the basis-inventory file"""
1746
path = self._basis_inventory_name()
1748
self._control_files.put(path, sio)
1750
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1751
"""Create the text that will be saved in basis-inventory"""
1752
inventory.revision_id = revision_id
1753
return xml7.serializer_v7.write_inventory_to_string(inventory)
1755
def _cache_basis_inventory(self, new_revision):
1756
"""Cache new_revision as the basis inventory."""
1757
# TODO: this should allow the ready-to-use inventory to be passed in,
1758
# as commit already has that ready-to-use [while the format is the
1761
# this double handles the inventory - unpack and repack -
1762
# but is easier to understand. We can/should put a conditional
1763
# in here based on whether the inventory is in the latest format
1764
# - perhaps we should repack all inventories on a repository
1766
# the fast path is to copy the raw xml from the repository. If the
1767
# xml contains 'revision_id="', then we assume the right
1768
# revision_id is set. We must check for this full string, because a
1769
# root node id can legitimately look like 'revision_id' but cannot
1771
xml = self.branch.repository.get_inventory_xml(new_revision)
1772
firstline = xml.split('\n', 1)[0]
1773
if (not 'revision_id="' in firstline or
1774
'format="7"' not in firstline):
1775
inv = self.branch.repository.deserialise_inventory(
1777
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1778
self._write_basis_inventory(xml)
1779
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1782
def read_basis_inventory(self):
1783
"""Read the cached basis inventory."""
1784
path = self._basis_inventory_name()
1785
return self._control_files.get(path).read()
1788
def read_working_inventory(self):
1789
"""Read the working inventory.
1791
:raises errors.InventoryModified: read_working_inventory will fail
1792
when the current in memory inventory has been modified.
1794
# conceptually this should be an implementation detail of the tree.
1795
# XXX: Deprecate this.
1796
# ElementTree does its own conversion from UTF-8, so open in
1798
if self._inventory_is_modified:
1799
raise errors.InventoryModified(self)
1800
result = self._deserialize(self._control_files.get('inventory'))
1801
self._set_inventory(result, dirty=False)
1804
@needs_tree_write_lock
1805
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1807
"""Remove nominated files from the working inventory.
1809
:files: File paths relative to the basedir.
1810
:keep_files: If true, the files will also be kept.
1811
:force: Delete files and directories, even if they are changed and
1812
even if the directories are not empty.
1814
if isinstance(files, basestring):
1820
unknown_nested_files=set()
1822
def recurse_directory_to_add_files(directory):
1823
# Recurse directory and add all files
1824
# so we can check if they have changed.
1825
for parent_info, file_infos in\
1826
osutils.walkdirs(self.abspath(directory),
1828
for relpath, basename, kind, lstat, abspath in file_infos:
1829
# Is it versioned or ignored?
1830
if self.path2id(relpath) or self.is_ignored(relpath):
1831
# Add nested content for deletion.
1832
new_files.add(relpath)
1834
# Files which are not versioned and not ignored
1835
# should be treated as unknown.
1836
unknown_nested_files.add((relpath, None, kind))
1838
for filename in files:
1839
# Get file name into canonical form.
1840
abspath = self.abspath(filename)
1841
filename = self.relpath(abspath)
1842
if len(filename) > 0:
1843
new_files.add(filename)
1844
if osutils.isdir(abspath):
1845
recurse_directory_to_add_files(filename)
1847
files = list(new_files)
1850
return # nothing to do
1852
# Sort needed to first handle directory content before the directory
1853
files.sort(reverse=True)
1855
# Bail out if we are going to delete files we shouldn't
1856
if not keep_files and not force:
1857
has_changed_files = len(unknown_nested_files) > 0
1858
if not has_changed_files:
1859
for (file_id, path, content_change, versioned, parent_id, name,
1860
kind, executable) in self.iter_changes(self.basis_tree(),
1861
include_unchanged=True, require_versioned=False,
1862
want_unversioned=True, specific_files=files):
1863
if versioned == (False, False):
1864
# The record is unknown ...
1865
if not self.is_ignored(path[1]):
1866
# ... but not ignored
1867
has_changed_files = True
1869
elif content_change and (kind[1] is not None):
1870
# Versioned and changed, but not deleted
1871
has_changed_files = True
1874
if has_changed_files:
1875
# Make delta show ALL applicable changes in error message.
1876
tree_delta = self.changes_from(self.basis_tree(),
1877
require_versioned=False, want_unversioned=True,
1878
specific_files=files)
1879
for unknown_file in unknown_nested_files:
1880
if unknown_file not in tree_delta.unversioned:
1881
tree_delta.unversioned.extend((unknown_file,))
1882
raise errors.BzrRemoveChangedFilesError(tree_delta)
1884
# Build inv_delta and delete files where applicaple,
1885
# do this before any modifications to inventory.
1887
fid = self.path2id(f)
1890
message = "%s is not versioned." % (f,)
1893
# having removed it, it must be either ignored or unknown
1894
if self.is_ignored(f):
1898
textui.show_status(new_status, self.kind(fid), f,
1901
inv_delta.append((f, None, fid, None))
1902
message = "removed %s" % (f,)
1905
abs_path = self.abspath(f)
1906
if osutils.lexists(abs_path):
1907
if (osutils.isdir(abs_path) and
1908
len(os.listdir(abs_path)) > 0):
1910
osutils.rmtree(abs_path)
1912
message = "%s is not an empty directory "\
1913
"and won't be deleted." % (f,)
1915
osutils.delete_any(abs_path)
1916
message = "deleted %s" % (f,)
1917
elif message is not None:
1918
# Only care if we haven't done anything yet.
1919
message = "%s does not exist." % (f,)
1921
# Print only one message (if any) per file.
1922
if message is not None:
1924
self.apply_inventory_delta(inv_delta)
1926
@needs_tree_write_lock
1927
def revert(self, filenames=None, old_tree=None, backups=True,
1928
pb=DummyProgress(), report_changes=False):
1929
from bzrlib.conflicts import resolve
1932
symbol_versioning.warn('Using [] to revert all files is deprecated'
1933
' as of bzr 0.91. Please use None (the default) instead.',
1934
DeprecationWarning, stacklevel=2)
1935
if old_tree is None:
1936
basis_tree = self.basis_tree()
1937
basis_tree.lock_read()
1938
old_tree = basis_tree
1942
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1944
if filenames is None and len(self.get_parent_ids()) > 1:
1946
last_revision = self.last_revision()
1947
if last_revision != NULL_REVISION:
1948
if basis_tree is None:
1949
basis_tree = self.basis_tree()
1950
basis_tree.lock_read()
1951
parent_trees.append((last_revision, basis_tree))
1952
self.set_parent_trees(parent_trees)
1955
resolve(self, filenames, ignore_misses=True, recursive=True)
1957
if basis_tree is not None:
1961
def revision_tree(self, revision_id):
1962
"""See Tree.revision_tree.
1964
WorkingTree can supply revision_trees for the basis revision only
1965
because there is only one cached inventory in the bzr directory.
1967
if revision_id == self.last_revision():
1969
xml = self.read_basis_inventory()
1970
except errors.NoSuchFile:
1974
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1975
# dont use the repository revision_tree api because we want
1976
# to supply the inventory.
1977
if inv.revision_id == revision_id:
1978
return revisiontree.RevisionTree(self.branch.repository,
1980
except errors.BadInventoryFormat:
1982
# raise if there was no inventory, or if we read the wrong inventory.
1983
raise errors.NoSuchRevisionInTree(self, revision_id)
1985
# XXX: This method should be deprecated in favour of taking in a proper
1986
# new Inventory object.
1987
@needs_tree_write_lock
1988
def set_inventory(self, new_inventory_list):
1989
from bzrlib.inventory import (Inventory,
1994
inv = Inventory(self.get_root_id())
1995
for path, file_id, parent, kind in new_inventory_list:
1996
name = os.path.basename(path)
1999
# fixme, there should be a factory function inv,add_??
2000
if kind == 'directory':
2001
inv.add(InventoryDirectory(file_id, name, parent))
2002
elif kind == 'file':
2003
inv.add(InventoryFile(file_id, name, parent))
2004
elif kind == 'symlink':
2005
inv.add(InventoryLink(file_id, name, parent))
2007
raise errors.BzrError("unknown kind %r" % kind)
2008
self._write_inventory(inv)
2010
@needs_tree_write_lock
2011
def set_root_id(self, file_id):
2012
"""Set the root id for this tree."""
2016
'WorkingTree.set_root_id with fileid=None')
2017
file_id = osutils.safe_file_id(file_id)
2018
self._set_root_id(file_id)
2020
def _set_root_id(self, file_id):
2021
"""Set the root id for this tree, in a format specific manner.
2023
:param file_id: The file id to assign to the root. It must not be
2024
present in the current inventory or an error will occur. It must
2025
not be None, but rather a valid file id.
2027
inv = self._inventory
2028
orig_root_id = inv.root.file_id
2029
# TODO: it might be nice to exit early if there was nothing
2030
# to do, saving us from trigger a sync on unlock.
2031
self._inventory_is_modified = True
2032
# we preserve the root inventory entry object, but
2033
# unlinkit from the byid index
2034
del inv._byid[inv.root.file_id]
2035
inv.root.file_id = file_id
2036
# and link it into the index with the new changed id.
2037
inv._byid[inv.root.file_id] = inv.root
2038
# and finally update all children to reference the new id.
2039
# XXX: this should be safe to just look at the root.children
2040
# list, not the WHOLE INVENTORY.
2043
if entry.parent_id == orig_root_id:
2044
entry.parent_id = inv.root.file_id
2047
"""See Branch.unlock.
2049
WorkingTree locking just uses the Branch locking facilities.
2050
This is current because all working trees have an embedded branch
2051
within them. IF in the future, we were to make branch data shareable
2052
between multiple working trees, i.e. via shared storage, then we
2053
would probably want to lock both the local tree, and the branch.
2055
raise NotImplementedError(self.unlock)
2057
def update(self, change_reporter=None, possible_transports=None):
2058
"""Update a working tree along its branch.
2060
This will update the branch if its bound too, which means we have
2061
multiple trees involved:
2063
- The new basis tree of the master.
2064
- The old basis tree of the branch.
2065
- The old basis tree of the working tree.
2066
- The current working tree state.
2068
Pathologically, all three may be different, and non-ancestors of each
2069
other. Conceptually we want to:
2071
- Preserve the wt.basis->wt.state changes
2072
- Transform the wt.basis to the new master basis.
2073
- Apply a merge of the old branch basis to get any 'local' changes from
2075
- Restore the wt.basis->wt.state changes.
2077
There isn't a single operation at the moment to do that, so we:
2078
- Merge current state -> basis tree of the master w.r.t. the old tree
2080
- Do a 'normal' merge of the old branch basis if it is relevant.
2082
if self.branch.get_bound_location() is not None:
2084
update_branch = True
2086
self.lock_tree_write()
2087
update_branch = False
2090
old_tip = self.branch.update(possible_transports)
2093
return self._update_tree(old_tip, change_reporter)
2097
@needs_tree_write_lock
2098
def _update_tree(self, old_tip=None, change_reporter=None):
2099
"""Update a tree to the master branch.
2101
:param old_tip: if supplied, the previous tip revision the branch,
2102
before it was changed to the master branch's tip.
2104
# here if old_tip is not None, it is the old tip of the branch before
2105
# it was updated from the master branch. This should become a pending
2106
# merge in the working tree to preserve the user existing work. we
2107
# cant set that until we update the working trees last revision to be
2108
# one from the new branch, because it will just get absorbed by the
2109
# parent de-duplication logic.
2111
# We MUST save it even if an error occurs, because otherwise the users
2112
# local work is unreferenced and will appear to have been lost.
2116
last_rev = self.get_parent_ids()[0]
2118
last_rev = _mod_revision.NULL_REVISION
2119
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2120
# merge tree state up to new branch tip.
2121
basis = self.basis_tree()
2124
to_tree = self.branch.basis_tree()
2125
if basis.inventory.root is None:
2126
self.set_root_id(to_tree.get_root_id())
2128
result += merge.merge_inner(
2133
change_reporter=change_reporter)
2136
# TODO - dedup parents list with things merged by pull ?
2137
# reuse the tree we've updated to to set the basis:
2138
parent_trees = [(self.branch.last_revision(), to_tree)]
2139
merges = self.get_parent_ids()[1:]
2140
# Ideally we ask the tree for the trees here, that way the working
2141
# tree can decide whether to give us teh entire tree or give us a
2142
# lazy initialised tree. dirstate for instance will have the trees
2143
# in ram already, whereas a last-revision + basis-inventory tree
2144
# will not, but also does not need them when setting parents.
2145
for parent in merges:
2146
parent_trees.append(
2147
(parent, self.branch.repository.revision_tree(parent)))
2148
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2149
parent_trees.append(
2150
(old_tip, self.branch.repository.revision_tree(old_tip)))
2151
self.set_parent_trees(parent_trees)
2152
last_rev = parent_trees[0][0]
2154
# the working tree had the same last-revision as the master
2155
# branch did. We may still have pivot local work from the local
2156
# branch into old_tip:
2157
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2158
self.add_parent_tree_id(old_tip)
2159
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2160
and old_tip != last_rev):
2161
# our last revision was not the prior branch last revision
2162
# and we have converted that last revision to a pending merge.
2163
# base is somewhere between the branch tip now
2164
# and the now pending merge
2166
# Since we just modified the working tree and inventory, flush out
2167
# the current state, before we modify it again.
2168
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2169
# requires it only because TreeTransform directly munges the
2170
# inventory and calls tree._write_inventory(). Ultimately we
2171
# should be able to remove this extra flush.
2173
graph = self.branch.repository.get_graph()
2174
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2176
base_tree = self.branch.repository.revision_tree(base_rev_id)
2177
other_tree = self.branch.repository.revision_tree(old_tip)
2178
result += merge.merge_inner(
2183
change_reporter=change_reporter)
2186
def _write_hashcache_if_dirty(self):
2187
"""Write out the hashcache if it is dirty."""
2188
if self._hashcache.needs_write:
2190
self._hashcache.write()
2192
if e.errno not in (errno.EPERM, errno.EACCES):
2194
# TODO: jam 20061219 Should this be a warning? A single line
2195
# warning might be sufficient to let the user know what
2197
mutter('Could not write hashcache for %s\nError: %s',
2198
self._hashcache.cache_file_name(), e)
2200
@needs_tree_write_lock
2201
def _write_inventory(self, inv):
2202
"""Write inventory as the current inventory."""
2203
self._set_inventory(inv, dirty=True)
2206
def set_conflicts(self, arg):
2207
raise errors.UnsupportedOperation(self.set_conflicts, self)
2209
def add_conflicts(self, arg):
2210
raise errors.UnsupportedOperation(self.add_conflicts, self)
2213
def conflicts(self):
2214
conflicts = _mod_conflicts.ConflictList()
2215
for conflicted in self._iter_conflicts():
2218
if file_kind(self.abspath(conflicted)) != "file":
2220
except errors.NoSuchFile:
2223
for suffix in ('.THIS', '.OTHER'):
2225
kind = file_kind(self.abspath(conflicted+suffix))
2228
except errors.NoSuchFile:
2232
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2233
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2235
file_id=self.path2id(conflicted)))
2238
def walkdirs(self, prefix=""):
2239
"""Walk the directories of this tree.
2241
returns a generator which yields items in the form:
2242
((curren_directory_path, fileid),
2243
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2246
This API returns a generator, which is only valid during the current
2247
tree transaction - within a single lock_read or lock_write duration.
2249
If the tree is not locked, it may cause an error to be raised,
2250
depending on the tree implementation.
2252
disk_top = self.abspath(prefix)
2253
if disk_top.endswith('/'):
2254
disk_top = disk_top[:-1]
2255
top_strip_len = len(disk_top) + 1
2256
inventory_iterator = self._walkdirs(prefix)
2257
disk_iterator = osutils.walkdirs(disk_top, prefix)
2259
current_disk = disk_iterator.next()
2260
disk_finished = False
2262
if not (e.errno == errno.ENOENT or
2263
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2266
disk_finished = True
2268
current_inv = inventory_iterator.next()
2269
inv_finished = False
2270
except StopIteration:
2273
while not inv_finished or not disk_finished:
2275
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2276
cur_disk_dir_content) = current_disk
2278
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2279
cur_disk_dir_content) = ((None, None), None)
2280
if not disk_finished:
2281
# strip out .bzr dirs
2282
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2283
len(cur_disk_dir_content) > 0):
2284
# osutils.walkdirs can be made nicer -
2285
# yield the path-from-prefix rather than the pathjoined
2287
bzrdir_loc = bisect_left(cur_disk_dir_content,
2289
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2290
# we dont yield the contents of, or, .bzr itself.
2291
del cur_disk_dir_content[bzrdir_loc]
2293
# everything is unknown
2296
# everything is missing
2299
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2301
# disk is before inventory - unknown
2302
dirblock = [(relpath, basename, kind, stat, None, None) for
2303
relpath, basename, kind, stat, top_path in
2304
cur_disk_dir_content]
2305
yield (cur_disk_dir_relpath, None), dirblock
2307
current_disk = disk_iterator.next()
2308
except StopIteration:
2309
disk_finished = True
2311
# inventory is before disk - missing.
2312
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2313
for relpath, basename, dkind, stat, fileid, kind in
2315
yield (current_inv[0][0], current_inv[0][1]), dirblock
2317
current_inv = inventory_iterator.next()
2318
except StopIteration:
2321
# versioned present directory
2322
# merge the inventory and disk data together
2324
for relpath, subiterator in itertools.groupby(sorted(
2325
current_inv[1] + cur_disk_dir_content,
2326
key=operator.itemgetter(0)), operator.itemgetter(1)):
2327
path_elements = list(subiterator)
2328
if len(path_elements) == 2:
2329
inv_row, disk_row = path_elements
2330
# versioned, present file
2331
dirblock.append((inv_row[0],
2332
inv_row[1], disk_row[2],
2333
disk_row[3], inv_row[4],
2335
elif len(path_elements[0]) == 5:
2337
dirblock.append((path_elements[0][0],
2338
path_elements[0][1], path_elements[0][2],
2339
path_elements[0][3], None, None))
2340
elif len(path_elements[0]) == 6:
2341
# versioned, absent file.
2342
dirblock.append((path_elements[0][0],
2343
path_elements[0][1], 'unknown', None,
2344
path_elements[0][4], path_elements[0][5]))
2346
raise NotImplementedError('unreachable code')
2347
yield current_inv[0], dirblock
2349
current_inv = inventory_iterator.next()
2350
except StopIteration:
2353
current_disk = disk_iterator.next()
2354
except StopIteration:
2355
disk_finished = True
2357
def _walkdirs(self, prefix=""):
2358
"""Walk the directories of this tree.
2360
:prefix: is used as the directrory to start with.
2361
returns a generator which yields items in the form:
2362
((curren_directory_path, fileid),
2363
[(file1_path, file1_name, file1_kind, None, file1_id,
2366
_directory = 'directory'
2367
# get the root in the inventory
2368
inv = self.inventory
2369
top_id = inv.path2id(prefix)
2373
pending = [(prefix, '', _directory, None, top_id, None)]
2376
currentdir = pending.pop()
2377
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2378
top_id = currentdir[4]
2380
relroot = currentdir[0] + '/'
2383
# FIXME: stash the node in pending
2385
for name, child in entry.sorted_children():
2386
dirblock.append((relroot + name, name, child.kind, None,
2387
child.file_id, child.kind
2389
yield (currentdir[0], entry.file_id), dirblock
2390
# push the user specified dirs from dirblock
2391
for dir in reversed(dirblock):
2392
if dir[2] == _directory:
2395
@needs_tree_write_lock
2396
def auto_resolve(self):
2397
"""Automatically resolve text conflicts according to contents.
2399
Only text conflicts are auto_resolvable. Files with no conflict markers
2400
are considered 'resolved', because bzr always puts conflict markers
2401
into files that have text conflicts. The corresponding .THIS .BASE and
2402
.OTHER files are deleted, as per 'resolve'.
2403
:return: a tuple of ConflictLists: (un_resolved, resolved).
2405
un_resolved = _mod_conflicts.ConflictList()
2406
resolved = _mod_conflicts.ConflictList()
2407
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2408
for conflict in self.conflicts():
2409
if (conflict.typestring != 'text conflict' or
2410
self.kind(conflict.file_id) != 'file'):
2411
un_resolved.append(conflict)
2413
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2415
for line in my_file:
2416
if conflict_re.search(line):
2417
un_resolved.append(conflict)
2420
resolved.append(conflict)
2423
resolved.remove_files(self)
2424
self.set_conflicts(un_resolved)
2425
return un_resolved, resolved
2427
def _validate(self):
2428
"""Validate internal structures.
2430
This is meant mostly for the test suite. To give it a chance to detect
2431
corruption after actions have occurred. The default implementation is a
2434
:return: None. An exception should be raised if there is an error.
2439
class WorkingTree2(WorkingTree):
2440
"""This is the Format 2 working tree.
2442
This was the first weave based working tree.
2443
- uses os locks for locking.
2444
- uses the branch last-revision.
2447
def __init__(self, *args, **kwargs):
2448
super(WorkingTree2, self).__init__(*args, **kwargs)
2449
# WorkingTree2 has more of a constraint that self._inventory must
2450
# exist. Because this is an older format, we don't mind the overhead
2451
# caused by the extra computation here.
2453
# Newer WorkingTree's should only have self._inventory set when they
2455
if self._inventory is None:
2456
self.read_working_inventory()
2458
def lock_tree_write(self):
2459
"""See WorkingTree.lock_tree_write().
2461
In Format2 WorkingTrees we have a single lock for the branch and tree
2462
so lock_tree_write() degrades to lock_write().
2464
self.branch.lock_write()
2466
return self._control_files.lock_write()
2468
self.branch.unlock()
2472
# do non-implementation specific cleanup
2475
# we share control files:
2476
if self._control_files._lock_count == 3:
2477
# _inventory_is_modified is always False during a read lock.
2478
if self._inventory_is_modified:
2480
self._write_hashcache_if_dirty()
2482
# reverse order of locking.
2484
return self._control_files.unlock()
2486
self.branch.unlock()
2489
class WorkingTree3(WorkingTree):
2490
"""This is the Format 3 working tree.
2492
This differs from the base WorkingTree by:
2493
- having its own file lock
2494
- having its own last-revision property.
2496
This is new in bzr 0.8
2500
def _last_revision(self):
2501
"""See Mutable.last_revision."""
2503
return self._control_files.get('last-revision').read()
2504
except errors.NoSuchFile:
2505
return _mod_revision.NULL_REVISION
2507
def _change_last_revision(self, revision_id):
2508
"""See WorkingTree._change_last_revision."""
2509
if revision_id is None or revision_id == NULL_REVISION:
2511
self._control_files._transport.delete('last-revision')
2512
except errors.NoSuchFile:
2516
self._control_files.put_bytes('last-revision', revision_id)
2519
@needs_tree_write_lock
2520
def set_conflicts(self, conflicts):
2521
self._put_rio('conflicts', conflicts.to_stanzas(),
2524
@needs_tree_write_lock
2525
def add_conflicts(self, new_conflicts):
2526
conflict_set = set(self.conflicts())
2527
conflict_set.update(set(list(new_conflicts)))
2528
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2529
key=_mod_conflicts.Conflict.sort_key)))
2532
def conflicts(self):
2534
confile = self._control_files.get('conflicts')
2535
except errors.NoSuchFile:
2536
return _mod_conflicts.ConflictList()
2538
if confile.next() != CONFLICT_HEADER_1 + '\n':
2539
raise errors.ConflictFormatError()
2540
except StopIteration:
2541
raise errors.ConflictFormatError()
2542
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2545
# do non-implementation specific cleanup
2547
if self._control_files._lock_count == 1:
2548
# _inventory_is_modified is always False during a read lock.
2549
if self._inventory_is_modified:
2551
self._write_hashcache_if_dirty()
2552
# reverse order of locking.
2554
return self._control_files.unlock()
2556
self.branch.unlock()
2559
def get_conflicted_stem(path):
2560
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2561
if path.endswith(suffix):
2562
return path[:-len(suffix)]
2565
class WorkingTreeFormat(object):
2566
"""An encapsulation of the initialization and open routines for a format.
2568
Formats provide three things:
2569
* An initialization routine,
2573
Formats are placed in an dict by their format string for reference
2574
during workingtree opening. Its not required that these be instances, they
2575
can be classes themselves with class methods - it simply depends on
2576
whether state is needed for a given format or not.
2578
Once a format is deprecated, just deprecate the initialize and open
2579
methods on the format class. Do not deprecate the object, as the
2580
object will be created every time regardless.
2583
_default_format = None
2584
"""The default format used for new trees."""
2587
"""The known formats."""
2589
requires_rich_root = False
2591
upgrade_recommended = False
2594
def find_format(klass, a_bzrdir):
2595
"""Return the format for the working tree object in a_bzrdir."""
2597
transport = a_bzrdir.get_workingtree_transport(None)
2598
format_string = transport.get("format").read()
2599
return klass._formats[format_string]
2600
except errors.NoSuchFile:
2601
raise errors.NoWorkingTree(base=transport.base)
2603
raise errors.UnknownFormatError(format=format_string,
2604
kind="working tree")
2606
def __eq__(self, other):
2607
return self.__class__ is other.__class__
2609
def __ne__(self, other):
2610
return not (self == other)
2613
def get_default_format(klass):
2614
"""Return the current default format."""
2615
return klass._default_format
2617
def get_format_string(self):
2618
"""Return the ASCII format string that identifies this format."""
2619
raise NotImplementedError(self.get_format_string)
2621
def get_format_description(self):
2622
"""Return the short description for this format."""
2623
raise NotImplementedError(self.get_format_description)
2625
def is_supported(self):
2626
"""Is this format supported?
2628
Supported formats can be initialized and opened.
2629
Unsupported formats may not support initialization or committing or
2630
some other features depending on the reason for not being supported.
2635
def register_format(klass, format):
2636
klass._formats[format.get_format_string()] = format
2639
def set_default_format(klass, format):
2640
klass._default_format = format
2643
def unregister_format(klass, format):
2644
del klass._formats[format.get_format_string()]
2647
class WorkingTreeFormat2(WorkingTreeFormat):
2648
"""The second working tree format.
2650
This format modified the hash cache from the format 1 hash cache.
2653
upgrade_recommended = True
2655
def get_format_description(self):
2656
"""See WorkingTreeFormat.get_format_description()."""
2657
return "Working tree format 2"
2659
def stub_initialize_remote(self, control_files):
2660
"""As a special workaround create critical control files for a remote working tree
2662
This ensures that it can later be updated and dealt with locally,
2663
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2664
no working tree. (See bug #43064).
2668
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2670
control_files.put('inventory', sio)
2672
control_files.put_bytes('pending-merges', '')
2675
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2676
accelerator_tree=None, hardlink=False):
2677
"""See WorkingTreeFormat.initialize()."""
2678
if not isinstance(a_bzrdir.transport, LocalTransport):
2679
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2680
if from_branch is not None:
2681
branch = from_branch
2683
branch = a_bzrdir.open_branch()
2684
if revision_id is None:
2685
revision_id = _mod_revision.ensure_null(branch.last_revision())
2688
branch.generate_revision_history(revision_id)
2692
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2698
basis_tree = branch.repository.revision_tree(revision_id)
2699
if basis_tree.inventory.root is not None:
2700
wt.set_root_id(basis_tree.get_root_id())
2701
# set the parent list and cache the basis tree.
2702
if _mod_revision.is_null(revision_id):
2705
parent_trees = [(revision_id, basis_tree)]
2706
wt.set_parent_trees(parent_trees)
2707
transform.build_tree(basis_tree, wt)
2711
super(WorkingTreeFormat2, self).__init__()
2712
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2714
def open(self, a_bzrdir, _found=False):
2715
"""Return the WorkingTree object for a_bzrdir
2717
_found is a private parameter, do not use it. It is used to indicate
2718
if format probing has already been done.
2721
# we are being called directly and must probe.
2722
raise NotImplementedError
2723
if not isinstance(a_bzrdir.transport, LocalTransport):
2724
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2725
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2731
class WorkingTreeFormat3(WorkingTreeFormat):
2732
"""The second working tree format updated to record a format marker.
2735
- exists within a metadir controlling .bzr
2736
- includes an explicit version marker for the workingtree control
2737
files, separate from the BzrDir format
2738
- modifies the hash cache format
2740
- uses a LockDir to guard access for writes.
2743
upgrade_recommended = True
2745
def get_format_string(self):
2746
"""See WorkingTreeFormat.get_format_string()."""
2747
return "Bazaar-NG Working Tree format 3"
2749
def get_format_description(self):
2750
"""See WorkingTreeFormat.get_format_description()."""
2751
return "Working tree format 3"
2753
_lock_file_name = 'lock'
2754
_lock_class = LockDir
2756
_tree_class = WorkingTree3
2758
def __get_matchingbzrdir(self):
2759
return bzrdir.BzrDirMetaFormat1()
2761
_matchingbzrdir = property(__get_matchingbzrdir)
2763
def _open_control_files(self, a_bzrdir):
2764
transport = a_bzrdir.get_workingtree_transport(None)
2765
return LockableFiles(transport, self._lock_file_name,
2768
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2769
accelerator_tree=None, hardlink=False):
2770
"""See WorkingTreeFormat.initialize().
2772
:param revision_id: if supplied, create a working tree at a different
2773
revision than the branch is at.
2774
:param accelerator_tree: A tree which can be used for retrieving file
2775
contents more quickly than the revision tree, i.e. a workingtree.
2776
The revision tree will be used for cases where accelerator_tree's
2777
content is different.
2778
:param hardlink: If true, hard-link files from accelerator_tree,
2781
if not isinstance(a_bzrdir.transport, LocalTransport):
2782
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2783
transport = a_bzrdir.get_workingtree_transport(self)
2784
control_files = self._open_control_files(a_bzrdir)
2785
control_files.create_lock()
2786
control_files.lock_write()
2787
control_files.put_utf8('format', self.get_format_string())
2788
if from_branch is not None:
2789
branch = from_branch
2791
branch = a_bzrdir.open_branch()
2792
if revision_id is None:
2793
revision_id = _mod_revision.ensure_null(branch.last_revision())
2794
# WorkingTree3 can handle an inventory which has a unique root id.
2795
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2796
# those trees. And because there isn't a format bump inbetween, we
2797
# are maintaining compatibility with older clients.
2798
# inv = Inventory(root_id=gen_root_id())
2799
inv = self._initial_inventory()
2800
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2806
_control_files=control_files)
2807
wt.lock_tree_write()
2809
basis_tree = branch.repository.revision_tree(revision_id)
2810
# only set an explicit root id if there is one to set.
2811
if basis_tree.inventory.root is not None:
2812
wt.set_root_id(basis_tree.get_root_id())
2813
if revision_id == NULL_REVISION:
2814
wt.set_parent_trees([])
2816
wt.set_parent_trees([(revision_id, basis_tree)])
2817
transform.build_tree(basis_tree, wt)
2819
# Unlock in this order so that the unlock-triggers-flush in
2820
# WorkingTree is given a chance to fire.
2821
control_files.unlock()
2825
def _initial_inventory(self):
2829
super(WorkingTreeFormat3, self).__init__()
2831
def open(self, a_bzrdir, _found=False):
2832
"""Return the WorkingTree object for a_bzrdir
2834
_found is a private parameter, do not use it. It is used to indicate
2835
if format probing has already been done.
2838
# we are being called directly and must probe.
2839
raise NotImplementedError
2840
if not isinstance(a_bzrdir.transport, LocalTransport):
2841
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2842
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2845
def _open(self, a_bzrdir, control_files):
2846
"""Open the tree itself.
2848
:param a_bzrdir: the dir for the tree.
2849
:param control_files: the control files for the tree.
2851
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2855
_control_files=control_files)
2858
return self.get_format_string()
2861
__default_format = WorkingTreeFormat4()
2862
WorkingTreeFormat.register_format(__default_format)
2863
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2864
WorkingTreeFormat.set_default_format(__default_format)
2865
# formats which have no format string are not discoverable
2866
# and not independently creatable, so are not registered.
2867
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
