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()
250
def _detect_case_handling(self):
251
wt_trans = self.bzrdir.get_workingtree_transport(None)
253
wt_trans.stat("FoRMaT")
254
except errors.NoSuchFile:
255
self.case_sensitive = True
257
self.case_sensitive = False
259
self._setup_directory_is_tree_reference()
262
fget=lambda self: self._branch,
263
doc="""The branch this WorkingTree is connected to.
265
This cannot be set - it is reflective of the actual disk structure
266
the working tree has been constructed from.
269
def break_lock(self):
270
"""Break a lock if one is present from another instance.
272
Uses the ui factory to ask for confirmation if the lock may be from
275
This will probe the repository for its lock as well.
277
self._control_files.break_lock()
278
self.branch.break_lock()
280
def requires_rich_root(self):
281
return self._format.requires_rich_root
283
def supports_tree_reference(self):
286
def _set_inventory(self, inv, dirty):
287
"""Set the internal cached inventory.
289
:param inv: The inventory to set.
290
:param dirty: A boolean indicating whether the inventory is the same
291
logical inventory as whats on disk. If True the inventory is not
292
the same and should be written to disk or data will be lost, if
293
False then the inventory is the same as that on disk and any
294
serialisation would be unneeded overhead.
296
self._inventory = inv
297
self._inventory_is_modified = dirty
300
def open(path=None, _unsupported=False):
301
"""Open an existing working tree at path.
305
path = os.path.getcwdu()
306
control = bzrdir.BzrDir.open(path, _unsupported)
307
return control.open_workingtree(_unsupported)
310
def open_containing(path=None):
311
"""Open an existing working tree which has its root about path.
313
This probes for a working tree at path and searches upwards from there.
315
Basically we keep looking up until we find the control directory or
316
run into /. If there isn't one, raises NotBranchError.
317
TODO: give this a new exception.
318
If there is one, it is returned, along with the unused portion of path.
320
:return: The WorkingTree that contains 'path', and the rest of path
323
path = osutils.getcwd()
324
control, relpath = bzrdir.BzrDir.open_containing(path)
326
return control.open_workingtree(), relpath
329
def open_downlevel(path=None):
330
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
334
return WorkingTree.open(path, _unsupported=True)
337
def find_trees(location):
338
def list_current(transport):
339
return [d for d in transport.list_dir('') if d != '.bzr']
340
def evaluate(bzrdir):
342
tree = bzrdir.open_workingtree()
343
except errors.NoWorkingTree:
347
transport = get_transport(location)
348
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
349
list_current=list_current)
350
return [t for t in iterator if t is not None]
352
# should be deprecated - this is slow and in any case treating them as a
353
# container is (we now know) bad style -- mbp 20070302
354
## @deprecated_method(zero_fifteen)
356
"""Iterate through file_ids for this tree.
358
file_ids are in a WorkingTree if they are in the working inventory
359
and the working file exists.
361
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if osutils.lexists(self.abspath(path)):
366
def all_file_ids(self):
367
"""See Tree.iter_all_file_ids"""
368
return set(self.inventory)
371
return "<%s of %s>" % (self.__class__.__name__,
372
getattr(self, 'basedir', None))
374
def abspath(self, filename):
375
return pathjoin(self.basedir, filename)
377
def basis_tree(self):
378
"""Return RevisionTree for the current last revision.
380
If the left most parent is a ghost then the returned tree will be an
381
empty tree - one obtained by calling repository.revision_tree(None).
384
revision_id = self.get_parent_ids()[0]
386
# no parents, return an empty revision tree.
387
# in the future this should return the tree for
388
# 'empty:' - the implicit root empty tree.
389
return self.branch.repository.revision_tree(None)
391
return self.revision_tree(revision_id)
392
except errors.NoSuchRevision:
394
# No cached copy available, retrieve from the repository.
395
# FIXME? RBC 20060403 should we cache the inventory locally
398
return self.branch.repository.revision_tree(revision_id)
399
except errors.RevisionNotPresent:
400
# the basis tree *may* be a ghost or a low level error may have
401
# occured. If the revision is present, its a problem, if its not
403
if self.branch.repository.has_revision(revision_id):
405
# the basis tree is a ghost so return an empty tree.
406
return self.branch.repository.revision_tree(None)
409
self._flush_ignore_list_cache()
411
def relpath(self, path):
412
"""Return the local path portion from a given path.
414
The path may be absolute or relative. If its a relative path it is
415
interpreted relative to the python current working directory.
417
return osutils.relpath(self.basedir, path)
419
def has_filename(self, filename):
420
return osutils.lexists(self.abspath(filename))
422
def get_file(self, file_id, path=None):
424
path = self.id2path(file_id)
425
return self.get_file_byname(path)
427
def get_file_text(self, file_id):
428
return self.get_file(file_id).read()
430
def get_file_byname(self, filename):
431
return file(self.abspath(filename), 'rb')
434
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
435
"""See Tree.annotate_iter
437
This implementation will use the basis tree implementation if possible.
438
Lines not in the basis are attributed to CURRENT_REVISION
440
If there are pending merges, lines added by those merges will be
441
incorrectly attributed to CURRENT_REVISION (but after committing, the
442
attribution will be correct).
444
basis = self.basis_tree()
447
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
448
require_versioned=True).next()
449
changed_content, kind = changes[2], changes[6]
450
if not changed_content:
451
return basis.annotate_iter(file_id)
455
if kind[0] != 'file':
458
old_lines = list(basis.annotate_iter(file_id))
460
for tree in self.branch.repository.revision_trees(
461
self.get_parent_ids()[1:]):
462
if file_id not in tree:
464
old.append(list(tree.annotate_iter(file_id)))
465
return annotate.reannotate(old, self.get_file(file_id).readlines(),
470
def _get_ancestors(self, default_revision):
471
ancestors = set([default_revision])
472
for parent_id in self.get_parent_ids():
473
ancestors.update(self.branch.repository.get_ancestry(
474
parent_id, topo_sorted=False))
477
def get_parent_ids(self):
478
"""See Tree.get_parent_ids.
480
This implementation reads the pending merges list and last_revision
481
value and uses that to decide what the parents list should be.
483
last_rev = _mod_revision.ensure_null(self._last_revision())
484
if _mod_revision.NULL_REVISION == last_rev:
489
merges_file = self._transport.get('pending-merges')
490
except errors.NoSuchFile:
493
for l in merges_file.readlines():
494
revision_id = l.rstrip('\n')
495
parents.append(revision_id)
499
def get_root_id(self):
500
"""Return the id of this trees root"""
501
return self._inventory.root.file_id
503
def _get_store_filename(self, file_id):
504
## XXX: badly named; this is not in the store at all
505
return self.abspath(self.id2path(file_id))
508
def clone(self, to_bzrdir, revision_id=None):
509
"""Duplicate this working tree into to_bzr, including all state.
511
Specifically modified files are kept as modified, but
512
ignored and unknown files are discarded.
514
If you want to make a new line of development, see bzrdir.sprout()
517
If not None, the cloned tree will have its last revision set to
518
revision, and and difference between the source trees last revision
519
and this one merged in.
521
# assumes the target bzr dir format is compatible.
522
result = self._format.initialize(to_bzrdir)
523
self.copy_content_into(result, revision_id)
527
def copy_content_into(self, tree, revision_id=None):
528
"""Copy the current content and user files of this tree into tree."""
529
tree.set_root_id(self.get_root_id())
530
if revision_id is None:
531
merge.transform_tree(tree, self)
533
# TODO now merge from tree.last_revision to revision (to preserve
534
# user local changes)
535
merge.transform_tree(tree, self)
536
tree.set_parent_ids([revision_id])
538
def id2abspath(self, file_id):
539
return self.abspath(self.id2path(file_id))
541
def has_id(self, file_id):
542
# files that have been deleted are excluded
544
if not inv.has_id(file_id):
546
path = inv.id2path(file_id)
547
return osutils.lexists(self.abspath(path))
549
def has_or_had_id(self, file_id):
550
if file_id == self.inventory.root.file_id:
552
return self.inventory.has_id(file_id)
554
__contains__ = has_id
556
def get_file_size(self, file_id):
557
"""See Tree.get_file_size"""
559
return os.path.getsize(self.id2abspath(file_id))
561
if e.errno != errno.ENOENT:
567
def get_file_sha1(self, file_id, path=None, stat_value=None):
569
path = self._inventory.id2path(file_id)
570
return self._hashcache.get_sha1(path, stat_value)
572
def get_file_mtime(self, file_id, path=None):
574
path = self.inventory.id2path(file_id)
575
return os.lstat(self.abspath(path)).st_mtime
577
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
578
file_id = self.path2id(path)
579
return self._inventory[file_id].executable
581
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
582
mode = stat_result.st_mode
583
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
if not supports_executable():
586
def is_executable(self, file_id, path=None):
587
return self._inventory[file_id].executable
589
_is_executable_from_path_and_stat = \
590
_is_executable_from_path_and_stat_from_basis
592
def is_executable(self, file_id, path=None):
594
path = self.id2path(file_id)
595
mode = os.lstat(self.abspath(path)).st_mode
596
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
598
_is_executable_from_path_and_stat = \
599
_is_executable_from_path_and_stat_from_stat
601
@needs_tree_write_lock
602
def _add(self, files, ids, kinds):
603
"""See MutableTree._add."""
604
# TODO: Re-adding a file that is removed in the working copy
605
# should probably put it back with the previous ID.
606
# the read and write working inventory should not occur in this
607
# function - they should be part of lock_write and unlock.
609
for f, file_id, kind in zip(files, ids, kinds):
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
614
self._inventory_is_modified = True
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
667
def add_pending_merge(self, *revision_ids):
668
# TODO: Perhaps should check at this point that the
669
# history of the revision is actually present?
670
parents = self.get_parent_ids()
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
def path_content_summary(self, path, _lstat=os.lstat,
681
_mapper=osutils.file_kind_from_stat_mode):
682
"""See Tree.path_content_summary."""
683
abspath = self.abspath(path)
685
stat_result = _lstat(abspath)
687
if getattr(e, 'errno', None) == errno.ENOENT:
689
return ('missing', None, None, None)
690
# propagate other errors
692
kind = _mapper(stat_result.st_mode)
694
size = stat_result.st_size
695
# try for a stat cache lookup
696
executable = self._is_executable_from_path_and_stat(path, stat_result)
697
return (kind, size, executable, self._sha_from_stat(
699
elif kind == 'directory':
700
# perhaps it looks like a plain directory, but it's really a
702
if self._directory_is_tree_reference(path):
703
kind = 'tree-reference'
704
return kind, None, None, None
705
elif kind == 'symlink':
706
return ('symlink', None, None, os.readlink(abspath))
708
return (kind, None, None, None)
710
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
711
"""Common ghost checking functionality from set_parent_*.
713
This checks that the left hand-parent exists if there are any
716
if len(revision_ids) > 0:
717
leftmost_id = revision_ids[0]
718
if (not allow_leftmost_as_ghost and not
719
self.branch.repository.has_revision(leftmost_id)):
720
raise errors.GhostRevisionUnusableHere(leftmost_id)
722
def _set_merges_from_parent_ids(self, parent_ids):
723
merges = parent_ids[1:]
724
self._transport.put_bytes('pending-merges', '\n'.join(merges),
725
mode=self._control_files._file_mode)
727
@needs_tree_write_lock
728
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
729
"""Set the parent ids to revision_ids.
731
See also set_parent_trees. This api will try to retrieve the tree data
732
for each element of revision_ids from the trees repository. If you have
733
tree data already available, it is more efficient to use
734
set_parent_trees rather than set_parent_ids. set_parent_ids is however
735
an easier API to use.
737
:param revision_ids: The revision_ids to set as the parent ids of this
738
working tree. Any of these may be ghosts.
740
self._check_parents_for_ghosts(revision_ids,
741
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
for revision_id in revision_ids:
743
_mod_revision.check_not_reserved_id(revision_id)
745
if len(revision_ids) > 0:
746
self.set_last_revision(revision_ids[0])
748
self.set_last_revision(_mod_revision.NULL_REVISION)
750
self._set_merges_from_parent_ids(revision_ids)
752
@needs_tree_write_lock
753
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
754
"""See MutableTree.set_parent_trees."""
755
parent_ids = [rev for (rev, tree) in parents_list]
756
for revision_id in parent_ids:
757
_mod_revision.check_not_reserved_id(revision_id)
759
self._check_parents_for_ghosts(parent_ids,
760
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
762
if len(parent_ids) == 0:
763
leftmost_parent_id = _mod_revision.NULL_REVISION
764
leftmost_parent_tree = None
766
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
768
if self._change_last_revision(leftmost_parent_id):
769
if leftmost_parent_tree is None:
770
# If we don't have a tree, fall back to reading the
771
# parent tree from the repository.
772
self._cache_basis_inventory(leftmost_parent_id)
774
inv = leftmost_parent_tree.inventory
775
xml = self._create_basis_xml_from_inventory(
776
leftmost_parent_id, inv)
777
self._write_basis_inventory(xml)
778
self._set_merges_from_parent_ids(parent_ids)
780
@needs_tree_write_lock
781
def set_pending_merges(self, rev_list):
782
parents = self.get_parent_ids()
783
leftmost = parents[:1]
784
new_parents = leftmost + rev_list
785
self.set_parent_ids(new_parents)
787
@needs_tree_write_lock
788
def set_merge_modified(self, modified_hashes):
790
for file_id, hash in modified_hashes.iteritems():
791
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
792
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
794
def _sha_from_stat(self, path, stat_result):
795
"""Get a sha digest from the tree's stat cache.
797
The default implementation assumes no stat cache is present.
799
:param path: The path.
800
:param stat_result: The stat result being looked up.
804
def _put_rio(self, filename, stanzas, header):
805
self._must_be_locked()
806
my_file = rio_file(stanzas, header)
807
self._transport.put_file(filename, my_file,
808
mode=self._control_files._file_mode)
810
@needs_write_lock # because merge pulls data into the branch.
811
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
813
"""Merge from a branch into this working tree.
815
:param branch: The branch to merge from.
816
:param to_revision: If non-None, the merge will merge to to_revision,
817
but not beyond it. to_revision does not need to be in the history
818
of the branch when it is supplied. If None, to_revision defaults to
819
branch.last_revision().
821
from bzrlib.merge import Merger, Merge3Merger
822
pb = bzrlib.ui.ui_factory.nested_progress_bar()
824
merger = Merger(self.branch, this_tree=self, pb=pb)
825
merger.pp = ProgressPhase("Merge phase", 5, pb)
826
merger.pp.next_phase()
827
# check that there are no
829
merger.check_basis(check_clean=True, require_commits=False)
830
if to_revision is None:
831
to_revision = _mod_revision.ensure_null(branch.last_revision())
832
merger.other_rev_id = to_revision
833
if _mod_revision.is_null(merger.other_rev_id):
834
raise errors.NoCommits(branch)
835
self.branch.fetch(branch, last_revision=merger.other_rev_id)
836
merger.other_basis = merger.other_rev_id
837
merger.other_tree = self.branch.repository.revision_tree(
839
merger.other_branch = branch
840
merger.pp.next_phase()
841
if from_revision is None:
844
merger.set_base_revision(from_revision, branch)
845
if merger.base_rev_id == merger.other_rev_id:
846
raise errors.PointlessMerge
847
merger.backup_files = False
848
if merge_type is None:
849
merger.merge_type = Merge3Merger
851
merger.merge_type = merge_type
852
merger.set_interesting_files(None)
853
merger.show_base = False
854
merger.reprocess = False
855
conflicts = merger.do_merge()
862
def merge_modified(self):
863
"""Return a dictionary of files modified by a merge.
865
The list is initialized by WorkingTree.set_merge_modified, which is
866
typically called after we make some automatic updates to the tree
869
This returns a map of file_id->sha1, containing only files which are
870
still in the working inventory and have that text hash.
873
hashfile = self._transport.get('merge-hashes')
874
except errors.NoSuchFile:
878
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
879
raise errors.MergeModifiedFormatError()
880
except StopIteration:
881
raise errors.MergeModifiedFormatError()
882
for s in RioReader(hashfile):
883
# RioReader reads in Unicode, so convert file_ids back to utf8
884
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
885
if file_id not in self.inventory:
887
text_hash = s.get("hash")
888
if text_hash == self.get_file_sha1(file_id):
889
merge_hashes[file_id] = text_hash
893
def mkdir(self, path, file_id=None):
894
"""See MutableTree.mkdir()."""
896
file_id = generate_ids.gen_file_id(os.path.basename(path))
897
os.mkdir(self.abspath(path))
898
self.add(path, file_id, 'directory')
901
def get_symlink_target(self, file_id):
902
return os.readlink(self.id2abspath(file_id))
905
def subsume(self, other_tree):
906
def add_children(inventory, entry):
907
for child_entry in entry.children.values():
908
inventory._byid[child_entry.file_id] = child_entry
909
if child_entry.kind == 'directory':
910
add_children(inventory, child_entry)
911
if other_tree.get_root_id() == self.get_root_id():
912
raise errors.BadSubsumeSource(self, other_tree,
913
'Trees have the same root')
915
other_tree_path = self.relpath(other_tree.basedir)
916
except errors.PathNotChild:
917
raise errors.BadSubsumeSource(self, other_tree,
918
'Tree is not contained by the other')
919
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
920
if new_root_parent is None:
921
raise errors.BadSubsumeSource(self, other_tree,
922
'Parent directory is not versioned.')
923
# We need to ensure that the result of a fetch will have a
924
# versionedfile for the other_tree root, and only fetching into
925
# RepositoryKnit2 guarantees that.
926
if not self.branch.repository.supports_rich_root():
927
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
928
other_tree.lock_tree_write()
930
new_parents = other_tree.get_parent_ids()
931
other_root = other_tree.inventory.root
932
other_root.parent_id = new_root_parent
933
other_root.name = osutils.basename(other_tree_path)
934
self.inventory.add(other_root)
935
add_children(self.inventory, other_root)
936
self._write_inventory(self.inventory)
937
# normally we don't want to fetch whole repositories, but i think
938
# here we really do want to consolidate the whole thing.
939
for parent_id in other_tree.get_parent_ids():
940
self.branch.fetch(other_tree.branch, parent_id)
941
self.add_parent_tree_id(parent_id)
944
other_tree.bzrdir.retire_bzrdir()
946
def _setup_directory_is_tree_reference(self):
947
if self._branch.repository._format.supports_tree_reference:
948
self._directory_is_tree_reference = \
949
self._directory_may_be_tree_reference
951
self._directory_is_tree_reference = \
952
self._directory_is_never_tree_reference
954
def _directory_is_never_tree_reference(self, relpath):
957
def _directory_may_be_tree_reference(self, relpath):
958
# as a special case, if a directory contains control files then
959
# it's a tree reference, except that the root of the tree is not
960
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
961
# TODO: We could ask all the control formats whether they
962
# recognize this directory, but at the moment there's no cheap api
963
# to do that. Since we probably can only nest bzr checkouts and
964
# they always use this name it's ok for now. -- mbp 20060306
966
# FIXME: There is an unhandled case here of a subdirectory
967
# containing .bzr but not a branch; that will probably blow up
968
# when you try to commit it. It might happen if there is a
969
# checkout in a subdirectory. This can be avoided by not adding
972
@needs_tree_write_lock
973
def extract(self, file_id, format=None):
974
"""Extract a subtree from this tree.
976
A new branch will be created, relative to the path for this tree.
980
segments = osutils.splitpath(path)
981
transport = self.branch.bzrdir.root_transport
982
for name in segments:
983
transport = transport.clone(name)
984
transport.ensure_base()
987
sub_path = self.id2path(file_id)
988
branch_transport = mkdirs(sub_path)
990
format = self.bzrdir.cloning_metadir()
991
branch_transport.ensure_base()
992
branch_bzrdir = format.initialize_on_transport(branch_transport)
994
repo = branch_bzrdir.find_repository()
995
except errors.NoRepositoryPresent:
996
repo = branch_bzrdir.create_repository()
997
if not repo.supports_rich_root():
998
raise errors.RootNotRich()
999
new_branch = branch_bzrdir.create_branch()
1000
new_branch.pull(self.branch)
1001
for parent_id in self.get_parent_ids():
1002
new_branch.fetch(self.branch, parent_id)
1003
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1004
if tree_transport.base != branch_transport.base:
1005
tree_bzrdir = format.initialize_on_transport(tree_transport)
1006
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1008
tree_bzrdir = branch_bzrdir
1009
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1010
wt.set_parent_ids(self.get_parent_ids())
1011
my_inv = self.inventory
1012
child_inv = Inventory(root_id=None)
1013
new_root = my_inv[file_id]
1014
my_inv.remove_recursive_id(file_id)
1015
new_root.parent_id = None
1016
child_inv.add(new_root)
1017
self._write_inventory(my_inv)
1018
wt._write_inventory(child_inv)
1021
def _serialize(self, inventory, out_file):
1022
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1025
def _deserialize(selt, in_file):
1026
return xml5.serializer_v5.read_inventory(in_file)
1029
"""Write the in memory inventory to disk."""
1030
# TODO: Maybe this should only write on dirty ?
1031
if self._control_files._lock_mode != 'w':
1032
raise errors.NotWriteLocked(self)
1034
self._serialize(self._inventory, sio)
1036
self._transport.put_file('inventory', sio,
1037
mode=self._control_files._file_mode)
1038
self._inventory_is_modified = False
1040
def _kind(self, relpath):
1041
return osutils.file_kind(self.abspath(relpath))
1043
def list_files(self, include_root=False):
1044
"""Recursively list all files as (path, class, kind, id, entry).
1046
Lists, but does not descend into unversioned directories.
1048
This does not include files that have been deleted in this
1051
Skips the control directory.
1053
# list_files is an iterator, so @needs_read_lock doesn't work properly
1054
# with it. So callers should be careful to always read_lock the tree.
1055
if not self.is_locked():
1056
raise errors.ObjectNotLocked(self)
1058
inv = self.inventory
1059
if include_root is True:
1060
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1061
# Convert these into local objects to save lookup times
1062
pathjoin = osutils.pathjoin
1063
file_kind = self._kind
1065
# transport.base ends in a slash, we want the piece
1066
# between the last two slashes
1067
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1069
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1071
# directory file_id, relative path, absolute path, reverse sorted children
1072
children = os.listdir(self.basedir)
1074
# jam 20060527 The kernel sized tree seems equivalent whether we
1075
# use a deque and popleft to keep them sorted, or if we use a plain
1076
# list and just reverse() them.
1077
children = collections.deque(children)
1078
stack = [(inv.root.file_id, u'', self.basedir, children)]
1080
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1083
f = children.popleft()
1084
## TODO: If we find a subdirectory with its own .bzr
1085
## directory, then that is a separate tree and we
1086
## should exclude it.
1088
# the bzrdir for this tree
1089
if transport_base_dir == f:
1092
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1093
# and 'f' doesn't begin with one, we can do a string op, rather
1094
# than the checks of pathjoin(), all relative paths will have an extra slash
1096
fp = from_dir_relpath + '/' + f
1099
fap = from_dir_abspath + '/' + f
1101
f_ie = inv.get_child(from_dir_id, f)
1104
elif self.is_ignored(fp[1:]):
1107
# we may not have found this file, because of a unicode issue
1108
f_norm, can_access = osutils.normalized_filename(f)
1109
if f == f_norm or not can_access:
1110
# No change, so treat this file normally
1113
# this file can be accessed by a normalized path
1114
# check again if it is versioned
1115
# these lines are repeated here for performance
1117
fp = from_dir_relpath + '/' + f
1118
fap = from_dir_abspath + '/' + f
1119
f_ie = inv.get_child(from_dir_id, f)
1122
elif self.is_ignored(fp[1:]):
1129
# make a last minute entry
1131
yield fp[1:], c, fk, f_ie.file_id, f_ie
1134
yield fp[1:], c, fk, None, fk_entries[fk]()
1136
yield fp[1:], c, fk, None, TreeEntry()
1139
if fk != 'directory':
1142
# But do this child first
1143
new_children = os.listdir(fap)
1145
new_children = collections.deque(new_children)
1146
stack.append((f_ie.file_id, fp, fap, new_children))
1147
# Break out of inner loop,
1148
# so that we start outer loop with child
1151
# if we finished all children, pop it off the stack
1154
@needs_tree_write_lock
1155
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1158
to_dir must exist in the inventory.
1160
If to_dir exists and is a directory, the files are moved into
1161
it, keeping their old names.
1163
Note that to_dir is only the last component of the new name;
1164
this doesn't change the directory.
1166
For each entry in from_paths the move mode will be determined
1169
The first mode moves the file in the filesystem and updates the
1170
inventory. The second mode only updates the inventory without
1171
touching the file on the filesystem. This is the new mode introduced
1174
move uses the second mode if 'after == True' and the target is not
1175
versioned but present in the working tree.
1177
move uses the second mode if 'after == False' and the source is
1178
versioned but no longer in the working tree, and the target is not
1179
versioned but present in the working tree.
1181
move uses the first mode if 'after == False' and the source is
1182
versioned and present in the working tree, and the target is not
1183
versioned and not present in the working tree.
1185
Everything else results in an error.
1187
This returns a list of (from_path, to_path) pairs for each
1188
entry that is moved.
1193
# check for deprecated use of signature
1195
to_dir = kwargs.get('to_name', None)
1197
raise TypeError('You must supply a target directory')
1199
symbol_versioning.warn('The parameter to_name was deprecated'
1200
' in version 0.13. Use to_dir instead',
1203
# check destination directory
1204
if isinstance(from_paths, basestring):
1206
inv = self.inventory
1207
to_abs = self.abspath(to_dir)
1208
if not isdir(to_abs):
1209
raise errors.BzrMoveFailedError('',to_dir,
1210
errors.NotADirectory(to_abs))
1211
if not self.has_filename(to_dir):
1212
raise errors.BzrMoveFailedError('',to_dir,
1213
errors.NotInWorkingDirectory(to_dir))
1214
to_dir_id = inv.path2id(to_dir)
1215
if to_dir_id is None:
1216
raise errors.BzrMoveFailedError('',to_dir,
1217
errors.NotVersionedError(path=str(to_dir)))
1219
to_dir_ie = inv[to_dir_id]
1220
if to_dir_ie.kind != 'directory':
1221
raise errors.BzrMoveFailedError('',to_dir,
1222
errors.NotADirectory(to_abs))
1224
# create rename entries and tuples
1225
for from_rel in from_paths:
1226
from_tail = splitpath(from_rel)[-1]
1227
from_id = inv.path2id(from_rel)
1229
raise errors.BzrMoveFailedError(from_rel,to_dir,
1230
errors.NotVersionedError(path=str(from_rel)))
1232
from_entry = inv[from_id]
1233
from_parent_id = from_entry.parent_id
1234
to_rel = pathjoin(to_dir, from_tail)
1235
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1237
from_tail=from_tail,
1238
from_parent_id=from_parent_id,
1239
to_rel=to_rel, to_tail=from_tail,
1240
to_parent_id=to_dir_id)
1241
rename_entries.append(rename_entry)
1242
rename_tuples.append((from_rel, to_rel))
1244
# determine which move mode to use. checks also for movability
1245
rename_entries = self._determine_mv_mode(rename_entries, after)
1247
original_modified = self._inventory_is_modified
1250
self._inventory_is_modified = True
1251
self._move(rename_entries)
1253
# restore the inventory on error
1254
self._inventory_is_modified = original_modified
1256
self._write_inventory(inv)
1257
return rename_tuples
1259
def _determine_mv_mode(self, rename_entries, after=False):
1260
"""Determines for each from-to pair if both inventory and working tree
1261
or only the inventory has to be changed.
1263
Also does basic plausability tests.
1265
inv = self.inventory
1267
for rename_entry in rename_entries:
1268
# store to local variables for easier reference
1269
from_rel = rename_entry.from_rel
1270
from_id = rename_entry.from_id
1271
to_rel = rename_entry.to_rel
1272
to_id = inv.path2id(to_rel)
1273
only_change_inv = False
1275
# check the inventory for source and destination
1277
raise errors.BzrMoveFailedError(from_rel,to_rel,
1278
errors.NotVersionedError(path=str(from_rel)))
1279
if to_id is not None:
1280
raise errors.BzrMoveFailedError(from_rel,to_rel,
1281
errors.AlreadyVersionedError(path=str(to_rel)))
1283
# try to determine the mode for rename (only change inv or change
1284
# inv and file system)
1286
if not self.has_filename(to_rel):
1287
raise errors.BzrMoveFailedError(from_id,to_rel,
1288
errors.NoSuchFile(path=str(to_rel),
1289
extra="New file has not been created yet"))
1290
only_change_inv = True
1291
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1292
only_change_inv = True
1293
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1294
only_change_inv = False
1295
elif (sys.platform == 'win32'
1296
and from_rel.lower() == to_rel.lower()
1297
and self.has_filename(from_rel)):
1298
only_change_inv = False
1300
# something is wrong, so lets determine what exactly
1301
if not self.has_filename(from_rel) and \
1302
not self.has_filename(to_rel):
1303
raise errors.BzrRenameFailedError(from_rel,to_rel,
1304
errors.PathsDoNotExist(paths=(str(from_rel),
1307
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1308
rename_entry.only_change_inv = only_change_inv
1309
return rename_entries
1311
def _move(self, rename_entries):
1312
"""Moves a list of files.
1314
Depending on the value of the flag 'only_change_inv', the
1315
file will be moved on the file system or not.
1317
inv = self.inventory
1320
for entry in rename_entries:
1322
self._move_entry(entry)
1324
self._rollback_move(moved)
1328
def _rollback_move(self, moved):
1329
"""Try to rollback a previous move in case of an filesystem error."""
1330
inv = self.inventory
1333
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1334
entry.to_tail, entry.to_parent_id, entry.from_rel,
1335
entry.from_tail, entry.from_parent_id,
1336
entry.only_change_inv))
1337
except errors.BzrMoveFailedError, e:
1338
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1339
" The working tree is in an inconsistent state."
1340
" Please consider doing a 'bzr revert'."
1341
" Error message is: %s" % e)
1343
def _move_entry(self, entry):
1344
inv = self.inventory
1345
from_rel_abs = self.abspath(entry.from_rel)
1346
to_rel_abs = self.abspath(entry.to_rel)
1347
if from_rel_abs == to_rel_abs:
1348
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1349
"Source and target are identical.")
1351
if not entry.only_change_inv:
1353
osutils.rename(from_rel_abs, to_rel_abs)
1355
raise errors.BzrMoveFailedError(entry.from_rel,
1357
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1359
@needs_tree_write_lock
1360
def rename_one(self, from_rel, to_rel, after=False):
1363
This can change the directory or the filename or both.
1365
rename_one has several 'modes' to work. First, it can rename a physical
1366
file and change the file_id. That is the normal mode. Second, it can
1367
only change the file_id without touching any physical file. This is
1368
the new mode introduced in version 0.15.
1370
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1371
versioned but present in the working tree.
1373
rename_one uses the second mode if 'after == False' and 'from_rel' is
1374
versioned but no longer in the working tree, and 'to_rel' is not
1375
versioned but present in the working tree.
1377
rename_one uses the first mode if 'after == False' and 'from_rel' is
1378
versioned and present in the working tree, and 'to_rel' is not
1379
versioned and not present in the working tree.
1381
Everything else results in an error.
1383
inv = self.inventory
1386
# create rename entries and tuples
1387
from_tail = splitpath(from_rel)[-1]
1388
from_id = inv.path2id(from_rel)
1390
raise errors.BzrRenameFailedError(from_rel,to_rel,
1391
errors.NotVersionedError(path=str(from_rel)))
1392
from_entry = inv[from_id]
1393
from_parent_id = from_entry.parent_id
1394
to_dir, to_tail = os.path.split(to_rel)
1395
to_dir_id = inv.path2id(to_dir)
1396
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1398
from_tail=from_tail,
1399
from_parent_id=from_parent_id,
1400
to_rel=to_rel, to_tail=to_tail,
1401
to_parent_id=to_dir_id)
1402
rename_entries.append(rename_entry)
1404
# determine which move mode to use. checks also for movability
1405
rename_entries = self._determine_mv_mode(rename_entries, after)
1407
# check if the target changed directory and if the target directory is
1409
if to_dir_id is None:
1410
raise errors.BzrMoveFailedError(from_rel,to_rel,
1411
errors.NotVersionedError(path=str(to_dir)))
1413
# all checks done. now we can continue with our actual work
1414
mutter('rename_one:\n'
1419
' to_dir_id {%s}\n',
1420
from_id, from_rel, to_rel, to_dir, to_dir_id)
1422
self._move(rename_entries)
1423
self._write_inventory(inv)
1425
class _RenameEntry(object):
1426
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1427
to_rel, to_tail, to_parent_id, only_change_inv=False):
1428
self.from_rel = from_rel
1429
self.from_id = from_id
1430
self.from_tail = from_tail
1431
self.from_parent_id = from_parent_id
1432
self.to_rel = to_rel
1433
self.to_tail = to_tail
1434
self.to_parent_id = to_parent_id
1435
self.only_change_inv = only_change_inv
1439
"""Return all unknown files.
1441
These are files in the working directory that are not versioned or
1442
control files or ignored.
1444
# force the extras method to be fully executed before returning, to
1445
# prevent race conditions with the lock
1447
[subp for subp in self.extras() if not self.is_ignored(subp)])
1449
@needs_tree_write_lock
1450
def unversion(self, file_ids):
1451
"""Remove the file ids in file_ids from the current versioned set.
1453
When a file_id is unversioned, all of its children are automatically
1456
:param file_ids: The file ids to stop versioning.
1457
:raises: NoSuchId if any fileid is not currently versioned.
1459
for file_id in file_ids:
1460
if self._inventory.has_id(file_id):
1461
self._inventory.remove_recursive_id(file_id)
1463
raise errors.NoSuchId(self, file_id)
1465
# in the future this should just set a dirty bit to wait for the
1466
# final unlock. However, until all methods of workingtree start
1467
# with the current in -memory inventory rather than triggering
1468
# a read, it is more complex - we need to teach read_inventory
1469
# to know when to read, and when to not read first... and possibly
1470
# to save first when the in memory one may be corrupted.
1471
# so for now, we just only write it if it is indeed dirty.
1473
self._write_inventory(self._inventory)
1475
def _iter_conflicts(self):
1477
for info in self.list_files():
1479
stem = get_conflicted_stem(path)
1482
if stem not in conflicted:
1483
conflicted.add(stem)
1487
def pull(self, source, overwrite=False, stop_revision=None,
1488
change_reporter=None, possible_transports=None):
1489
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1492
pp = ProgressPhase("Pull phase", 2, top_pb)
1494
old_revision_info = self.branch.last_revision_info()
1495
basis_tree = self.basis_tree()
1496
count = self.branch.pull(source, overwrite, stop_revision,
1497
possible_transports=possible_transports)
1498
new_revision_info = self.branch.last_revision_info()
1499
if new_revision_info != old_revision_info:
1501
repository = self.branch.repository
1502
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1503
basis_tree.lock_read()
1505
new_basis_tree = self.branch.basis_tree()
1512
change_reporter=change_reporter)
1513
if (basis_tree.inventory.root is None and
1514
new_basis_tree.inventory.root is not None):
1515
self.set_root_id(new_basis_tree.get_root_id())
1519
# TODO - dedup parents list with things merged by pull ?
1520
# reuse the revisiontree we merged against to set the new
1522
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1523
# we have to pull the merge trees out again, because
1524
# merge_inner has set the ids. - this corner is not yet
1525
# layered well enough to prevent double handling.
1526
# XXX TODO: Fix the double handling: telling the tree about
1527
# the already known parent data is wasteful.
1528
merges = self.get_parent_ids()[1:]
1529
parent_trees.extend([
1530
(parent, repository.revision_tree(parent)) for
1532
self.set_parent_trees(parent_trees)
1539
def put_file_bytes_non_atomic(self, file_id, bytes):
1540
"""See MutableTree.put_file_bytes_non_atomic."""
1541
stream = file(self.id2abspath(file_id), 'wb')
1546
# TODO: update the hashcache here ?
1549
"""Yield all unversioned files in this WorkingTree.
1551
If there are any unversioned directories then only the directory is
1552
returned, not all its children. But if there are unversioned files
1553
under a versioned subdirectory, they are returned.
1555
Currently returned depth-first, sorted by name within directories.
1556
This is the same order used by 'osutils.walkdirs'.
1558
## TODO: Work from given directory downwards
1559
for path, dir_entry in self.inventory.directories():
1560
# mutter("search for unknowns in %r", path)
1561
dirabs = self.abspath(path)
1562
if not isdir(dirabs):
1563
# e.g. directory deleted
1567
for subf in os.listdir(dirabs):
1570
if subf not in dir_entry.children:
1571
subf_norm, can_access = osutils.normalized_filename(subf)
1572
if subf_norm != subf and can_access:
1573
if subf_norm not in dir_entry.children:
1574
fl.append(subf_norm)
1580
subp = pathjoin(path, subf)
1583
def ignored_files(self):
1584
"""Yield list of PATH, IGNORE_PATTERN"""
1585
for subp in self.extras():
1586
pat = self.is_ignored(subp)
1590
def get_ignore_list(self):
1591
"""Return list of ignore patterns.
1593
Cached in the Tree object after the first call.
1595
ignoreset = getattr(self, '_ignoreset', None)
1596
if ignoreset is not None:
1599
ignore_globs = set()
1600
ignore_globs.update(ignores.get_runtime_ignores())
1601
ignore_globs.update(ignores.get_user_ignores())
1602
if self.has_filename(bzrlib.IGNORE_FILENAME):
1603
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1605
ignore_globs.update(ignores.parse_ignore_file(f))
1608
self._ignoreset = ignore_globs
1611
def _flush_ignore_list_cache(self):
1612
"""Resets the cached ignore list to force a cache rebuild."""
1613
self._ignoreset = None
1614
self._ignoreglobster = None
1616
def is_ignored(self, filename):
1617
r"""Check whether the filename matches an ignore pattern.
1619
Patterns containing '/' or '\' need to match the whole path;
1620
others match against only the last component.
1622
If the file is ignored, returns the pattern which caused it to
1623
be ignored, otherwise None. So this can simply be used as a
1624
boolean if desired."""
1625
if getattr(self, '_ignoreglobster', None) is None:
1626
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1627
return self._ignoreglobster.match(filename)
1629
def kind(self, file_id):
1630
return file_kind(self.id2abspath(file_id))
1632
def stored_kind(self, file_id):
1633
"""See Tree.stored_kind"""
1634
return self.inventory[file_id].kind
1636
def _comparison_data(self, entry, path):
1637
abspath = self.abspath(path)
1639
stat_value = os.lstat(abspath)
1641
if getattr(e, 'errno', None) == errno.ENOENT:
1648
mode = stat_value.st_mode
1649
kind = osutils.file_kind_from_stat_mode(mode)
1650
if not supports_executable():
1651
executable = entry is not None and entry.executable
1653
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1654
return kind, executable, stat_value
1656
def _file_size(self, entry, stat_value):
1657
return stat_value.st_size
1659
def last_revision(self):
1660
"""Return the last revision of the branch for this tree.
1662
This format tree does not support a separate marker for last-revision
1663
compared to the branch.
1665
See MutableTree.last_revision
1667
return self._last_revision()
1670
def _last_revision(self):
1671
"""helper for get_parent_ids."""
1672
return _mod_revision.ensure_null(self.branch.last_revision())
1674
def is_locked(self):
1675
return self._control_files.is_locked()
1677
def _must_be_locked(self):
1678
if not self.is_locked():
1679
raise errors.ObjectNotLocked(self)
1681
def lock_read(self):
1682
"""See Branch.lock_read, and WorkingTree.unlock."""
1683
if not self.is_locked():
1685
self.branch.lock_read()
1687
return self._control_files.lock_read()
1689
self.branch.unlock()
1692
def lock_tree_write(self):
1693
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1694
if not self.is_locked():
1696
self.branch.lock_read()
1698
return self._control_files.lock_write()
1700
self.branch.unlock()
1703
def lock_write(self):
1704
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1705
if not self.is_locked():
1707
self.branch.lock_write()
1709
return self._control_files.lock_write()
1711
self.branch.unlock()
1714
def get_physical_lock_status(self):
1715
return self._control_files.get_physical_lock_status()
1717
def _basis_inventory_name(self):
1718
return 'basis-inventory-cache'
1720
def _reset_data(self):
1721
"""Reset transient data that cannot be revalidated."""
1722
self._inventory_is_modified = False
1723
result = self._deserialize(self._transport.get('inventory'))
1724
self._set_inventory(result, dirty=False)
1726
@needs_tree_write_lock
1727
def set_last_revision(self, new_revision):
1728
"""Change the last revision in the working tree."""
1729
if self._change_last_revision(new_revision):
1730
self._cache_basis_inventory(new_revision)
1732
def _change_last_revision(self, new_revision):
1733
"""Template method part of set_last_revision to perform the change.
1735
This is used to allow WorkingTree3 instances to not affect branch
1736
when their last revision is set.
1738
if _mod_revision.is_null(new_revision):
1739
self.branch.set_revision_history([])
1742
self.branch.generate_revision_history(new_revision)
1743
except errors.NoSuchRevision:
1744
# not present in the repo - dont try to set it deeper than the tip
1745
self.branch.set_revision_history([new_revision])
1748
def _write_basis_inventory(self, xml):
1749
"""Write the basis inventory XML to the basis-inventory file"""
1750
path = self._basis_inventory_name()
1752
self._transport.put_file(path, sio,
1753
mode=self._control_files._file_mode)
1755
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1756
"""Create the text that will be saved in basis-inventory"""
1757
inventory.revision_id = revision_id
1758
return xml7.serializer_v7.write_inventory_to_string(inventory)
1760
def _cache_basis_inventory(self, new_revision):
1761
"""Cache new_revision as the basis inventory."""
1762
# TODO: this should allow the ready-to-use inventory to be passed in,
1763
# as commit already has that ready-to-use [while the format is the
1766
# this double handles the inventory - unpack and repack -
1767
# but is easier to understand. We can/should put a conditional
1768
# in here based on whether the inventory is in the latest format
1769
# - perhaps we should repack all inventories on a repository
1771
# the fast path is to copy the raw xml from the repository. If the
1772
# xml contains 'revision_id="', then we assume the right
1773
# revision_id is set. We must check for this full string, because a
1774
# root node id can legitimately look like 'revision_id' but cannot
1776
xml = self.branch.repository.get_inventory_xml(new_revision)
1777
firstline = xml.split('\n', 1)[0]
1778
if (not 'revision_id="' in firstline or
1779
'format="7"' not in firstline):
1780
inv = self.branch.repository.deserialise_inventory(
1782
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1783
self._write_basis_inventory(xml)
1784
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1787
def read_basis_inventory(self):
1788
"""Read the cached basis inventory."""
1789
path = self._basis_inventory_name()
1790
return self._transport.get_bytes(path)
1793
def read_working_inventory(self):
1794
"""Read the working inventory.
1796
:raises errors.InventoryModified: read_working_inventory will fail
1797
when the current in memory inventory has been modified.
1799
# conceptually this should be an implementation detail of the tree.
1800
# XXX: Deprecate this.
1801
# ElementTree does its own conversion from UTF-8, so open in
1803
if self._inventory_is_modified:
1804
raise errors.InventoryModified(self)
1805
result = self._deserialize(self._transport.get('inventory'))
1806
self._set_inventory(result, dirty=False)
1809
@needs_tree_write_lock
1810
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1812
"""Remove nominated files from the working inventory.
1814
:files: File paths relative to the basedir.
1815
:keep_files: If true, the files will also be kept.
1816
:force: Delete files and directories, even if they are changed and
1817
even if the directories are not empty.
1819
if isinstance(files, basestring):
1825
unknown_nested_files=set()
1827
def recurse_directory_to_add_files(directory):
1828
# Recurse directory and add all files
1829
# so we can check if they have changed.
1830
for parent_info, file_infos in\
1831
osutils.walkdirs(self.abspath(directory),
1833
for relpath, basename, kind, lstat, abspath in file_infos:
1834
# Is it versioned or ignored?
1835
if self.path2id(relpath) or self.is_ignored(relpath):
1836
# Add nested content for deletion.
1837
new_files.add(relpath)
1839
# Files which are not versioned and not ignored
1840
# should be treated as unknown.
1841
unknown_nested_files.add((relpath, None, kind))
1843
for filename in files:
1844
# Get file name into canonical form.
1845
abspath = self.abspath(filename)
1846
filename = self.relpath(abspath)
1847
if len(filename) > 0:
1848
new_files.add(filename)
1849
if osutils.isdir(abspath):
1850
recurse_directory_to_add_files(filename)
1852
files = list(new_files)
1855
return # nothing to do
1857
# Sort needed to first handle directory content before the directory
1858
files.sort(reverse=True)
1860
# Bail out if we are going to delete files we shouldn't
1861
if not keep_files and not force:
1862
has_changed_files = len(unknown_nested_files) > 0
1863
if not has_changed_files:
1864
for (file_id, path, content_change, versioned, parent_id, name,
1865
kind, executable) in self.iter_changes(self.basis_tree(),
1866
include_unchanged=True, require_versioned=False,
1867
want_unversioned=True, specific_files=files):
1868
if versioned == (False, False):
1869
# The record is unknown ...
1870
if not self.is_ignored(path[1]):
1871
# ... but not ignored
1872
has_changed_files = True
1874
elif content_change and (kind[1] is not None):
1875
# Versioned and changed, but not deleted
1876
has_changed_files = True
1879
if has_changed_files:
1880
# Make delta show ALL applicable changes in error message.
1881
tree_delta = self.changes_from(self.basis_tree(),
1882
require_versioned=False, want_unversioned=True,
1883
specific_files=files)
1884
for unknown_file in unknown_nested_files:
1885
if unknown_file not in tree_delta.unversioned:
1886
tree_delta.unversioned.extend((unknown_file,))
1887
raise errors.BzrRemoveChangedFilesError(tree_delta)
1889
# Build inv_delta and delete files where applicaple,
1890
# do this before any modifications to inventory.
1892
fid = self.path2id(f)
1895
message = "%s is not versioned." % (f,)
1898
# having removed it, it must be either ignored or unknown
1899
if self.is_ignored(f):
1903
textui.show_status(new_status, self.kind(fid), f,
1906
inv_delta.append((f, None, fid, None))
1907
message = "removed %s" % (f,)
1910
abs_path = self.abspath(f)
1911
if osutils.lexists(abs_path):
1912
if (osutils.isdir(abs_path) and
1913
len(os.listdir(abs_path)) > 0):
1915
osutils.rmtree(abs_path)
1917
message = "%s is not an empty directory "\
1918
"and won't be deleted." % (f,)
1920
osutils.delete_any(abs_path)
1921
message = "deleted %s" % (f,)
1922
elif message is not None:
1923
# Only care if we haven't done anything yet.
1924
message = "%s does not exist." % (f,)
1926
# Print only one message (if any) per file.
1927
if message is not None:
1929
self.apply_inventory_delta(inv_delta)
1931
@needs_tree_write_lock
1932
def revert(self, filenames=None, old_tree=None, backups=True,
1933
pb=DummyProgress(), report_changes=False):
1934
from bzrlib.conflicts import resolve
1937
symbol_versioning.warn('Using [] to revert all files is deprecated'
1938
' as of bzr 0.91. Please use None (the default) instead.',
1939
DeprecationWarning, stacklevel=2)
1940
if old_tree is None:
1941
basis_tree = self.basis_tree()
1942
basis_tree.lock_read()
1943
old_tree = basis_tree
1947
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1949
if filenames is None and len(self.get_parent_ids()) > 1:
1951
last_revision = self.last_revision()
1952
if last_revision != NULL_REVISION:
1953
if basis_tree is None:
1954
basis_tree = self.basis_tree()
1955
basis_tree.lock_read()
1956
parent_trees.append((last_revision, basis_tree))
1957
self.set_parent_trees(parent_trees)
1960
resolve(self, filenames, ignore_misses=True, recursive=True)
1962
if basis_tree is not None:
1966
def revision_tree(self, revision_id):
1967
"""See Tree.revision_tree.
1969
WorkingTree can supply revision_trees for the basis revision only
1970
because there is only one cached inventory in the bzr directory.
1972
if revision_id == self.last_revision():
1974
xml = self.read_basis_inventory()
1975
except errors.NoSuchFile:
1979
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1980
# dont use the repository revision_tree api because we want
1981
# to supply the inventory.
1982
if inv.revision_id == revision_id:
1983
return revisiontree.RevisionTree(self.branch.repository,
1985
except errors.BadInventoryFormat:
1987
# raise if there was no inventory, or if we read the wrong inventory.
1988
raise errors.NoSuchRevisionInTree(self, revision_id)
1990
# XXX: This method should be deprecated in favour of taking in a proper
1991
# new Inventory object.
1992
@needs_tree_write_lock
1993
def set_inventory(self, new_inventory_list):
1994
from bzrlib.inventory import (Inventory,
1999
inv = Inventory(self.get_root_id())
2000
for path, file_id, parent, kind in new_inventory_list:
2001
name = os.path.basename(path)
2004
# fixme, there should be a factory function inv,add_??
2005
if kind == 'directory':
2006
inv.add(InventoryDirectory(file_id, name, parent))
2007
elif kind == 'file':
2008
inv.add(InventoryFile(file_id, name, parent))
2009
elif kind == 'symlink':
2010
inv.add(InventoryLink(file_id, name, parent))
2012
raise errors.BzrError("unknown kind %r" % kind)
2013
self._write_inventory(inv)
2015
@needs_tree_write_lock
2016
def set_root_id(self, file_id):
2017
"""Set the root id for this tree."""
2021
'WorkingTree.set_root_id with fileid=None')
2022
file_id = osutils.safe_file_id(file_id)
2023
self._set_root_id(file_id)
2025
def _set_root_id(self, file_id):
2026
"""Set the root id for this tree, in a format specific manner.
2028
:param file_id: The file id to assign to the root. It must not be
2029
present in the current inventory or an error will occur. It must
2030
not be None, but rather a valid file id.
2032
inv = self._inventory
2033
orig_root_id = inv.root.file_id
2034
# TODO: it might be nice to exit early if there was nothing
2035
# to do, saving us from trigger a sync on unlock.
2036
self._inventory_is_modified = True
2037
# we preserve the root inventory entry object, but
2038
# unlinkit from the byid index
2039
del inv._byid[inv.root.file_id]
2040
inv.root.file_id = file_id
2041
# and link it into the index with the new changed id.
2042
inv._byid[inv.root.file_id] = inv.root
2043
# and finally update all children to reference the new id.
2044
# XXX: this should be safe to just look at the root.children
2045
# list, not the WHOLE INVENTORY.
2048
if entry.parent_id == orig_root_id:
2049
entry.parent_id = inv.root.file_id
2052
"""See Branch.unlock.
2054
WorkingTree locking just uses the Branch locking facilities.
2055
This is current because all working trees have an embedded branch
2056
within them. IF in the future, we were to make branch data shareable
2057
between multiple working trees, i.e. via shared storage, then we
2058
would probably want to lock both the local tree, and the branch.
2060
raise NotImplementedError(self.unlock)
2062
def update(self, change_reporter=None, possible_transports=None):
2063
"""Update a working tree along its branch.
2065
This will update the branch if its bound too, which means we have
2066
multiple trees involved:
2068
- The new basis tree of the master.
2069
- The old basis tree of the branch.
2070
- The old basis tree of the working tree.
2071
- The current working tree state.
2073
Pathologically, all three may be different, and non-ancestors of each
2074
other. Conceptually we want to:
2076
- Preserve the wt.basis->wt.state changes
2077
- Transform the wt.basis to the new master basis.
2078
- Apply a merge of the old branch basis to get any 'local' changes from
2080
- Restore the wt.basis->wt.state changes.
2082
There isn't a single operation at the moment to do that, so we:
2083
- Merge current state -> basis tree of the master w.r.t. the old tree
2085
- Do a 'normal' merge of the old branch basis if it is relevant.
2087
if self.branch.get_bound_location() is not None:
2089
update_branch = True
2091
self.lock_tree_write()
2092
update_branch = False
2095
old_tip = self.branch.update(possible_transports)
2098
return self._update_tree(old_tip, change_reporter)
2102
@needs_tree_write_lock
2103
def _update_tree(self, old_tip=None, change_reporter=None):
2104
"""Update a tree to the master branch.
2106
:param old_tip: if supplied, the previous tip revision the branch,
2107
before it was changed to the master branch's tip.
2109
# here if old_tip is not None, it is the old tip of the branch before
2110
# it was updated from the master branch. This should become a pending
2111
# merge in the working tree to preserve the user existing work. we
2112
# cant set that until we update the working trees last revision to be
2113
# one from the new branch, because it will just get absorbed by the
2114
# parent de-duplication logic.
2116
# We MUST save it even if an error occurs, because otherwise the users
2117
# local work is unreferenced and will appear to have been lost.
2121
last_rev = self.get_parent_ids()[0]
2123
last_rev = _mod_revision.NULL_REVISION
2124
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2125
# merge tree state up to new branch tip.
2126
basis = self.basis_tree()
2129
to_tree = self.branch.basis_tree()
2130
if basis.inventory.root is None:
2131
self.set_root_id(to_tree.get_root_id())
2133
result += merge.merge_inner(
2138
change_reporter=change_reporter)
2141
# TODO - dedup parents list with things merged by pull ?
2142
# reuse the tree we've updated to to set the basis:
2143
parent_trees = [(self.branch.last_revision(), to_tree)]
2144
merges = self.get_parent_ids()[1:]
2145
# Ideally we ask the tree for the trees here, that way the working
2146
# tree can decide whether to give us teh entire tree or give us a
2147
# lazy initialised tree. dirstate for instance will have the trees
2148
# in ram already, whereas a last-revision + basis-inventory tree
2149
# will not, but also does not need them when setting parents.
2150
for parent in merges:
2151
parent_trees.append(
2152
(parent, self.branch.repository.revision_tree(parent)))
2153
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2154
parent_trees.append(
2155
(old_tip, self.branch.repository.revision_tree(old_tip)))
2156
self.set_parent_trees(parent_trees)
2157
last_rev = parent_trees[0][0]
2159
# the working tree had the same last-revision as the master
2160
# branch did. We may still have pivot local work from the local
2161
# branch into old_tip:
2162
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2163
self.add_parent_tree_id(old_tip)
2164
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2165
and old_tip != last_rev):
2166
# our last revision was not the prior branch last revision
2167
# and we have converted that last revision to a pending merge.
2168
# base is somewhere between the branch tip now
2169
# and the now pending merge
2171
# Since we just modified the working tree and inventory, flush out
2172
# the current state, before we modify it again.
2173
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2174
# requires it only because TreeTransform directly munges the
2175
# inventory and calls tree._write_inventory(). Ultimately we
2176
# should be able to remove this extra flush.
2178
graph = self.branch.repository.get_graph()
2179
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2181
base_tree = self.branch.repository.revision_tree(base_rev_id)
2182
other_tree = self.branch.repository.revision_tree(old_tip)
2183
result += merge.merge_inner(
2188
change_reporter=change_reporter)
2191
def _write_hashcache_if_dirty(self):
2192
"""Write out the hashcache if it is dirty."""
2193
if self._hashcache.needs_write:
2195
self._hashcache.write()
2197
if e.errno not in (errno.EPERM, errno.EACCES):
2199
# TODO: jam 20061219 Should this be a warning? A single line
2200
# warning might be sufficient to let the user know what
2202
mutter('Could not write hashcache for %s\nError: %s',
2203
self._hashcache.cache_file_name(), e)
2205
@needs_tree_write_lock
2206
def _write_inventory(self, inv):
2207
"""Write inventory as the current inventory."""
2208
self._set_inventory(inv, dirty=True)
2211
def set_conflicts(self, arg):
2212
raise errors.UnsupportedOperation(self.set_conflicts, self)
2214
def add_conflicts(self, arg):
2215
raise errors.UnsupportedOperation(self.add_conflicts, self)
2218
def conflicts(self):
2219
conflicts = _mod_conflicts.ConflictList()
2220
for conflicted in self._iter_conflicts():
2223
if file_kind(self.abspath(conflicted)) != "file":
2225
except errors.NoSuchFile:
2228
for suffix in ('.THIS', '.OTHER'):
2230
kind = file_kind(self.abspath(conflicted+suffix))
2233
except errors.NoSuchFile:
2237
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2238
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2240
file_id=self.path2id(conflicted)))
2243
def walkdirs(self, prefix=""):
2244
"""Walk the directories of this tree.
2246
returns a generator which yields items in the form:
2247
((curren_directory_path, fileid),
2248
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2251
This API returns a generator, which is only valid during the current
2252
tree transaction - within a single lock_read or lock_write duration.
2254
If the tree is not locked, it may cause an error to be raised,
2255
depending on the tree implementation.
2257
disk_top = self.abspath(prefix)
2258
if disk_top.endswith('/'):
2259
disk_top = disk_top[:-1]
2260
top_strip_len = len(disk_top) + 1
2261
inventory_iterator = self._walkdirs(prefix)
2262
disk_iterator = osutils.walkdirs(disk_top, prefix)
2264
current_disk = disk_iterator.next()
2265
disk_finished = False
2267
if not (e.errno == errno.ENOENT or
2268
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2271
disk_finished = True
2273
current_inv = inventory_iterator.next()
2274
inv_finished = False
2275
except StopIteration:
2278
while not inv_finished or not disk_finished:
2280
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2281
cur_disk_dir_content) = current_disk
2283
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2284
cur_disk_dir_content) = ((None, None), None)
2285
if not disk_finished:
2286
# strip out .bzr dirs
2287
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2288
len(cur_disk_dir_content) > 0):
2289
# osutils.walkdirs can be made nicer -
2290
# yield the path-from-prefix rather than the pathjoined
2292
bzrdir_loc = bisect_left(cur_disk_dir_content,
2294
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2295
# we dont yield the contents of, or, .bzr itself.
2296
del cur_disk_dir_content[bzrdir_loc]
2298
# everything is unknown
2301
# everything is missing
2304
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2306
# disk is before inventory - unknown
2307
dirblock = [(relpath, basename, kind, stat, None, None) for
2308
relpath, basename, kind, stat, top_path in
2309
cur_disk_dir_content]
2310
yield (cur_disk_dir_relpath, None), dirblock
2312
current_disk = disk_iterator.next()
2313
except StopIteration:
2314
disk_finished = True
2316
# inventory is before disk - missing.
2317
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2318
for relpath, basename, dkind, stat, fileid, kind in
2320
yield (current_inv[0][0], current_inv[0][1]), dirblock
2322
current_inv = inventory_iterator.next()
2323
except StopIteration:
2326
# versioned present directory
2327
# merge the inventory and disk data together
2329
for relpath, subiterator in itertools.groupby(sorted(
2330
current_inv[1] + cur_disk_dir_content,
2331
key=operator.itemgetter(0)), operator.itemgetter(1)):
2332
path_elements = list(subiterator)
2333
if len(path_elements) == 2:
2334
inv_row, disk_row = path_elements
2335
# versioned, present file
2336
dirblock.append((inv_row[0],
2337
inv_row[1], disk_row[2],
2338
disk_row[3], inv_row[4],
2340
elif len(path_elements[0]) == 5:
2342
dirblock.append((path_elements[0][0],
2343
path_elements[0][1], path_elements[0][2],
2344
path_elements[0][3], None, None))
2345
elif len(path_elements[0]) == 6:
2346
# versioned, absent file.
2347
dirblock.append((path_elements[0][0],
2348
path_elements[0][1], 'unknown', None,
2349
path_elements[0][4], path_elements[0][5]))
2351
raise NotImplementedError('unreachable code')
2352
yield current_inv[0], dirblock
2354
current_inv = inventory_iterator.next()
2355
except StopIteration:
2358
current_disk = disk_iterator.next()
2359
except StopIteration:
2360
disk_finished = True
2362
def _walkdirs(self, prefix=""):
2363
"""Walk the directories of this tree.
2365
:prefix: is used as the directrory to start with.
2366
returns a generator which yields items in the form:
2367
((curren_directory_path, fileid),
2368
[(file1_path, file1_name, file1_kind, None, file1_id,
2371
_directory = 'directory'
2372
# get the root in the inventory
2373
inv = self.inventory
2374
top_id = inv.path2id(prefix)
2378
pending = [(prefix, '', _directory, None, top_id, None)]
2381
currentdir = pending.pop()
2382
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2383
top_id = currentdir[4]
2385
relroot = currentdir[0] + '/'
2388
# FIXME: stash the node in pending
2390
for name, child in entry.sorted_children():
2391
dirblock.append((relroot + name, name, child.kind, None,
2392
child.file_id, child.kind
2394
yield (currentdir[0], entry.file_id), dirblock
2395
# push the user specified dirs from dirblock
2396
for dir in reversed(dirblock):
2397
if dir[2] == _directory:
2400
@needs_tree_write_lock
2401
def auto_resolve(self):
2402
"""Automatically resolve text conflicts according to contents.
2404
Only text conflicts are auto_resolvable. Files with no conflict markers
2405
are considered 'resolved', because bzr always puts conflict markers
2406
into files that have text conflicts. The corresponding .THIS .BASE and
2407
.OTHER files are deleted, as per 'resolve'.
2408
:return: a tuple of ConflictLists: (un_resolved, resolved).
2410
un_resolved = _mod_conflicts.ConflictList()
2411
resolved = _mod_conflicts.ConflictList()
2412
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2413
for conflict in self.conflicts():
2414
if (conflict.typestring != 'text conflict' or
2415
self.kind(conflict.file_id) != 'file'):
2416
un_resolved.append(conflict)
2418
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2420
for line in my_file:
2421
if conflict_re.search(line):
2422
un_resolved.append(conflict)
2425
resolved.append(conflict)
2428
resolved.remove_files(self)
2429
self.set_conflicts(un_resolved)
2430
return un_resolved, resolved
2432
def _validate(self):
2433
"""Validate internal structures.
2435
This is meant mostly for the test suite. To give it a chance to detect
2436
corruption after actions have occurred. The default implementation is a
2439
:return: None. An exception should be raised if there is an error.
2444
class WorkingTree2(WorkingTree):
2445
"""This is the Format 2 working tree.
2447
This was the first weave based working tree.
2448
- uses os locks for locking.
2449
- uses the branch last-revision.
2452
def __init__(self, *args, **kwargs):
2453
super(WorkingTree2, self).__init__(*args, **kwargs)
2454
# WorkingTree2 has more of a constraint that self._inventory must
2455
# exist. Because this is an older format, we don't mind the overhead
2456
# caused by the extra computation here.
2458
# Newer WorkingTree's should only have self._inventory set when they
2460
if self._inventory is None:
2461
self.read_working_inventory()
2463
def lock_tree_write(self):
2464
"""See WorkingTree.lock_tree_write().
2466
In Format2 WorkingTrees we have a single lock for the branch and tree
2467
so lock_tree_write() degrades to lock_write().
2469
self.branch.lock_write()
2471
return self._control_files.lock_write()
2473
self.branch.unlock()
2477
# do non-implementation specific cleanup
2480
# we share control files:
2481
if self._control_files._lock_count == 3:
2482
# _inventory_is_modified is always False during a read lock.
2483
if self._inventory_is_modified:
2485
self._write_hashcache_if_dirty()
2487
# reverse order of locking.
2489
return self._control_files.unlock()
2491
self.branch.unlock()
2494
class WorkingTree3(WorkingTree):
2495
"""This is the Format 3 working tree.
2497
This differs from the base WorkingTree by:
2498
- having its own file lock
2499
- having its own last-revision property.
2501
This is new in bzr 0.8
2505
def _last_revision(self):
2506
"""See Mutable.last_revision."""
2508
return self._transport.get_bytes('last-revision')
2509
except errors.NoSuchFile:
2510
return _mod_revision.NULL_REVISION
2512
def _change_last_revision(self, revision_id):
2513
"""See WorkingTree._change_last_revision."""
2514
if revision_id is None or revision_id == NULL_REVISION:
2516
self._transport.delete('last-revision')
2517
except errors.NoSuchFile:
2521
self._transport.put_bytes('last-revision', revision_id,
2522
mode=self._control_files._file_mode)
2525
@needs_tree_write_lock
2526
def set_conflicts(self, conflicts):
2527
self._put_rio('conflicts', conflicts.to_stanzas(),
2530
@needs_tree_write_lock
2531
def add_conflicts(self, new_conflicts):
2532
conflict_set = set(self.conflicts())
2533
conflict_set.update(set(list(new_conflicts)))
2534
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2535
key=_mod_conflicts.Conflict.sort_key)))
2538
def conflicts(self):
2540
confile = self._transport.get('conflicts')
2541
except errors.NoSuchFile:
2542
return _mod_conflicts.ConflictList()
2544
if confile.next() != CONFLICT_HEADER_1 + '\n':
2545
raise errors.ConflictFormatError()
2546
except StopIteration:
2547
raise errors.ConflictFormatError()
2548
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2551
# do non-implementation specific cleanup
2553
if self._control_files._lock_count == 1:
2554
# _inventory_is_modified is always False during a read lock.
2555
if self._inventory_is_modified:
2557
self._write_hashcache_if_dirty()
2558
# reverse order of locking.
2560
return self._control_files.unlock()
2562
self.branch.unlock()
2565
def get_conflicted_stem(path):
2566
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2567
if path.endswith(suffix):
2568
return path[:-len(suffix)]
2571
class WorkingTreeFormat(object):
2572
"""An encapsulation of the initialization and open routines for a format.
2574
Formats provide three things:
2575
* An initialization routine,
2579
Formats are placed in an dict by their format string for reference
2580
during workingtree opening. Its not required that these be instances, they
2581
can be classes themselves with class methods - it simply depends on
2582
whether state is needed for a given format or not.
2584
Once a format is deprecated, just deprecate the initialize and open
2585
methods on the format class. Do not deprecate the object, as the
2586
object will be created every time regardless.
2589
_default_format = None
2590
"""The default format used for new trees."""
2593
"""The known formats."""
2595
requires_rich_root = False
2597
upgrade_recommended = False
2600
def find_format(klass, a_bzrdir):
2601
"""Return the format for the working tree object in a_bzrdir."""
2603
transport = a_bzrdir.get_workingtree_transport(None)
2604
format_string = transport.get("format").read()
2605
return klass._formats[format_string]
2606
except errors.NoSuchFile:
2607
raise errors.NoWorkingTree(base=transport.base)
2609
raise errors.UnknownFormatError(format=format_string,
2610
kind="working tree")
2612
def __eq__(self, other):
2613
return self.__class__ is other.__class__
2615
def __ne__(self, other):
2616
return not (self == other)
2619
def get_default_format(klass):
2620
"""Return the current default format."""
2621
return klass._default_format
2623
def get_format_string(self):
2624
"""Return the ASCII format string that identifies this format."""
2625
raise NotImplementedError(self.get_format_string)
2627
def get_format_description(self):
2628
"""Return the short description for this format."""
2629
raise NotImplementedError(self.get_format_description)
2631
def is_supported(self):
2632
"""Is this format supported?
2634
Supported formats can be initialized and opened.
2635
Unsupported formats may not support initialization or committing or
2636
some other features depending on the reason for not being supported.
2641
def register_format(klass, format):
2642
klass._formats[format.get_format_string()] = format
2645
def set_default_format(klass, format):
2646
klass._default_format = format
2649
def unregister_format(klass, format):
2650
del klass._formats[format.get_format_string()]
2653
class WorkingTreeFormat2(WorkingTreeFormat):
2654
"""The second working tree format.
2656
This format modified the hash cache from the format 1 hash cache.
2659
upgrade_recommended = True
2661
def get_format_description(self):
2662
"""See WorkingTreeFormat.get_format_description()."""
2663
return "Working tree format 2"
2665
def _stub_initialize_remote(self, branch):
2666
"""As a special workaround create critical control files for a remote working tree.
2668
This ensures that it can later be updated and dealt with locally,
2669
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2670
no working tree. (See bug #43064).
2674
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2676
branch._transport.put_file('inventory', sio,
2677
mode=branch.control_files._file_mode)
2678
branch._transport.put_bytes('pending-merges', '',
2679
mode=branch.control_files._file_mode)
2682
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2683
accelerator_tree=None, hardlink=False):
2684
"""See WorkingTreeFormat.initialize()."""
2685
if not isinstance(a_bzrdir.transport, LocalTransport):
2686
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2687
if from_branch is not None:
2688
branch = from_branch
2690
branch = a_bzrdir.open_branch()
2691
if revision_id is None:
2692
revision_id = _mod_revision.ensure_null(branch.last_revision())
2695
branch.generate_revision_history(revision_id)
2699
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2705
basis_tree = branch.repository.revision_tree(revision_id)
2706
if basis_tree.inventory.root is not None:
2707
wt.set_root_id(basis_tree.get_root_id())
2708
# set the parent list and cache the basis tree.
2709
if _mod_revision.is_null(revision_id):
2712
parent_trees = [(revision_id, basis_tree)]
2713
wt.set_parent_trees(parent_trees)
2714
transform.build_tree(basis_tree, wt)
2718
super(WorkingTreeFormat2, self).__init__()
2719
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2721
def open(self, a_bzrdir, _found=False):
2722
"""Return the WorkingTree object for a_bzrdir
2724
_found is a private parameter, do not use it. It is used to indicate
2725
if format probing has already been done.
2728
# we are being called directly and must probe.
2729
raise NotImplementedError
2730
if not isinstance(a_bzrdir.transport, LocalTransport):
2731
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2732
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2738
class WorkingTreeFormat3(WorkingTreeFormat):
2739
"""The second working tree format updated to record a format marker.
2742
- exists within a metadir controlling .bzr
2743
- includes an explicit version marker for the workingtree control
2744
files, separate from the BzrDir format
2745
- modifies the hash cache format
2747
- uses a LockDir to guard access for writes.
2750
upgrade_recommended = True
2752
def get_format_string(self):
2753
"""See WorkingTreeFormat.get_format_string()."""
2754
return "Bazaar-NG Working Tree format 3"
2756
def get_format_description(self):
2757
"""See WorkingTreeFormat.get_format_description()."""
2758
return "Working tree format 3"
2760
_lock_file_name = 'lock'
2761
_lock_class = LockDir
2763
_tree_class = WorkingTree3
2765
def __get_matchingbzrdir(self):
2766
return bzrdir.BzrDirMetaFormat1()
2768
_matchingbzrdir = property(__get_matchingbzrdir)
2770
def _open_control_files(self, a_bzrdir):
2771
transport = a_bzrdir.get_workingtree_transport(None)
2772
return LockableFiles(transport, self._lock_file_name,
2775
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2776
accelerator_tree=None, hardlink=False):
2777
"""See WorkingTreeFormat.initialize().
2779
:param revision_id: if supplied, create a working tree at a different
2780
revision than the branch is at.
2781
:param accelerator_tree: A tree which can be used for retrieving file
2782
contents more quickly than the revision tree, i.e. a workingtree.
2783
The revision tree will be used for cases where accelerator_tree's
2784
content is different.
2785
:param hardlink: If true, hard-link files from accelerator_tree,
2788
if not isinstance(a_bzrdir.transport, LocalTransport):
2789
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2790
transport = a_bzrdir.get_workingtree_transport(self)
2791
control_files = self._open_control_files(a_bzrdir)
2792
control_files.create_lock()
2793
control_files.lock_write()
2794
transport.put_bytes('format', self.get_format_string(),
2795
mode=control_files._file_mode)
2796
if from_branch is not None:
2797
branch = from_branch
2799
branch = a_bzrdir.open_branch()
2800
if revision_id is None:
2801
revision_id = _mod_revision.ensure_null(branch.last_revision())
2802
# WorkingTree3 can handle an inventory which has a unique root id.
2803
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2804
# those trees. And because there isn't a format bump inbetween, we
2805
# are maintaining compatibility with older clients.
2806
# inv = Inventory(root_id=gen_root_id())
2807
inv = self._initial_inventory()
2808
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2814
_control_files=control_files)
2815
wt.lock_tree_write()
2817
basis_tree = branch.repository.revision_tree(revision_id)
2818
# only set an explicit root id if there is one to set.
2819
if basis_tree.inventory.root is not None:
2820
wt.set_root_id(basis_tree.get_root_id())
2821
if revision_id == NULL_REVISION:
2822
wt.set_parent_trees([])
2824
wt.set_parent_trees([(revision_id, basis_tree)])
2825
transform.build_tree(basis_tree, wt)
2827
# Unlock in this order so that the unlock-triggers-flush in
2828
# WorkingTree is given a chance to fire.
2829
control_files.unlock()
2833
def _initial_inventory(self):
2837
super(WorkingTreeFormat3, self).__init__()
2839
def open(self, a_bzrdir, _found=False):
2840
"""Return the WorkingTree object for a_bzrdir
2842
_found is a private parameter, do not use it. It is used to indicate
2843
if format probing has already been done.
2846
# we are being called directly and must probe.
2847
raise NotImplementedError
2848
if not isinstance(a_bzrdir.transport, LocalTransport):
2849
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2850
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2853
def _open(self, a_bzrdir, control_files):
2854
"""Open the tree itself.
2856
:param a_bzrdir: the dir for the tree.
2857
:param control_files: the control files for the tree.
2859
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2863
_control_files=control_files)
2866
return self.get_format_string()
2869
__default_format = WorkingTreeFormat4()
2870
WorkingTreeFormat.register_format(__default_format)
2871
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2872
WorkingTreeFormat.set_default_format(__default_format)
2873
# formats which have no format string are not discoverable
2874
# and not independently creatable, so are not registered.
2875
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
