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,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
basedir = safe_unicode(basedir)
226
mutter("opening working tree %r", basedir)
227
if deprecated_passed(branch):
228
self._branch = branch
230
self._branch = self.bzrdir.open_branch()
231
self.basedir = realpath(basedir)
232
# if branch is at our basedir and is a format 6 or less
233
if isinstance(self._format, WorkingTreeFormat2):
234
# share control object
235
self._control_files = self.branch.control_files
237
# assume all other formats have their own control files.
238
self._control_files = _control_files
239
# update the whole cache up front and write to disk if anything changed;
240
# in the future we might want to do this more selectively
241
# two possible ways offer themselves : in self._unlock, write the cache
242
# if needed, or, when the cache sees a change, append it to the hash
243
# cache file, and have the parser take the most recent entry for a
245
wt_trans = self.bzrdir.get_workingtree_transport(None)
246
cache_filename = wt_trans.local_abspath('stat-cache')
247
self._hashcache = hashcache.HashCache(basedir, cache_filename,
248
self._control_files._file_mode)
251
# is this scan needed ? it makes things kinda slow.
258
if _inventory is None:
259
# This will be acquired on lock_read() or lock_write()
260
self._inventory_is_modified = False
261
self._inventory = None
263
# the caller of __init__ has provided an inventory,
264
# we assume they know what they are doing - as its only
265
# the Format factory and creation methods that are
266
# permitted to do this.
267
self._set_inventory(_inventory, dirty=False)
268
self._detect_case_handling()
270
def _detect_case_handling(self):
271
wt_trans = self.bzrdir.get_workingtree_transport(None)
273
wt_trans.stat("FoRMaT")
274
except errors.NoSuchFile:
275
self.case_sensitive = True
277
self.case_sensitive = False
279
self._setup_directory_is_tree_reference()
282
fget=lambda self: self._branch,
283
doc="""The branch this WorkingTree is connected to.
285
This cannot be set - it is reflective of the actual disk structure
286
the working tree has been constructed from.
289
def break_lock(self):
290
"""Break a lock if one is present from another instance.
292
Uses the ui factory to ask for confirmation if the lock may be from
295
This will probe the repository for its lock as well.
297
self._control_files.break_lock()
298
self.branch.break_lock()
300
def requires_rich_root(self):
301
return self._format.requires_rich_root
303
def supports_tree_reference(self):
306
def _set_inventory(self, inv, dirty):
307
"""Set the internal cached inventory.
309
:param inv: The inventory to set.
310
:param dirty: A boolean indicating whether the inventory is the same
311
logical inventory as whats on disk. If True the inventory is not
312
the same and should be written to disk or data will be lost, if
313
False then the inventory is the same as that on disk and any
314
serialisation would be unneeded overhead.
316
self._inventory = inv
317
self._inventory_is_modified = dirty
320
def open(path=None, _unsupported=False):
321
"""Open an existing working tree at path.
325
path = os.path.getcwdu()
326
control = bzrdir.BzrDir.open(path, _unsupported)
327
return control.open_workingtree(_unsupported)
330
def open_containing(path=None):
331
"""Open an existing working tree which has its root about path.
333
This probes for a working tree at path and searches upwards from there.
335
Basically we keep looking up until we find the control directory or
336
run into /. If there isn't one, raises NotBranchError.
337
TODO: give this a new exception.
338
If there is one, it is returned, along with the unused portion of path.
340
:return: The WorkingTree that contains 'path', and the rest of path
343
path = osutils.getcwd()
344
control, relpath = bzrdir.BzrDir.open_containing(path)
346
return control.open_workingtree(), relpath
349
def open_downlevel(path=None):
350
"""Open an unsupported working tree.
352
Only intended for advanced situations like upgrading part of a bzrdir.
354
return WorkingTree.open(path, _unsupported=True)
357
def find_trees(location):
358
def list_current(transport):
359
return [d for d in transport.list_dir('') if d != '.bzr']
360
def evaluate(bzrdir):
362
tree = bzrdir.open_workingtree()
363
except errors.NoWorkingTree:
367
transport = get_transport(location)
368
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
369
list_current=list_current)
370
return [t for t in iterator if t is not None]
372
# should be deprecated - this is slow and in any case treating them as a
373
# container is (we now know) bad style -- mbp 20070302
374
## @deprecated_method(zero_fifteen)
376
"""Iterate through file_ids for this tree.
378
file_ids are in a WorkingTree if they are in the working inventory
379
and the working file exists.
381
inv = self._inventory
382
for path, ie in inv.iter_entries():
383
if osutils.lexists(self.abspath(path)):
386
def all_file_ids(self):
387
"""See Tree.iter_all_file_ids"""
388
return set(self.inventory)
391
return "<%s of %s>" % (self.__class__.__name__,
392
getattr(self, 'basedir', None))
394
def abspath(self, filename):
395
return pathjoin(self.basedir, filename)
397
def basis_tree(self):
398
"""Return RevisionTree for the current last revision.
400
If the left most parent is a ghost then the returned tree will be an
401
empty tree - one obtained by calling repository.revision_tree(None).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(None)
411
return self.revision_tree(revision_id)
412
except errors.NoSuchRevision:
414
# No cached copy available, retrieve from the repository.
415
# FIXME? RBC 20060403 should we cache the inventory locally
418
return self.branch.repository.revision_tree(revision_id)
419
except errors.RevisionNotPresent:
420
# the basis tree *may* be a ghost or a low level error may have
421
# occured. If the revision is present, its a problem, if its not
423
if self.branch.repository.has_revision(revision_id):
425
# the basis tree is a ghost so return an empty tree.
426
return self.branch.repository.revision_tree(None)
429
self._flush_ignore_list_cache()
432
@deprecated_method(zero_eight)
433
def create(branch, directory):
434
"""Create a workingtree for branch at directory.
436
If existing_directory already exists it must have a .bzr directory.
437
If it does not exist, it will be created.
439
This returns a new WorkingTree object for the new checkout.
441
TODO FIXME RBC 20060124 when we have checkout formats in place this
442
should accept an optional revisionid to checkout [and reject this if
443
checking out into the same dir as a pre-checkout-aware branch format.]
445
XXX: When BzrDir is present, these should be created through that
448
warnings.warn('delete WorkingTree.create', stacklevel=3)
449
transport = get_transport(directory)
450
if branch.bzrdir.root_transport.base == transport.base:
452
return branch.bzrdir.create_workingtree()
453
# different directory,
454
# create a branch reference
455
# and now a working tree.
456
raise NotImplementedError
459
@deprecated_method(zero_eight)
460
def create_standalone(directory):
461
"""Create a checkout and a branch and a repo at directory.
463
Directory must exist and be empty.
465
please use BzrDir.create_standalone_workingtree
467
return bzrdir.BzrDir.create_standalone_workingtree(directory)
469
def relpath(self, path):
470
"""Return the local path portion from a given path.
472
The path may be absolute or relative. If its a relative path it is
473
interpreted relative to the python current working directory.
475
return osutils.relpath(self.basedir, path)
477
def has_filename(self, filename):
478
return osutils.lexists(self.abspath(filename))
480
def get_file(self, file_id, path=None):
482
path = self.id2path(file_id)
483
return self.get_file_byname(path)
485
def get_file_text(self, file_id):
486
return self.get_file(file_id).read()
488
def get_file_byname(self, filename):
489
return file(self.abspath(filename), 'rb')
492
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
"""See Tree.annotate_iter
495
This implementation will use the basis tree implementation if possible.
496
Lines not in the basis are attributed to CURRENT_REVISION
498
If there are pending merges, lines added by those merges will be
499
incorrectly attributed to CURRENT_REVISION (but after committing, the
500
attribution will be correct).
502
basis = self.basis_tree()
505
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
506
require_versioned=True).next()
507
changed_content, kind = changes[2], changes[6]
508
if not changed_content:
509
return basis.annotate_iter(file_id)
513
if kind[0] != 'file':
516
old_lines = list(basis.annotate_iter(file_id))
518
for tree in self.branch.repository.revision_trees(
519
self.get_parent_ids()[1:]):
520
if file_id not in tree:
522
old.append(list(tree.annotate_iter(file_id)))
523
return annotate.reannotate(old, self.get_file(file_id).readlines(),
528
def _get_ancestors(self, default_revision):
529
ancestors = set([default_revision])
530
for parent_id in self.get_parent_ids():
531
ancestors.update(self.branch.repository.get_ancestry(
532
parent_id, topo_sorted=False))
535
def get_parent_ids(self):
536
"""See Tree.get_parent_ids.
538
This implementation reads the pending merges list and last_revision
539
value and uses that to decide what the parents list should be.
541
last_rev = _mod_revision.ensure_null(self._last_revision())
542
if _mod_revision.NULL_REVISION == last_rev:
547
merges_file = self._control_files.get('pending-merges')
548
except errors.NoSuchFile:
551
for l in merges_file.readlines():
552
revision_id = l.rstrip('\n')
553
parents.append(revision_id)
557
def get_root_id(self):
558
"""Return the id of this trees root"""
559
return self._inventory.root.file_id
561
def _get_store_filename(self, file_id):
562
## XXX: badly named; this is not in the store at all
563
return self.abspath(self.id2path(file_id))
566
def clone(self, to_bzrdir, revision_id=None):
567
"""Duplicate this working tree into to_bzr, including all state.
569
Specifically modified files are kept as modified, but
570
ignored and unknown files are discarded.
572
If you want to make a new line of development, see bzrdir.sprout()
575
If not None, the cloned tree will have its last revision set to
576
revision, and and difference between the source trees last revision
577
and this one merged in.
579
# assumes the target bzr dir format is compatible.
580
result = self._format.initialize(to_bzrdir)
581
self.copy_content_into(result, revision_id)
585
def copy_content_into(self, tree, revision_id=None):
586
"""Copy the current content and user files of this tree into tree."""
587
tree.set_root_id(self.get_root_id())
588
if revision_id is None:
589
merge.transform_tree(tree, self)
591
# TODO now merge from tree.last_revision to revision (to preserve
592
# user local changes)
593
merge.transform_tree(tree, self)
594
tree.set_parent_ids([revision_id])
596
def id2abspath(self, file_id):
597
return self.abspath(self.id2path(file_id))
599
def has_id(self, file_id):
600
# files that have been deleted are excluded
602
if not inv.has_id(file_id):
604
path = inv.id2path(file_id)
605
return osutils.lexists(self.abspath(path))
607
def has_or_had_id(self, file_id):
608
if file_id == self.inventory.root.file_id:
610
return self.inventory.has_id(file_id)
612
__contains__ = has_id
614
def get_file_size(self, file_id):
615
return os.path.getsize(self.id2abspath(file_id))
618
def get_file_sha1(self, file_id, path=None, stat_value=None):
620
path = self._inventory.id2path(file_id)
621
return self._hashcache.get_sha1(path, stat_value)
623
def get_file_mtime(self, file_id, path=None):
625
path = self.inventory.id2path(file_id)
626
return os.lstat(self.abspath(path)).st_mtime
628
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
629
file_id = self.path2id(path)
630
return self._inventory[file_id].executable
632
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
633
mode = stat_result.st_mode
634
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
636
if not supports_executable():
637
def is_executable(self, file_id, path=None):
638
return self._inventory[file_id].executable
640
_is_executable_from_path_and_stat = \
641
_is_executable_from_path_and_stat_from_basis
643
def is_executable(self, file_id, path=None):
645
path = self.id2path(file_id)
646
mode = os.lstat(self.abspath(path)).st_mode
647
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
649
_is_executable_from_path_and_stat = \
650
_is_executable_from_path_and_stat_from_stat
652
@needs_tree_write_lock
653
def _add(self, files, ids, kinds):
654
"""See MutableTree._add."""
655
# TODO: Re-adding a file that is removed in the working copy
656
# should probably put it back with the previous ID.
657
# the read and write working inventory should not occur in this
658
# function - they should be part of lock_write and unlock.
660
for f, file_id, kind in zip(files, ids, kinds):
662
inv.add_path(f, kind=kind)
664
inv.add_path(f, kind=kind, file_id=file_id)
665
self._inventory_is_modified = True
667
@needs_tree_write_lock
668
def _gather_kinds(self, files, kinds):
669
"""See MutableTree._gather_kinds."""
670
for pos, f in enumerate(files):
671
if kinds[pos] is None:
672
fullpath = normpath(self.abspath(f))
674
kinds[pos] = file_kind(fullpath)
676
if e.errno == errno.ENOENT:
677
raise errors.NoSuchFile(fullpath)
680
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
681
"""Add revision_id as a parent.
683
This is equivalent to retrieving the current list of parent ids
684
and setting the list to its value plus revision_id.
686
:param revision_id: The revision id to add to the parent list. It may
687
be a ghost revision as long as its not the first parent to be added,
688
or the allow_leftmost_as_ghost parameter is set True.
689
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
691
parents = self.get_parent_ids() + [revision_id]
692
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
693
or allow_leftmost_as_ghost)
695
@needs_tree_write_lock
696
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
697
"""Add revision_id, tree tuple as a parent.
699
This is equivalent to retrieving the current list of parent trees
700
and setting the list to its value plus parent_tuple. See also
701
add_parent_tree_id - if you only have a parent id available it will be
702
simpler to use that api. If you have the parent already available, using
703
this api is preferred.
705
:param parent_tuple: The (revision id, tree) to add to the parent list.
706
If the revision_id is a ghost, pass None for the tree.
707
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
709
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
710
if len(parent_ids) > 1:
711
# the leftmost may have already been a ghost, preserve that if it
713
allow_leftmost_as_ghost = True
714
self.set_parent_ids(parent_ids,
715
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
717
@needs_tree_write_lock
718
def add_pending_merge(self, *revision_ids):
719
# TODO: Perhaps should check at this point that the
720
# history of the revision is actually present?
721
parents = self.get_parent_ids()
723
for rev_id in revision_ids:
724
if rev_id in parents:
726
parents.append(rev_id)
729
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
731
def path_content_summary(self, path, _lstat=os.lstat,
732
_mapper=osutils.file_kind_from_stat_mode):
733
"""See Tree.path_content_summary."""
734
abspath = self.abspath(path)
736
stat_result = _lstat(abspath)
738
if getattr(e, 'errno', None) == errno.ENOENT:
740
return ('missing', None, None, None)
741
# propagate other errors
743
kind = _mapper(stat_result.st_mode)
745
size = stat_result.st_size
746
# try for a stat cache lookup
747
executable = self._is_executable_from_path_and_stat(path, stat_result)
748
return (kind, size, executable, self._sha_from_stat(
750
elif kind == 'directory':
751
# perhaps it looks like a plain directory, but it's really a
753
if self._directory_is_tree_reference(path):
754
kind = 'tree-reference'
755
return kind, None, None, None
756
elif kind == 'symlink':
757
return ('symlink', None, None, os.readlink(abspath))
759
return (kind, None, None, None)
761
@deprecated_method(zero_eleven)
763
def pending_merges(self):
764
"""Return a list of pending merges.
766
These are revisions that have been merged into the working
767
directory but not yet committed.
769
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
770
instead - which is available on all tree objects.
772
return self.get_parent_ids()[1:]
774
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
775
"""Common ghost checking functionality from set_parent_*.
777
This checks that the left hand-parent exists if there are any
780
if len(revision_ids) > 0:
781
leftmost_id = revision_ids[0]
782
if (not allow_leftmost_as_ghost and not
783
self.branch.repository.has_revision(leftmost_id)):
784
raise errors.GhostRevisionUnusableHere(leftmost_id)
786
def _set_merges_from_parent_ids(self, parent_ids):
787
merges = parent_ids[1:]
788
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
790
@needs_tree_write_lock
791
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
792
"""Set the parent ids to revision_ids.
794
See also set_parent_trees. This api will try to retrieve the tree data
795
for each element of revision_ids from the trees repository. If you have
796
tree data already available, it is more efficient to use
797
set_parent_trees rather than set_parent_ids. set_parent_ids is however
798
an easier API to use.
800
:param revision_ids: The revision_ids to set as the parent ids of this
801
working tree. Any of these may be ghosts.
803
self._check_parents_for_ghosts(revision_ids,
804
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
805
for revision_id in revision_ids:
806
_mod_revision.check_not_reserved_id(revision_id)
808
if len(revision_ids) > 0:
809
self.set_last_revision(revision_ids[0])
811
self.set_last_revision(_mod_revision.NULL_REVISION)
813
self._set_merges_from_parent_ids(revision_ids)
815
@needs_tree_write_lock
816
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
817
"""See MutableTree.set_parent_trees."""
818
parent_ids = [rev for (rev, tree) in parents_list]
819
for revision_id in parent_ids:
820
_mod_revision.check_not_reserved_id(revision_id)
822
self._check_parents_for_ghosts(parent_ids,
823
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
825
if len(parent_ids) == 0:
826
leftmost_parent_id = _mod_revision.NULL_REVISION
827
leftmost_parent_tree = None
829
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
831
if self._change_last_revision(leftmost_parent_id):
832
if leftmost_parent_tree is None:
833
# If we don't have a tree, fall back to reading the
834
# parent tree from the repository.
835
self._cache_basis_inventory(leftmost_parent_id)
837
inv = leftmost_parent_tree.inventory
838
xml = self._create_basis_xml_from_inventory(
839
leftmost_parent_id, inv)
840
self._write_basis_inventory(xml)
841
self._set_merges_from_parent_ids(parent_ids)
843
@needs_tree_write_lock
844
def set_pending_merges(self, rev_list):
845
parents = self.get_parent_ids()
846
leftmost = parents[:1]
847
new_parents = leftmost + rev_list
848
self.set_parent_ids(new_parents)
850
@needs_tree_write_lock
851
def set_merge_modified(self, modified_hashes):
853
for file_id, hash in modified_hashes.iteritems():
854
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
855
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
857
def _sha_from_stat(self, path, stat_result):
858
"""Get a sha digest from the tree's stat cache.
860
The default implementation assumes no stat cache is present.
862
:param path: The path.
863
:param stat_result: The stat result being looked up.
867
def _put_rio(self, filename, stanzas, header):
868
self._must_be_locked()
869
my_file = rio_file(stanzas, header)
870
self._control_files.put(filename, my_file)
872
@needs_write_lock # because merge pulls data into the branch.
873
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
875
"""Merge from a branch into this working tree.
877
:param branch: The branch to merge from.
878
:param to_revision: If non-None, the merge will merge to to_revision,
879
but not beyond it. to_revision does not need to be in the history
880
of the branch when it is supplied. If None, to_revision defaults to
881
branch.last_revision().
883
from bzrlib.merge import Merger, Merge3Merger
884
pb = bzrlib.ui.ui_factory.nested_progress_bar()
886
merger = Merger(self.branch, this_tree=self, pb=pb)
887
merger.pp = ProgressPhase("Merge phase", 5, pb)
888
merger.pp.next_phase()
889
# check that there are no
891
merger.check_basis(check_clean=True, require_commits=False)
892
if to_revision is None:
893
to_revision = _mod_revision.ensure_null(branch.last_revision())
894
merger.other_rev_id = to_revision
895
if _mod_revision.is_null(merger.other_rev_id):
896
raise errors.NoCommits(branch)
897
self.branch.fetch(branch, last_revision=merger.other_rev_id)
898
merger.other_basis = merger.other_rev_id
899
merger.other_tree = self.branch.repository.revision_tree(
901
merger.other_branch = branch
902
merger.pp.next_phase()
903
if from_revision is None:
906
merger.set_base_revision(from_revision, branch)
907
if merger.base_rev_id == merger.other_rev_id:
908
raise errors.PointlessMerge
909
merger.backup_files = False
910
if merge_type is None:
911
merger.merge_type = Merge3Merger
913
merger.merge_type = merge_type
914
merger.set_interesting_files(None)
915
merger.show_base = False
916
merger.reprocess = False
917
conflicts = merger.do_merge()
924
def merge_modified(self):
925
"""Return a dictionary of files modified by a merge.
927
The list is initialized by WorkingTree.set_merge_modified, which is
928
typically called after we make some automatic updates to the tree
931
This returns a map of file_id->sha1, containing only files which are
932
still in the working inventory and have that text hash.
935
hashfile = self._control_files.get('merge-hashes')
936
except errors.NoSuchFile:
940
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
941
raise errors.MergeModifiedFormatError()
942
except StopIteration:
943
raise errors.MergeModifiedFormatError()
944
for s in RioReader(hashfile):
945
# RioReader reads in Unicode, so convert file_ids back to utf8
946
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
947
if file_id not in self.inventory:
949
text_hash = s.get("hash")
950
if text_hash == self.get_file_sha1(file_id):
951
merge_hashes[file_id] = text_hash
955
def mkdir(self, path, file_id=None):
956
"""See MutableTree.mkdir()."""
958
file_id = generate_ids.gen_file_id(os.path.basename(path))
959
os.mkdir(self.abspath(path))
960
self.add(path, file_id, 'directory')
963
def get_symlink_target(self, file_id):
964
return os.readlink(self.id2abspath(file_id))
967
def subsume(self, other_tree):
968
def add_children(inventory, entry):
969
for child_entry in entry.children.values():
970
inventory._byid[child_entry.file_id] = child_entry
971
if child_entry.kind == 'directory':
972
add_children(inventory, child_entry)
973
if other_tree.get_root_id() == self.get_root_id():
974
raise errors.BadSubsumeSource(self, other_tree,
975
'Trees have the same root')
977
other_tree_path = self.relpath(other_tree.basedir)
978
except errors.PathNotChild:
979
raise errors.BadSubsumeSource(self, other_tree,
980
'Tree is not contained by the other')
981
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
982
if new_root_parent is None:
983
raise errors.BadSubsumeSource(self, other_tree,
984
'Parent directory is not versioned.')
985
# We need to ensure that the result of a fetch will have a
986
# versionedfile for the other_tree root, and only fetching into
987
# RepositoryKnit2 guarantees that.
988
if not self.branch.repository.supports_rich_root():
989
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
990
other_tree.lock_tree_write()
992
new_parents = other_tree.get_parent_ids()
993
other_root = other_tree.inventory.root
994
other_root.parent_id = new_root_parent
995
other_root.name = osutils.basename(other_tree_path)
996
self.inventory.add(other_root)
997
add_children(self.inventory, other_root)
998
self._write_inventory(self.inventory)
999
# normally we don't want to fetch whole repositories, but i think
1000
# here we really do want to consolidate the whole thing.
1001
for parent_id in other_tree.get_parent_ids():
1002
self.branch.fetch(other_tree.branch, parent_id)
1003
self.add_parent_tree_id(parent_id)
1006
other_tree.bzrdir.retire_bzrdir()
1008
def _setup_directory_is_tree_reference(self):
1009
if self._branch.repository._format.supports_tree_reference:
1010
self._directory_is_tree_reference = \
1011
self._directory_may_be_tree_reference
1013
self._directory_is_tree_reference = \
1014
self._directory_is_never_tree_reference
1016
def _directory_is_never_tree_reference(self, relpath):
1019
def _directory_may_be_tree_reference(self, relpath):
1020
# as a special case, if a directory contains control files then
1021
# it's a tree reference, except that the root of the tree is not
1022
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1023
# TODO: We could ask all the control formats whether they
1024
# recognize this directory, but at the moment there's no cheap api
1025
# to do that. Since we probably can only nest bzr checkouts and
1026
# they always use this name it's ok for now. -- mbp 20060306
1028
# FIXME: There is an unhandled case here of a subdirectory
1029
# containing .bzr but not a branch; that will probably blow up
1030
# when you try to commit it. It might happen if there is a
1031
# checkout in a subdirectory. This can be avoided by not adding
1034
@needs_tree_write_lock
1035
def extract(self, file_id, format=None):
1036
"""Extract a subtree from this tree.
1038
A new branch will be created, relative to the path for this tree.
1042
segments = osutils.splitpath(path)
1043
transport = self.branch.bzrdir.root_transport
1044
for name in segments:
1045
transport = transport.clone(name)
1046
transport.ensure_base()
1049
sub_path = self.id2path(file_id)
1050
branch_transport = mkdirs(sub_path)
1052
format = self.bzrdir.cloning_metadir()
1053
branch_transport.ensure_base()
1054
branch_bzrdir = format.initialize_on_transport(branch_transport)
1056
repo = branch_bzrdir.find_repository()
1057
except errors.NoRepositoryPresent:
1058
repo = branch_bzrdir.create_repository()
1059
if not repo.supports_rich_root():
1060
raise errors.RootNotRich()
1061
new_branch = branch_bzrdir.create_branch()
1062
new_branch.pull(self.branch)
1063
for parent_id in self.get_parent_ids():
1064
new_branch.fetch(self.branch, parent_id)
1065
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1066
if tree_transport.base != branch_transport.base:
1067
tree_bzrdir = format.initialize_on_transport(tree_transport)
1068
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1070
tree_bzrdir = branch_bzrdir
1071
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1072
wt.set_parent_ids(self.get_parent_ids())
1073
my_inv = self.inventory
1074
child_inv = Inventory(root_id=None)
1075
new_root = my_inv[file_id]
1076
my_inv.remove_recursive_id(file_id)
1077
new_root.parent_id = None
1078
child_inv.add(new_root)
1079
self._write_inventory(my_inv)
1080
wt._write_inventory(child_inv)
1083
def _serialize(self, inventory, out_file):
1084
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1087
def _deserialize(selt, in_file):
1088
return xml5.serializer_v5.read_inventory(in_file)
1091
"""Write the in memory inventory to disk."""
1092
# TODO: Maybe this should only write on dirty ?
1093
if self._control_files._lock_mode != 'w':
1094
raise errors.NotWriteLocked(self)
1096
self._serialize(self._inventory, sio)
1098
self._control_files.put('inventory', sio)
1099
self._inventory_is_modified = False
1101
def _kind(self, relpath):
1102
return osutils.file_kind(self.abspath(relpath))
1104
def list_files(self, include_root=False):
1105
"""Recursively list all files as (path, class, kind, id, entry).
1107
Lists, but does not descend into unversioned directories.
1109
This does not include files that have been deleted in this
1112
Skips the control directory.
1114
# list_files is an iterator, so @needs_read_lock doesn't work properly
1115
# with it. So callers should be careful to always read_lock the tree.
1116
if not self.is_locked():
1117
raise errors.ObjectNotLocked(self)
1119
inv = self.inventory
1120
if include_root is True:
1121
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1122
# Convert these into local objects to save lookup times
1123
pathjoin = osutils.pathjoin
1124
file_kind = self._kind
1126
# transport.base ends in a slash, we want the piece
1127
# between the last two slashes
1128
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1130
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1132
# directory file_id, relative path, absolute path, reverse sorted children
1133
children = os.listdir(self.basedir)
1135
# jam 20060527 The kernel sized tree seems equivalent whether we
1136
# use a deque and popleft to keep them sorted, or if we use a plain
1137
# list and just reverse() them.
1138
children = collections.deque(children)
1139
stack = [(inv.root.file_id, u'', self.basedir, children)]
1141
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1144
f = children.popleft()
1145
## TODO: If we find a subdirectory with its own .bzr
1146
## directory, then that is a separate tree and we
1147
## should exclude it.
1149
# the bzrdir for this tree
1150
if transport_base_dir == f:
1153
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1154
# and 'f' doesn't begin with one, we can do a string op, rather
1155
# than the checks of pathjoin(), all relative paths will have an extra slash
1157
fp = from_dir_relpath + '/' + f
1160
fap = from_dir_abspath + '/' + f
1162
f_ie = inv.get_child(from_dir_id, f)
1165
elif self.is_ignored(fp[1:]):
1168
# we may not have found this file, because of a unicode issue
1169
f_norm, can_access = osutils.normalized_filename(f)
1170
if f == f_norm or not can_access:
1171
# No change, so treat this file normally
1174
# this file can be accessed by a normalized path
1175
# check again if it is versioned
1176
# these lines are repeated here for performance
1178
fp = from_dir_relpath + '/' + f
1179
fap = from_dir_abspath + '/' + f
1180
f_ie = inv.get_child(from_dir_id, f)
1183
elif self.is_ignored(fp[1:]):
1190
# make a last minute entry
1192
yield fp[1:], c, fk, f_ie.file_id, f_ie
1195
yield fp[1:], c, fk, None, fk_entries[fk]()
1197
yield fp[1:], c, fk, None, TreeEntry()
1200
if fk != 'directory':
1203
# But do this child first
1204
new_children = os.listdir(fap)
1206
new_children = collections.deque(new_children)
1207
stack.append((f_ie.file_id, fp, fap, new_children))
1208
# Break out of inner loop,
1209
# so that we start outer loop with child
1212
# if we finished all children, pop it off the stack
1215
@needs_tree_write_lock
1216
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1219
to_dir must exist in the inventory.
1221
If to_dir exists and is a directory, the files are moved into
1222
it, keeping their old names.
1224
Note that to_dir is only the last component of the new name;
1225
this doesn't change the directory.
1227
For each entry in from_paths the move mode will be determined
1230
The first mode moves the file in the filesystem and updates the
1231
inventory. The second mode only updates the inventory without
1232
touching the file on the filesystem. This is the new mode introduced
1235
move uses the second mode if 'after == True' and the target is not
1236
versioned but present in the working tree.
1238
move uses the second mode if 'after == False' and the source is
1239
versioned but no longer in the working tree, and the target is not
1240
versioned but present in the working tree.
1242
move uses the first mode if 'after == False' and the source is
1243
versioned and present in the working tree, and the target is not
1244
versioned and not present in the working tree.
1246
Everything else results in an error.
1248
This returns a list of (from_path, to_path) pairs for each
1249
entry that is moved.
1254
# check for deprecated use of signature
1256
to_dir = kwargs.get('to_name', None)
1258
raise TypeError('You must supply a target directory')
1260
symbol_versioning.warn('The parameter to_name was deprecated'
1261
' in version 0.13. Use to_dir instead',
1264
# check destination directory
1265
if isinstance(from_paths, basestring):
1267
inv = self.inventory
1268
to_abs = self.abspath(to_dir)
1269
if not isdir(to_abs):
1270
raise errors.BzrMoveFailedError('',to_dir,
1271
errors.NotADirectory(to_abs))
1272
if not self.has_filename(to_dir):
1273
raise errors.BzrMoveFailedError('',to_dir,
1274
errors.NotInWorkingDirectory(to_dir))
1275
to_dir_id = inv.path2id(to_dir)
1276
if to_dir_id is None:
1277
raise errors.BzrMoveFailedError('',to_dir,
1278
errors.NotVersionedError(path=str(to_dir)))
1280
to_dir_ie = inv[to_dir_id]
1281
if to_dir_ie.kind != 'directory':
1282
raise errors.BzrMoveFailedError('',to_dir,
1283
errors.NotADirectory(to_abs))
1285
# create rename entries and tuples
1286
for from_rel in from_paths:
1287
from_tail = splitpath(from_rel)[-1]
1288
from_id = inv.path2id(from_rel)
1290
raise errors.BzrMoveFailedError(from_rel,to_dir,
1291
errors.NotVersionedError(path=str(from_rel)))
1293
from_entry = inv[from_id]
1294
from_parent_id = from_entry.parent_id
1295
to_rel = pathjoin(to_dir, from_tail)
1296
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1298
from_tail=from_tail,
1299
from_parent_id=from_parent_id,
1300
to_rel=to_rel, to_tail=from_tail,
1301
to_parent_id=to_dir_id)
1302
rename_entries.append(rename_entry)
1303
rename_tuples.append((from_rel, to_rel))
1305
# determine which move mode to use. checks also for movability
1306
rename_entries = self._determine_mv_mode(rename_entries, after)
1308
original_modified = self._inventory_is_modified
1311
self._inventory_is_modified = True
1312
self._move(rename_entries)
1314
# restore the inventory on error
1315
self._inventory_is_modified = original_modified
1317
self._write_inventory(inv)
1318
return rename_tuples
1320
def _determine_mv_mode(self, rename_entries, after=False):
1321
"""Determines for each from-to pair if both inventory and working tree
1322
or only the inventory has to be changed.
1324
Also does basic plausability tests.
1326
inv = self.inventory
1328
for rename_entry in rename_entries:
1329
# store to local variables for easier reference
1330
from_rel = rename_entry.from_rel
1331
from_id = rename_entry.from_id
1332
to_rel = rename_entry.to_rel
1333
to_id = inv.path2id(to_rel)
1334
only_change_inv = False
1336
# check the inventory for source and destination
1338
raise errors.BzrMoveFailedError(from_rel,to_rel,
1339
errors.NotVersionedError(path=str(from_rel)))
1340
if to_id is not None:
1341
raise errors.BzrMoveFailedError(from_rel,to_rel,
1342
errors.AlreadyVersionedError(path=str(to_rel)))
1344
# try to determine the mode for rename (only change inv or change
1345
# inv and file system)
1347
if not self.has_filename(to_rel):
1348
raise errors.BzrMoveFailedError(from_id,to_rel,
1349
errors.NoSuchFile(path=str(to_rel),
1350
extra="New file has not been created yet"))
1351
only_change_inv = True
1352
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1353
only_change_inv = True
1354
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1355
only_change_inv = False
1356
elif (sys.platform == 'win32'
1357
and from_rel.lower() == to_rel.lower()
1358
and self.has_filename(from_rel)):
1359
only_change_inv = False
1361
# something is wrong, so lets determine what exactly
1362
if not self.has_filename(from_rel) and \
1363
not self.has_filename(to_rel):
1364
raise errors.BzrRenameFailedError(from_rel,to_rel,
1365
errors.PathsDoNotExist(paths=(str(from_rel),
1368
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1369
rename_entry.only_change_inv = only_change_inv
1370
return rename_entries
1372
def _move(self, rename_entries):
1373
"""Moves a list of files.
1375
Depending on the value of the flag 'only_change_inv', the
1376
file will be moved on the file system or not.
1378
inv = self.inventory
1381
for entry in rename_entries:
1383
self._move_entry(entry)
1385
self._rollback_move(moved)
1389
def _rollback_move(self, moved):
1390
"""Try to rollback a previous move in case of an filesystem error."""
1391
inv = self.inventory
1394
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1395
entry.to_tail, entry.to_parent_id, entry.from_rel,
1396
entry.from_tail, entry.from_parent_id,
1397
entry.only_change_inv))
1398
except errors.BzrMoveFailedError, e:
1399
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1400
" The working tree is in an inconsistent state."
1401
" Please consider doing a 'bzr revert'."
1402
" Error message is: %s" % e)
1404
def _move_entry(self, entry):
1405
inv = self.inventory
1406
from_rel_abs = self.abspath(entry.from_rel)
1407
to_rel_abs = self.abspath(entry.to_rel)
1408
if from_rel_abs == to_rel_abs:
1409
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1410
"Source and target are identical.")
1412
if not entry.only_change_inv:
1414
osutils.rename(from_rel_abs, to_rel_abs)
1416
raise errors.BzrMoveFailedError(entry.from_rel,
1418
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1420
@needs_tree_write_lock
1421
def rename_one(self, from_rel, to_rel, after=False):
1424
This can change the directory or the filename or both.
1426
rename_one has several 'modes' to work. First, it can rename a physical
1427
file and change the file_id. That is the normal mode. Second, it can
1428
only change the file_id without touching any physical file. This is
1429
the new mode introduced in version 0.15.
1431
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1432
versioned but present in the working tree.
1434
rename_one uses the second mode if 'after == False' and 'from_rel' is
1435
versioned but no longer in the working tree, and 'to_rel' is not
1436
versioned but present in the working tree.
1438
rename_one uses the first mode if 'after == False' and 'from_rel' is
1439
versioned and present in the working tree, and 'to_rel' is not
1440
versioned and not present in the working tree.
1442
Everything else results in an error.
1444
inv = self.inventory
1447
# create rename entries and tuples
1448
from_tail = splitpath(from_rel)[-1]
1449
from_id = inv.path2id(from_rel)
1451
raise errors.BzrRenameFailedError(from_rel,to_rel,
1452
errors.NotVersionedError(path=str(from_rel)))
1453
from_entry = inv[from_id]
1454
from_parent_id = from_entry.parent_id
1455
to_dir, to_tail = os.path.split(to_rel)
1456
to_dir_id = inv.path2id(to_dir)
1457
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1459
from_tail=from_tail,
1460
from_parent_id=from_parent_id,
1461
to_rel=to_rel, to_tail=to_tail,
1462
to_parent_id=to_dir_id)
1463
rename_entries.append(rename_entry)
1465
# determine which move mode to use. checks also for movability
1466
rename_entries = self._determine_mv_mode(rename_entries, after)
1468
# check if the target changed directory and if the target directory is
1470
if to_dir_id is None:
1471
raise errors.BzrMoveFailedError(from_rel,to_rel,
1472
errors.NotVersionedError(path=str(to_dir)))
1474
# all checks done. now we can continue with our actual work
1475
mutter('rename_one:\n'
1480
' to_dir_id {%s}\n',
1481
from_id, from_rel, to_rel, to_dir, to_dir_id)
1483
self._move(rename_entries)
1484
self._write_inventory(inv)
1486
class _RenameEntry(object):
1487
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1488
to_rel, to_tail, to_parent_id, only_change_inv=False):
1489
self.from_rel = from_rel
1490
self.from_id = from_id
1491
self.from_tail = from_tail
1492
self.from_parent_id = from_parent_id
1493
self.to_rel = to_rel
1494
self.to_tail = to_tail
1495
self.to_parent_id = to_parent_id
1496
self.only_change_inv = only_change_inv
1500
"""Return all unknown files.
1502
These are files in the working directory that are not versioned or
1503
control files or ignored.
1505
# force the extras method to be fully executed before returning, to
1506
# prevent race conditions with the lock
1508
[subp for subp in self.extras() if not self.is_ignored(subp)])
1510
@needs_tree_write_lock
1511
def unversion(self, file_ids):
1512
"""Remove the file ids in file_ids from the current versioned set.
1514
When a file_id is unversioned, all of its children are automatically
1517
:param file_ids: The file ids to stop versioning.
1518
:raises: NoSuchId if any fileid is not currently versioned.
1520
for file_id in file_ids:
1521
if self._inventory.has_id(file_id):
1522
self._inventory.remove_recursive_id(file_id)
1524
raise errors.NoSuchId(self, file_id)
1526
# in the future this should just set a dirty bit to wait for the
1527
# final unlock. However, until all methods of workingtree start
1528
# with the current in -memory inventory rather than triggering
1529
# a read, it is more complex - we need to teach read_inventory
1530
# to know when to read, and when to not read first... and possibly
1531
# to save first when the in memory one may be corrupted.
1532
# so for now, we just only write it if it is indeed dirty.
1534
self._write_inventory(self._inventory)
1536
@deprecated_method(zero_eight)
1537
def iter_conflicts(self):
1538
"""List all files in the tree that have text or content conflicts.
1539
DEPRECATED. Use conflicts instead."""
1540
return self._iter_conflicts()
1542
def _iter_conflicts(self):
1544
for info in self.list_files():
1546
stem = get_conflicted_stem(path)
1549
if stem not in conflicted:
1550
conflicted.add(stem)
1554
def pull(self, source, overwrite=False, stop_revision=None,
1555
change_reporter=None, possible_transports=None):
1556
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1559
pp = ProgressPhase("Pull phase", 2, top_pb)
1561
old_revision_info = self.branch.last_revision_info()
1562
basis_tree = self.basis_tree()
1563
count = self.branch.pull(source, overwrite, stop_revision,
1564
possible_transports=possible_transports)
1565
new_revision_info = self.branch.last_revision_info()
1566
if new_revision_info != old_revision_info:
1568
repository = self.branch.repository
1569
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1570
basis_tree.lock_read()
1572
new_basis_tree = self.branch.basis_tree()
1579
change_reporter=change_reporter)
1580
if (basis_tree.inventory.root is None and
1581
new_basis_tree.inventory.root is not None):
1582
self.set_root_id(new_basis_tree.get_root_id())
1586
# TODO - dedup parents list with things merged by pull ?
1587
# reuse the revisiontree we merged against to set the new
1589
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1590
# we have to pull the merge trees out again, because
1591
# merge_inner has set the ids. - this corner is not yet
1592
# layered well enough to prevent double handling.
1593
# XXX TODO: Fix the double handling: telling the tree about
1594
# the already known parent data is wasteful.
1595
merges = self.get_parent_ids()[1:]
1596
parent_trees.extend([
1597
(parent, repository.revision_tree(parent)) for
1599
self.set_parent_trees(parent_trees)
1606
def put_file_bytes_non_atomic(self, file_id, bytes):
1607
"""See MutableTree.put_file_bytes_non_atomic."""
1608
stream = file(self.id2abspath(file_id), 'wb')
1613
# TODO: update the hashcache here ?
1616
"""Yield all unversioned files in this WorkingTree.
1618
If there are any unversioned directories then only the directory is
1619
returned, not all its children. But if there are unversioned files
1620
under a versioned subdirectory, they are returned.
1622
Currently returned depth-first, sorted by name within directories.
1623
This is the same order used by 'osutils.walkdirs'.
1625
## TODO: Work from given directory downwards
1626
for path, dir_entry in self.inventory.directories():
1627
# mutter("search for unknowns in %r", path)
1628
dirabs = self.abspath(path)
1629
if not isdir(dirabs):
1630
# e.g. directory deleted
1634
for subf in os.listdir(dirabs):
1637
if subf not in dir_entry.children:
1638
subf_norm, can_access = osutils.normalized_filename(subf)
1639
if subf_norm != subf and can_access:
1640
if subf_norm not in dir_entry.children:
1641
fl.append(subf_norm)
1647
subp = pathjoin(path, subf)
1650
def ignored_files(self):
1651
"""Yield list of PATH, IGNORE_PATTERN"""
1652
for subp in self.extras():
1653
pat = self.is_ignored(subp)
1657
def get_ignore_list(self):
1658
"""Return list of ignore patterns.
1660
Cached in the Tree object after the first call.
1662
ignoreset = getattr(self, '_ignoreset', None)
1663
if ignoreset is not None:
1666
ignore_globs = set()
1667
ignore_globs.update(ignores.get_runtime_ignores())
1668
ignore_globs.update(ignores.get_user_ignores())
1669
if self.has_filename(bzrlib.IGNORE_FILENAME):
1670
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1672
ignore_globs.update(ignores.parse_ignore_file(f))
1675
self._ignoreset = ignore_globs
1678
def _flush_ignore_list_cache(self):
1679
"""Resets the cached ignore list to force a cache rebuild."""
1680
self._ignoreset = None
1681
self._ignoreglobster = None
1683
def is_ignored(self, filename):
1684
r"""Check whether the filename matches an ignore pattern.
1686
Patterns containing '/' or '\' need to match the whole path;
1687
others match against only the last component.
1689
If the file is ignored, returns the pattern which caused it to
1690
be ignored, otherwise None. So this can simply be used as a
1691
boolean if desired."""
1692
if getattr(self, '_ignoreglobster', None) is None:
1693
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1694
return self._ignoreglobster.match(filename)
1696
def kind(self, file_id):
1697
return file_kind(self.id2abspath(file_id))
1699
def stored_kind(self, file_id):
1700
"""See Tree.stored_kind"""
1701
return self.inventory[file_id].kind
1703
def _comparison_data(self, entry, path):
1704
abspath = self.abspath(path)
1706
stat_value = os.lstat(abspath)
1708
if getattr(e, 'errno', None) == errno.ENOENT:
1715
mode = stat_value.st_mode
1716
kind = osutils.file_kind_from_stat_mode(mode)
1717
if not supports_executable():
1718
executable = entry is not None and entry.executable
1720
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1721
return kind, executable, stat_value
1723
def _file_size(self, entry, stat_value):
1724
return stat_value.st_size
1726
def last_revision(self):
1727
"""Return the last revision of the branch for this tree.
1729
This format tree does not support a separate marker for last-revision
1730
compared to the branch.
1732
See MutableTree.last_revision
1734
return self._last_revision()
1737
def _last_revision(self):
1738
"""helper for get_parent_ids."""
1739
return _mod_revision.ensure_null(self.branch.last_revision())
1741
def is_locked(self):
1742
return self._control_files.is_locked()
1744
def _must_be_locked(self):
1745
if not self.is_locked():
1746
raise errors.ObjectNotLocked(self)
1748
def lock_read(self):
1749
"""See Branch.lock_read, and WorkingTree.unlock."""
1750
if not self.is_locked():
1752
self.branch.lock_read()
1754
return self._control_files.lock_read()
1756
self.branch.unlock()
1759
def lock_tree_write(self):
1760
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1761
if not self.is_locked():
1763
self.branch.lock_read()
1765
return self._control_files.lock_write()
1767
self.branch.unlock()
1770
def lock_write(self):
1771
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1772
if not self.is_locked():
1774
self.branch.lock_write()
1776
return self._control_files.lock_write()
1778
self.branch.unlock()
1781
def get_physical_lock_status(self):
1782
return self._control_files.get_physical_lock_status()
1784
def _basis_inventory_name(self):
1785
return 'basis-inventory-cache'
1787
def _reset_data(self):
1788
"""Reset transient data that cannot be revalidated."""
1789
self._inventory_is_modified = False
1790
result = self._deserialize(self._control_files.get('inventory'))
1791
self._set_inventory(result, dirty=False)
1793
@needs_tree_write_lock
1794
def set_last_revision(self, new_revision):
1795
"""Change the last revision in the working tree."""
1796
if self._change_last_revision(new_revision):
1797
self._cache_basis_inventory(new_revision)
1799
def _change_last_revision(self, new_revision):
1800
"""Template method part of set_last_revision to perform the change.
1802
This is used to allow WorkingTree3 instances to not affect branch
1803
when their last revision is set.
1805
if _mod_revision.is_null(new_revision):
1806
self.branch.set_revision_history([])
1809
self.branch.generate_revision_history(new_revision)
1810
except errors.NoSuchRevision:
1811
# not present in the repo - dont try to set it deeper than the tip
1812
self.branch.set_revision_history([new_revision])
1815
def _write_basis_inventory(self, xml):
1816
"""Write the basis inventory XML to the basis-inventory file"""
1817
path = self._basis_inventory_name()
1819
self._control_files.put(path, sio)
1821
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1822
"""Create the text that will be saved in basis-inventory"""
1823
inventory.revision_id = revision_id
1824
return xml7.serializer_v7.write_inventory_to_string(inventory)
1826
def _cache_basis_inventory(self, new_revision):
1827
"""Cache new_revision as the basis inventory."""
1828
# TODO: this should allow the ready-to-use inventory to be passed in,
1829
# as commit already has that ready-to-use [while the format is the
1832
# this double handles the inventory - unpack and repack -
1833
# but is easier to understand. We can/should put a conditional
1834
# in here based on whether the inventory is in the latest format
1835
# - perhaps we should repack all inventories on a repository
1837
# the fast path is to copy the raw xml from the repository. If the
1838
# xml contains 'revision_id="', then we assume the right
1839
# revision_id is set. We must check for this full string, because a
1840
# root node id can legitimately look like 'revision_id' but cannot
1842
xml = self.branch.repository.get_inventory_xml(new_revision)
1843
firstline = xml.split('\n', 1)[0]
1844
if (not 'revision_id="' in firstline or
1845
'format="7"' not in firstline):
1846
inv = self.branch.repository.deserialise_inventory(
1848
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1849
self._write_basis_inventory(xml)
1850
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1853
def read_basis_inventory(self):
1854
"""Read the cached basis inventory."""
1855
path = self._basis_inventory_name()
1856
return self._control_files.get(path).read()
1859
def read_working_inventory(self):
1860
"""Read the working inventory.
1862
:raises errors.InventoryModified: read_working_inventory will fail
1863
when the current in memory inventory has been modified.
1865
# conceptually this should be an implementation detail of the tree.
1866
# XXX: Deprecate this.
1867
# ElementTree does its own conversion from UTF-8, so open in
1869
if self._inventory_is_modified:
1870
raise errors.InventoryModified(self)
1871
result = self._deserialize(self._control_files.get('inventory'))
1872
self._set_inventory(result, dirty=False)
1875
@needs_tree_write_lock
1876
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1878
"""Remove nominated files from the working inventory.
1880
:files: File paths relative to the basedir.
1881
:keep_files: If true, the files will also be kept.
1882
:force: Delete files and directories, even if they are changed and
1883
even if the directories are not empty.
1885
if isinstance(files, basestring):
1891
unknown_nested_files=set()
1893
def recurse_directory_to_add_files(directory):
1894
# Recurse directory and add all files
1895
# so we can check if they have changed.
1896
for parent_info, file_infos in\
1897
osutils.walkdirs(self.abspath(directory),
1899
for relpath, basename, kind, lstat, abspath in file_infos:
1900
# Is it versioned or ignored?
1901
if self.path2id(relpath) or self.is_ignored(relpath):
1902
# Add nested content for deletion.
1903
new_files.add(relpath)
1905
# Files which are not versioned and not ignored
1906
# should be treated as unknown.
1907
unknown_nested_files.add((relpath, None, kind))
1909
for filename in files:
1910
# Get file name into canonical form.
1911
abspath = self.abspath(filename)
1912
filename = self.relpath(abspath)
1913
if len(filename) > 0:
1914
new_files.add(filename)
1915
if osutils.isdir(abspath):
1916
recurse_directory_to_add_files(filename)
1918
files = list(new_files)
1921
return # nothing to do
1923
# Sort needed to first handle directory content before the directory
1924
files.sort(reverse=True)
1926
# Bail out if we are going to delete files we shouldn't
1927
if not keep_files and not force:
1928
has_changed_files = len(unknown_nested_files) > 0
1929
if not has_changed_files:
1930
for (file_id, path, content_change, versioned, parent_id, name,
1931
kind, executable) in self.iter_changes(self.basis_tree(),
1932
include_unchanged=True, require_versioned=False,
1933
want_unversioned=True, specific_files=files):
1934
if versioned == (False, False):
1935
# The record is unknown ...
1936
if not self.is_ignored(path[1]):
1937
# ... but not ignored
1938
has_changed_files = True
1940
elif content_change and (kind[1] != None):
1941
# Versioned and changed, but not deleted
1942
has_changed_files = True
1945
if has_changed_files:
1946
# Make delta show ALL applicable changes in error message.
1947
tree_delta = self.changes_from(self.basis_tree(),
1948
require_versioned=False, want_unversioned=True,
1949
specific_files=files)
1950
for unknown_file in unknown_nested_files:
1951
if unknown_file not in tree_delta.unversioned:
1952
tree_delta.unversioned.extend((unknown_file,))
1953
raise errors.BzrRemoveChangedFilesError(tree_delta)
1955
# Build inv_delta and delete files where applicaple,
1956
# do this before any modifications to inventory.
1958
fid = self.path2id(f)
1961
message = "%s is not versioned." % (f,)
1964
# having removed it, it must be either ignored or unknown
1965
if self.is_ignored(f):
1969
textui.show_status(new_status, self.kind(fid), f,
1972
inv_delta.append((f, None, fid, None))
1973
message = "removed %s" % (f,)
1976
abs_path = self.abspath(f)
1977
if osutils.lexists(abs_path):
1978
if (osutils.isdir(abs_path) and
1979
len(os.listdir(abs_path)) > 0):
1981
osutils.rmtree(abs_path)
1983
message = "%s is not an empty directory "\
1984
"and won't be deleted." % (f,)
1986
osutils.delete_any(abs_path)
1987
message = "deleted %s" % (f,)
1988
elif message is not None:
1989
# Only care if we haven't done anything yet.
1990
message = "%s does not exist." % (f,)
1992
# Print only one message (if any) per file.
1993
if message is not None:
1995
self.apply_inventory_delta(inv_delta)
1997
@needs_tree_write_lock
1998
def revert(self, filenames=None, old_tree=None, backups=True,
1999
pb=DummyProgress(), report_changes=False):
2000
from bzrlib.conflicts import resolve
2003
symbol_versioning.warn('Using [] to revert all files is deprecated'
2004
' as of bzr 0.91. Please use None (the default) instead.',
2005
DeprecationWarning, stacklevel=2)
2006
if old_tree is None:
2007
basis_tree = self.basis_tree()
2008
basis_tree.lock_read()
2009
old_tree = basis_tree
2013
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2015
if filenames is None and len(self.get_parent_ids()) > 1:
2017
last_revision = self.last_revision()
2018
if last_revision != NULL_REVISION:
2019
if basis_tree is None:
2020
basis_tree = self.basis_tree()
2021
basis_tree.lock_read()
2022
parent_trees.append((last_revision, basis_tree))
2023
self.set_parent_trees(parent_trees)
2026
resolve(self, filenames, ignore_misses=True, recursive=True)
2028
if basis_tree is not None:
2032
def revision_tree(self, revision_id):
2033
"""See Tree.revision_tree.
2035
WorkingTree can supply revision_trees for the basis revision only
2036
because there is only one cached inventory in the bzr directory.
2038
if revision_id == self.last_revision():
2040
xml = self.read_basis_inventory()
2041
except errors.NoSuchFile:
2045
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2046
# dont use the repository revision_tree api because we want
2047
# to supply the inventory.
2048
if inv.revision_id == revision_id:
2049
return revisiontree.RevisionTree(self.branch.repository,
2051
except errors.BadInventoryFormat:
2053
# raise if there was no inventory, or if we read the wrong inventory.
2054
raise errors.NoSuchRevisionInTree(self, revision_id)
2056
# XXX: This method should be deprecated in favour of taking in a proper
2057
# new Inventory object.
2058
@needs_tree_write_lock
2059
def set_inventory(self, new_inventory_list):
2060
from bzrlib.inventory import (Inventory,
2065
inv = Inventory(self.get_root_id())
2066
for path, file_id, parent, kind in new_inventory_list:
2067
name = os.path.basename(path)
2070
# fixme, there should be a factory function inv,add_??
2071
if kind == 'directory':
2072
inv.add(InventoryDirectory(file_id, name, parent))
2073
elif kind == 'file':
2074
inv.add(InventoryFile(file_id, name, parent))
2075
elif kind == 'symlink':
2076
inv.add(InventoryLink(file_id, name, parent))
2078
raise errors.BzrError("unknown kind %r" % kind)
2079
self._write_inventory(inv)
2081
@needs_tree_write_lock
2082
def set_root_id(self, file_id):
2083
"""Set the root id for this tree."""
2086
symbol_versioning.warn(symbol_versioning.zero_twelve
2087
% 'WorkingTree.set_root_id with fileid=None',
2092
file_id = osutils.safe_file_id(file_id)
2093
self._set_root_id(file_id)
2095
def _set_root_id(self, file_id):
2096
"""Set the root id for this tree, in a format specific manner.
2098
:param file_id: The file id to assign to the root. It must not be
2099
present in the current inventory or an error will occur. It must
2100
not be None, but rather a valid file id.
2102
inv = self._inventory
2103
orig_root_id = inv.root.file_id
2104
# TODO: it might be nice to exit early if there was nothing
2105
# to do, saving us from trigger a sync on unlock.
2106
self._inventory_is_modified = True
2107
# we preserve the root inventory entry object, but
2108
# unlinkit from the byid index
2109
del inv._byid[inv.root.file_id]
2110
inv.root.file_id = file_id
2111
# and link it into the index with the new changed id.
2112
inv._byid[inv.root.file_id] = inv.root
2113
# and finally update all children to reference the new id.
2114
# XXX: this should be safe to just look at the root.children
2115
# list, not the WHOLE INVENTORY.
2118
if entry.parent_id == orig_root_id:
2119
entry.parent_id = inv.root.file_id
2122
"""See Branch.unlock.
2124
WorkingTree locking just uses the Branch locking facilities.
2125
This is current because all working trees have an embedded branch
2126
within them. IF in the future, we were to make branch data shareable
2127
between multiple working trees, i.e. via shared storage, then we
2128
would probably want to lock both the local tree, and the branch.
2130
raise NotImplementedError(self.unlock)
2132
def update(self, change_reporter=None, possible_transports=None):
2133
"""Update a working tree along its branch.
2135
This will update the branch if its bound too, which means we have
2136
multiple trees involved:
2138
- The new basis tree of the master.
2139
- The old basis tree of the branch.
2140
- The old basis tree of the working tree.
2141
- The current working tree state.
2143
Pathologically, all three may be different, and non-ancestors of each
2144
other. Conceptually we want to:
2146
- Preserve the wt.basis->wt.state changes
2147
- Transform the wt.basis to the new master basis.
2148
- Apply a merge of the old branch basis to get any 'local' changes from
2150
- Restore the wt.basis->wt.state changes.
2152
There isn't a single operation at the moment to do that, so we:
2153
- Merge current state -> basis tree of the master w.r.t. the old tree
2155
- Do a 'normal' merge of the old branch basis if it is relevant.
2157
if self.branch.get_bound_location() is not None:
2159
update_branch = True
2161
self.lock_tree_write()
2162
update_branch = False
2165
old_tip = self.branch.update(possible_transports)
2168
return self._update_tree(old_tip, change_reporter)
2172
@needs_tree_write_lock
2173
def _update_tree(self, old_tip=None, change_reporter=None):
2174
"""Update a tree to the master branch.
2176
:param old_tip: if supplied, the previous tip revision the branch,
2177
before it was changed to the master branch's tip.
2179
# here if old_tip is not None, it is the old tip of the branch before
2180
# it was updated from the master branch. This should become a pending
2181
# merge in the working tree to preserve the user existing work. we
2182
# cant set that until we update the working trees last revision to be
2183
# one from the new branch, because it will just get absorbed by the
2184
# parent de-duplication logic.
2186
# We MUST save it even if an error occurs, because otherwise the users
2187
# local work is unreferenced and will appear to have been lost.
2191
last_rev = self.get_parent_ids()[0]
2193
last_rev = _mod_revision.NULL_REVISION
2194
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2195
# merge tree state up to new branch tip.
2196
basis = self.basis_tree()
2199
to_tree = self.branch.basis_tree()
2200
if basis.inventory.root is None:
2201
self.set_root_id(to_tree.get_root_id())
2203
result += merge.merge_inner(
2208
change_reporter=change_reporter)
2211
# TODO - dedup parents list with things merged by pull ?
2212
# reuse the tree we've updated to to set the basis:
2213
parent_trees = [(self.branch.last_revision(), to_tree)]
2214
merges = self.get_parent_ids()[1:]
2215
# Ideally we ask the tree for the trees here, that way the working
2216
# tree can decide whether to give us teh entire tree or give us a
2217
# lazy initialised tree. dirstate for instance will have the trees
2218
# in ram already, whereas a last-revision + basis-inventory tree
2219
# will not, but also does not need them when setting parents.
2220
for parent in merges:
2221
parent_trees.append(
2222
(parent, self.branch.repository.revision_tree(parent)))
2223
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2224
parent_trees.append(
2225
(old_tip, self.branch.repository.revision_tree(old_tip)))
2226
self.set_parent_trees(parent_trees)
2227
last_rev = parent_trees[0][0]
2229
# the working tree had the same last-revision as the master
2230
# branch did. We may still have pivot local work from the local
2231
# branch into old_tip:
2232
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2233
self.add_parent_tree_id(old_tip)
2234
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2235
and old_tip != last_rev):
2236
# our last revision was not the prior branch last revision
2237
# and we have converted that last revision to a pending merge.
2238
# base is somewhere between the branch tip now
2239
# and the now pending merge
2241
# Since we just modified the working tree and inventory, flush out
2242
# the current state, before we modify it again.
2243
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2244
# requires it only because TreeTransform directly munges the
2245
# inventory and calls tree._write_inventory(). Ultimately we
2246
# should be able to remove this extra flush.
2248
graph = self.branch.repository.get_graph()
2249
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2251
base_tree = self.branch.repository.revision_tree(base_rev_id)
2252
other_tree = self.branch.repository.revision_tree(old_tip)
2253
result += merge.merge_inner(
2258
change_reporter=change_reporter)
2261
def _write_hashcache_if_dirty(self):
2262
"""Write out the hashcache if it is dirty."""
2263
if self._hashcache.needs_write:
2265
self._hashcache.write()
2267
if e.errno not in (errno.EPERM, errno.EACCES):
2269
# TODO: jam 20061219 Should this be a warning? A single line
2270
# warning might be sufficient to let the user know what
2272
mutter('Could not write hashcache for %s\nError: %s',
2273
self._hashcache.cache_file_name(), e)
2275
@needs_tree_write_lock
2276
def _write_inventory(self, inv):
2277
"""Write inventory as the current inventory."""
2278
self._set_inventory(inv, dirty=True)
2281
def set_conflicts(self, arg):
2282
raise errors.UnsupportedOperation(self.set_conflicts, self)
2284
def add_conflicts(self, arg):
2285
raise errors.UnsupportedOperation(self.add_conflicts, self)
2288
def conflicts(self):
2289
conflicts = _mod_conflicts.ConflictList()
2290
for conflicted in self._iter_conflicts():
2293
if file_kind(self.abspath(conflicted)) != "file":
2295
except errors.NoSuchFile:
2298
for suffix in ('.THIS', '.OTHER'):
2300
kind = file_kind(self.abspath(conflicted+suffix))
2303
except errors.NoSuchFile:
2307
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2308
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2310
file_id=self.path2id(conflicted)))
2313
def walkdirs(self, prefix=""):
2314
"""Walk the directories of this tree.
2316
returns a generator which yields items in the form:
2317
((curren_directory_path, fileid),
2318
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2321
This API returns a generator, which is only valid during the current
2322
tree transaction - within a single lock_read or lock_write duration.
2324
If the tree is not locked, it may cause an error to be raised,
2325
depending on the tree implementation.
2327
disk_top = self.abspath(prefix)
2328
if disk_top.endswith('/'):
2329
disk_top = disk_top[:-1]
2330
top_strip_len = len(disk_top) + 1
2331
inventory_iterator = self._walkdirs(prefix)
2332
disk_iterator = osutils.walkdirs(disk_top, prefix)
2334
current_disk = disk_iterator.next()
2335
disk_finished = False
2337
if not (e.errno == errno.ENOENT or
2338
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2341
disk_finished = True
2343
current_inv = inventory_iterator.next()
2344
inv_finished = False
2345
except StopIteration:
2348
while not inv_finished or not disk_finished:
2350
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2351
cur_disk_dir_content) = current_disk
2353
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2354
cur_disk_dir_content) = ((None, None), None)
2355
if not disk_finished:
2356
# strip out .bzr dirs
2357
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2358
len(cur_disk_dir_content) > 0):
2359
# osutils.walkdirs can be made nicer -
2360
# yield the path-from-prefix rather than the pathjoined
2362
bzrdir_loc = bisect_left(cur_disk_dir_content,
2364
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2365
# we dont yield the contents of, or, .bzr itself.
2366
del cur_disk_dir_content[bzrdir_loc]
2368
# everything is unknown
2371
# everything is missing
2374
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2376
# disk is before inventory - unknown
2377
dirblock = [(relpath, basename, kind, stat, None, None) for
2378
relpath, basename, kind, stat, top_path in
2379
cur_disk_dir_content]
2380
yield (cur_disk_dir_relpath, None), dirblock
2382
current_disk = disk_iterator.next()
2383
except StopIteration:
2384
disk_finished = True
2386
# inventory is before disk - missing.
2387
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2388
for relpath, basename, dkind, stat, fileid, kind in
2390
yield (current_inv[0][0], current_inv[0][1]), dirblock
2392
current_inv = inventory_iterator.next()
2393
except StopIteration:
2396
# versioned present directory
2397
# merge the inventory and disk data together
2399
for relpath, subiterator in itertools.groupby(sorted(
2400
current_inv[1] + cur_disk_dir_content,
2401
key=operator.itemgetter(0)), operator.itemgetter(1)):
2402
path_elements = list(subiterator)
2403
if len(path_elements) == 2:
2404
inv_row, disk_row = path_elements
2405
# versioned, present file
2406
dirblock.append((inv_row[0],
2407
inv_row[1], disk_row[2],
2408
disk_row[3], inv_row[4],
2410
elif len(path_elements[0]) == 5:
2412
dirblock.append((path_elements[0][0],
2413
path_elements[0][1], path_elements[0][2],
2414
path_elements[0][3], None, None))
2415
elif len(path_elements[0]) == 6:
2416
# versioned, absent file.
2417
dirblock.append((path_elements[0][0],
2418
path_elements[0][1], 'unknown', None,
2419
path_elements[0][4], path_elements[0][5]))
2421
raise NotImplementedError('unreachable code')
2422
yield current_inv[0], dirblock
2424
current_inv = inventory_iterator.next()
2425
except StopIteration:
2428
current_disk = disk_iterator.next()
2429
except StopIteration:
2430
disk_finished = True
2432
def _walkdirs(self, prefix=""):
2433
"""Walk the directories of this tree.
2435
:prefix: is used as the directrory to start with.
2436
returns a generator which yields items in the form:
2437
((curren_directory_path, fileid),
2438
[(file1_path, file1_name, file1_kind, None, file1_id,
2441
_directory = 'directory'
2442
# get the root in the inventory
2443
inv = self.inventory
2444
top_id = inv.path2id(prefix)
2448
pending = [(prefix, '', _directory, None, top_id, None)]
2451
currentdir = pending.pop()
2452
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2453
top_id = currentdir[4]
2455
relroot = currentdir[0] + '/'
2458
# FIXME: stash the node in pending
2460
for name, child in entry.sorted_children():
2461
dirblock.append((relroot + name, name, child.kind, None,
2462
child.file_id, child.kind
2464
yield (currentdir[0], entry.file_id), dirblock
2465
# push the user specified dirs from dirblock
2466
for dir in reversed(dirblock):
2467
if dir[2] == _directory:
2470
@needs_tree_write_lock
2471
def auto_resolve(self):
2472
"""Automatically resolve text conflicts according to contents.
2474
Only text conflicts are auto_resolvable. Files with no conflict markers
2475
are considered 'resolved', because bzr always puts conflict markers
2476
into files that have text conflicts. The corresponding .THIS .BASE and
2477
.OTHER files are deleted, as per 'resolve'.
2478
:return: a tuple of ConflictLists: (un_resolved, resolved).
2480
un_resolved = _mod_conflicts.ConflictList()
2481
resolved = _mod_conflicts.ConflictList()
2482
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2483
for conflict in self.conflicts():
2484
if (conflict.typestring != 'text conflict' or
2485
self.kind(conflict.file_id) != 'file'):
2486
un_resolved.append(conflict)
2488
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2490
for line in my_file:
2491
if conflict_re.search(line):
2492
un_resolved.append(conflict)
2495
resolved.append(conflict)
2498
resolved.remove_files(self)
2499
self.set_conflicts(un_resolved)
2500
return un_resolved, resolved
2502
def _validate(self):
2503
"""Validate internal structures.
2505
This is meant mostly for the test suite. To give it a chance to detect
2506
corruption after actions have occurred. The default implementation is a
2509
:return: None. An exception should be raised if there is an error.
2514
class WorkingTree2(WorkingTree):
2515
"""This is the Format 2 working tree.
2517
This was the first weave based working tree.
2518
- uses os locks for locking.
2519
- uses the branch last-revision.
2522
def __init__(self, *args, **kwargs):
2523
super(WorkingTree2, self).__init__(*args, **kwargs)
2524
# WorkingTree2 has more of a constraint that self._inventory must
2525
# exist. Because this is an older format, we don't mind the overhead
2526
# caused by the extra computation here.
2528
# Newer WorkingTree's should only have self._inventory set when they
2530
if self._inventory is None:
2531
self.read_working_inventory()
2533
def lock_tree_write(self):
2534
"""See WorkingTree.lock_tree_write().
2536
In Format2 WorkingTrees we have a single lock for the branch and tree
2537
so lock_tree_write() degrades to lock_write().
2539
self.branch.lock_write()
2541
return self._control_files.lock_write()
2543
self.branch.unlock()
2547
# do non-implementation specific cleanup
2550
# we share control files:
2551
if self._control_files._lock_count == 3:
2552
# _inventory_is_modified is always False during a read lock.
2553
if self._inventory_is_modified:
2555
self._write_hashcache_if_dirty()
2557
# reverse order of locking.
2559
return self._control_files.unlock()
2561
self.branch.unlock()
2564
class WorkingTree3(WorkingTree):
2565
"""This is the Format 3 working tree.
2567
This differs from the base WorkingTree by:
2568
- having its own file lock
2569
- having its own last-revision property.
2571
This is new in bzr 0.8
2575
def _last_revision(self):
2576
"""See Mutable.last_revision."""
2578
return self._control_files.get('last-revision').read()
2579
except errors.NoSuchFile:
2580
return _mod_revision.NULL_REVISION
2582
def _change_last_revision(self, revision_id):
2583
"""See WorkingTree._change_last_revision."""
2584
if revision_id is None or revision_id == NULL_REVISION:
2586
self._control_files._transport.delete('last-revision')
2587
except errors.NoSuchFile:
2591
self._control_files.put_bytes('last-revision', revision_id)
2594
@needs_tree_write_lock
2595
def set_conflicts(self, conflicts):
2596
self._put_rio('conflicts', conflicts.to_stanzas(),
2599
@needs_tree_write_lock
2600
def add_conflicts(self, new_conflicts):
2601
conflict_set = set(self.conflicts())
2602
conflict_set.update(set(list(new_conflicts)))
2603
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2604
key=_mod_conflicts.Conflict.sort_key)))
2607
def conflicts(self):
2609
confile = self._control_files.get('conflicts')
2610
except errors.NoSuchFile:
2611
return _mod_conflicts.ConflictList()
2613
if confile.next() != CONFLICT_HEADER_1 + '\n':
2614
raise errors.ConflictFormatError()
2615
except StopIteration:
2616
raise errors.ConflictFormatError()
2617
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2620
# do non-implementation specific cleanup
2622
if self._control_files._lock_count == 1:
2623
# _inventory_is_modified is always False during a read lock.
2624
if self._inventory_is_modified:
2626
self._write_hashcache_if_dirty()
2627
# reverse order of locking.
2629
return self._control_files.unlock()
2631
self.branch.unlock()
2634
def get_conflicted_stem(path):
2635
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2636
if path.endswith(suffix):
2637
return path[:-len(suffix)]
2640
@deprecated_function(zero_eight)
2641
def is_control_file(filename):
2642
"""See WorkingTree.is_control_filename(filename)."""
2643
## FIXME: better check
2644
filename = normpath(filename)
2645
while filename != '':
2646
head, tail = os.path.split(filename)
2647
## mutter('check %r for control file' % ((head, tail),))
2650
if filename == head:
2656
class WorkingTreeFormat(object):
2657
"""An encapsulation of the initialization and open routines for a format.
2659
Formats provide three things:
2660
* An initialization routine,
2664
Formats are placed in an dict by their format string for reference
2665
during workingtree opening. Its not required that these be instances, they
2666
can be classes themselves with class methods - it simply depends on
2667
whether state is needed for a given format or not.
2669
Once a format is deprecated, just deprecate the initialize and open
2670
methods on the format class. Do not deprecate the object, as the
2671
object will be created every time regardless.
2674
_default_format = None
2675
"""The default format used for new trees."""
2678
"""The known formats."""
2680
requires_rich_root = False
2682
upgrade_recommended = False
2685
def find_format(klass, a_bzrdir):
2686
"""Return the format for the working tree object in a_bzrdir."""
2688
transport = a_bzrdir.get_workingtree_transport(None)
2689
format_string = transport.get("format").read()
2690
return klass._formats[format_string]
2691
except errors.NoSuchFile:
2692
raise errors.NoWorkingTree(base=transport.base)
2694
raise errors.UnknownFormatError(format=format_string,
2695
kind="working tree")
2697
def __eq__(self, other):
2698
return self.__class__ is other.__class__
2700
def __ne__(self, other):
2701
return not (self == other)
2704
def get_default_format(klass):
2705
"""Return the current default format."""
2706
return klass._default_format
2708
def get_format_string(self):
2709
"""Return the ASCII format string that identifies this format."""
2710
raise NotImplementedError(self.get_format_string)
2712
def get_format_description(self):
2713
"""Return the short description for this format."""
2714
raise NotImplementedError(self.get_format_description)
2716
def is_supported(self):
2717
"""Is this format supported?
2719
Supported formats can be initialized and opened.
2720
Unsupported formats may not support initialization or committing or
2721
some other features depending on the reason for not being supported.
2726
def register_format(klass, format):
2727
klass._formats[format.get_format_string()] = format
2730
def set_default_format(klass, format):
2731
klass._default_format = format
2734
def unregister_format(klass, format):
2735
del klass._formats[format.get_format_string()]
2738
class WorkingTreeFormat2(WorkingTreeFormat):
2739
"""The second working tree format.
2741
This format modified the hash cache from the format 1 hash cache.
2744
upgrade_recommended = True
2746
def get_format_description(self):
2747
"""See WorkingTreeFormat.get_format_description()."""
2748
return "Working tree format 2"
2750
def stub_initialize_remote(self, control_files):
2751
"""As a special workaround create critical control files for a remote working tree
2753
This ensures that it can later be updated and dealt with locally,
2754
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2755
no working tree. (See bug #43064).
2759
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2761
control_files.put('inventory', sio)
2763
control_files.put_bytes('pending-merges', '')
2766
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2767
accelerator_tree=None, hardlink=False):
2768
"""See WorkingTreeFormat.initialize()."""
2769
if not isinstance(a_bzrdir.transport, LocalTransport):
2770
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2771
if from_branch is not None:
2772
branch = from_branch
2774
branch = a_bzrdir.open_branch()
2775
if revision_id is None:
2776
revision_id = _mod_revision.ensure_null(branch.last_revision())
2779
branch.generate_revision_history(revision_id)
2783
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2789
basis_tree = branch.repository.revision_tree(revision_id)
2790
if basis_tree.inventory.root is not None:
2791
wt.set_root_id(basis_tree.get_root_id())
2792
# set the parent list and cache the basis tree.
2793
if _mod_revision.is_null(revision_id):
2796
parent_trees = [(revision_id, basis_tree)]
2797
wt.set_parent_trees(parent_trees)
2798
transform.build_tree(basis_tree, wt)
2802
super(WorkingTreeFormat2, self).__init__()
2803
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2805
def open(self, a_bzrdir, _found=False):
2806
"""Return the WorkingTree object for a_bzrdir
2808
_found is a private parameter, do not use it. It is used to indicate
2809
if format probing has already been done.
2812
# we are being called directly and must probe.
2813
raise NotImplementedError
2814
if not isinstance(a_bzrdir.transport, LocalTransport):
2815
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2816
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2822
class WorkingTreeFormat3(WorkingTreeFormat):
2823
"""The second working tree format updated to record a format marker.
2826
- exists within a metadir controlling .bzr
2827
- includes an explicit version marker for the workingtree control
2828
files, separate from the BzrDir format
2829
- modifies the hash cache format
2831
- uses a LockDir to guard access for writes.
2834
upgrade_recommended = True
2836
def get_format_string(self):
2837
"""See WorkingTreeFormat.get_format_string()."""
2838
return "Bazaar-NG Working Tree format 3"
2840
def get_format_description(self):
2841
"""See WorkingTreeFormat.get_format_description()."""
2842
return "Working tree format 3"
2844
_lock_file_name = 'lock'
2845
_lock_class = LockDir
2847
_tree_class = WorkingTree3
2849
def __get_matchingbzrdir(self):
2850
return bzrdir.BzrDirMetaFormat1()
2852
_matchingbzrdir = property(__get_matchingbzrdir)
2854
def _open_control_files(self, a_bzrdir):
2855
transport = a_bzrdir.get_workingtree_transport(None)
2856
return LockableFiles(transport, self._lock_file_name,
2859
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2860
accelerator_tree=None, hardlink=False):
2861
"""See WorkingTreeFormat.initialize().
2863
:param revision_id: if supplied, create a working tree at a different
2864
revision than the branch is at.
2865
:param accelerator_tree: A tree which can be used for retrieving file
2866
contents more quickly than the revision tree, i.e. a workingtree.
2867
The revision tree will be used for cases where accelerator_tree's
2868
content is different.
2869
:param hardlink: If true, hard-link files from accelerator_tree,
2872
if not isinstance(a_bzrdir.transport, LocalTransport):
2873
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2874
transport = a_bzrdir.get_workingtree_transport(self)
2875
control_files = self._open_control_files(a_bzrdir)
2876
control_files.create_lock()
2877
control_files.lock_write()
2878
control_files.put_utf8('format', self.get_format_string())
2879
if from_branch is not None:
2880
branch = from_branch
2882
branch = a_bzrdir.open_branch()
2883
if revision_id is None:
2884
revision_id = _mod_revision.ensure_null(branch.last_revision())
2885
# WorkingTree3 can handle an inventory which has a unique root id.
2886
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2887
# those trees. And because there isn't a format bump inbetween, we
2888
# are maintaining compatibility with older clients.
2889
# inv = Inventory(root_id=gen_root_id())
2890
inv = self._initial_inventory()
2891
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2897
_control_files=control_files)
2898
wt.lock_tree_write()
2900
basis_tree = branch.repository.revision_tree(revision_id)
2901
# only set an explicit root id if there is one to set.
2902
if basis_tree.inventory.root is not None:
2903
wt.set_root_id(basis_tree.get_root_id())
2904
if revision_id == NULL_REVISION:
2905
wt.set_parent_trees([])
2907
wt.set_parent_trees([(revision_id, basis_tree)])
2908
transform.build_tree(basis_tree, wt)
2910
# Unlock in this order so that the unlock-triggers-flush in
2911
# WorkingTree is given a chance to fire.
2912
control_files.unlock()
2916
def _initial_inventory(self):
2920
super(WorkingTreeFormat3, self).__init__()
2922
def open(self, a_bzrdir, _found=False):
2923
"""Return the WorkingTree object for a_bzrdir
2925
_found is a private parameter, do not use it. It is used to indicate
2926
if format probing has already been done.
2929
# we are being called directly and must probe.
2930
raise NotImplementedError
2931
if not isinstance(a_bzrdir.transport, LocalTransport):
2932
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2933
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2936
def _open(self, a_bzrdir, control_files):
2937
"""Open the tree itself.
2939
:param a_bzrdir: the dir for the tree.
2940
:param control_files: the control files for the tree.
2942
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2946
_control_files=control_files)
2949
return self.get_format_string()
2952
__default_format = WorkingTreeFormat4()
2953
WorkingTreeFormat.register_format(__default_format)
2954
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2955
WorkingTreeFormat.set_default_format(__default_format)
2956
# formats which have no format string are not discoverable
2957
# and not independently creatable, so are not registered.
2958
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
