1
# Copyright (C) 2005, 2006 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(), """
46
from copy import deepcopy
56
conflicts as _mod_conflicts,
69
from bzrlib.transport import get_transport
73
from bzrlib import symbol_versioning
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
75
from bzrlib.errors import (BzrCheckError,
78
WeaveRevisionNotPresent,
82
MergeModifiedFormatError,
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
86
from bzrlib.lockable_files import LockableFiles, TransportLock
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib.osutils import (
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
105
from bzrlib.progress import DummyProgress, ProgressPhase
106
from bzrlib.revision import NULL_REVISION
107
import bzrlib.revisiontree
108
from bzrlib.rio import RioReader, rio_file, Stanza
109
from bzrlib.symbol_versioning import (deprecated_passed,
112
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
@deprecated_function(zero_thirteen)
124
def gen_file_id(name):
125
"""Return new file id for the basename 'name'.
127
Use bzrlib.generate_ids.gen_file_id() instead
129
return generate_ids.gen_file_id(name)
132
@deprecated_function(zero_thirteen)
134
"""Return a new tree-root file id.
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
138
return generate_ids.gen_root_id()
141
class TreeEntry(object):
142
"""An entry that implements the minimum interface used by commands.
144
This needs further inspection, it may be better to have
145
InventoryEntries without ids - though that seems wrong. For now,
146
this is a parallel hierarchy to InventoryEntry, and needs to become
147
one of several things: decorates to that hierarchy, children of, or
149
Another note is that these objects are currently only used when there is
150
no InventoryEntry available - i.e. for unversioned objects.
151
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
154
def __eq__(self, other):
155
# yes, this us ugly, TODO: best practice __eq__ style.
156
return (isinstance(other, TreeEntry)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeDirectory(TreeEntry):
164
"""See TreeEntry. This is a directory in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeDirectory)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class TreeFile(TreeEntry):
175
"""See TreeEntry. This is a regular file in a working tree."""
177
def __eq__(self, other):
178
return (isinstance(other, TreeFile)
179
and other.__class__ == self.__class__)
181
def kind_character(self):
185
class TreeLink(TreeEntry):
186
"""See TreeEntry. This is a symlink in a working tree."""
188
def __eq__(self, other):
189
return (isinstance(other, TreeLink)
190
and other.__class__ == self.__class__)
192
def kind_character(self):
196
class WorkingTree(bzrlib.mutabletree.MutableTree):
197
"""Working copy tree.
199
The inventory is held in the `Branch` working-inventory, and the
200
files are in a directory on disk.
202
It is possible for a `WorkingTree` to have a filename which is
203
not listed in the Inventory and vice versa.
206
def __init__(self, basedir='.',
207
branch=DEPRECATED_PARAMETER,
213
"""Construct a WorkingTree for basedir.
215
If the branch is not supplied, it is opened automatically.
216
If the branch is supplied, it must be the branch for this basedir.
217
(branch.base is not cross checked, because for remote branches that
218
would be meaningless).
220
self._format = _format
221
self.bzrdir = _bzrdir
223
# not created via open etc.
224
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
225
"Please use bzrdir.open_workingtree or WorkingTree.open().",
228
wt = WorkingTree.open(basedir)
229
self._branch = wt.branch
230
self.basedir = wt.basedir
231
self._control_files = wt._control_files
232
self._hashcache = wt._hashcache
233
self._set_inventory(wt._inventory, dirty=False)
234
self._format = wt._format
235
self.bzrdir = wt.bzrdir
236
from bzrlib.hashcache import HashCache
237
from bzrlib.trace import note, mutter
238
assert isinstance(basedir, basestring), \
239
"base directory %r is not a string" % basedir
240
basedir = safe_unicode(basedir)
241
mutter("opening working tree %r", basedir)
242
if deprecated_passed(branch):
244
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
245
" Please use bzrdir.open_workingtree() or"
246
" WorkingTree.open().",
250
self._branch = branch
252
self._branch = self.bzrdir.open_branch()
253
self.basedir = realpath(basedir)
254
# if branch is at our basedir and is a format 6 or less
255
if isinstance(self._format, WorkingTreeFormat2):
256
# share control object
257
self._control_files = self.branch.control_files
259
# assume all other formats have their own control files.
260
assert isinstance(_control_files, LockableFiles), \
261
"_control_files must be a LockableFiles, not %r" \
263
self._control_files = _control_files
264
# update the whole cache up front and write to disk if anything changed;
265
# in the future we might want to do this more selectively
266
# two possible ways offer themselves : in self._unlock, write the cache
267
# if needed, or, when the cache sees a change, append it to the hash
268
# cache file, and have the parser take the most recent entry for a
270
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
271
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
273
# is this scan needed ? it makes things kinda slow.
280
if _inventory is None:
281
self._inventory_is_modified = False
282
self.read_working_inventory()
284
# the caller of __init__ has provided an inventory,
285
# we assume they know what they are doing - as its only
286
# the Format factory and creation methods that are
287
# permitted to do this.
288
self._set_inventory(_inventory, dirty=False)
291
fget=lambda self: self._branch,
292
doc="""The branch this WorkingTree is connected to.
294
This cannot be set - it is reflective of the actual disk structure
295
the working tree has been constructed from.
298
def break_lock(self):
299
"""Break a lock if one is present from another instance.
301
Uses the ui factory to ask for confirmation if the lock may be from
304
This will probe the repository for its lock as well.
306
self._control_files.break_lock()
307
self.branch.break_lock()
309
def _set_inventory(self, inv, dirty):
310
"""Set the internal cached inventory.
312
:param inv: The inventory to set.
313
:param dirty: A boolean indicating whether the inventory is the same
314
logical inventory as whats on disk. If True the inventory is not
315
the same and should be written to disk or data will be lost, if
316
False then the inventory is the same as that on disk and any
317
serialisation would be unneeded overhead.
319
assert inv.root is not None
320
self._inventory = inv
321
self._inventory_is_modified = dirty
324
def open(path=None, _unsupported=False):
325
"""Open an existing working tree at path.
329
path = os.path.getcwdu()
330
control = bzrdir.BzrDir.open(path, _unsupported)
331
return control.open_workingtree(_unsupported)
334
def open_containing(path=None):
335
"""Open an existing working tree which has its root about path.
337
This probes for a working tree at path and searches upwards from there.
339
Basically we keep looking up until we find the control directory or
340
run into /. If there isn't one, raises NotBranchError.
341
TODO: give this a new exception.
342
If there is one, it is returned, along with the unused portion of path.
344
:return: The WorkingTree that contains 'path', and the rest of path
347
path = osutils.getcwd()
348
control, relpath = bzrdir.BzrDir.open_containing(path)
350
return control.open_workingtree(), relpath
353
def open_downlevel(path=None):
354
"""Open an unsupported working tree.
356
Only intended for advanced situations like upgrading part of a bzrdir.
358
return WorkingTree.open(path, _unsupported=True)
361
"""Iterate through file_ids for this tree.
363
file_ids are in a WorkingTree if they are in the working inventory
364
and the working file exists.
366
inv = self._inventory
367
for path, ie in inv.iter_entries():
368
if osutils.lexists(self.abspath(path)):
372
return "<%s of %s>" % (self.__class__.__name__,
373
getattr(self, 'basedir', None))
375
def abspath(self, filename):
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling repository.revision_tree(None).
385
revision_id = self.get_parent_ids()[0]
387
# no parents, return an empty revision tree.
388
# in the future this should return the tree for
389
# 'empty:' - the implicit root empty tree.
390
return self.branch.repository.revision_tree(None)
393
xml = self.read_basis_inventory()
394
inv = xml6.serializer_v6.read_inventory_from_string(xml)
395
if inv is not None and inv.revision_id == revision_id:
396
return bzrlib.revisiontree.RevisionTree(
397
self.branch.repository, inv, revision_id)
398
except (NoSuchFile, errors.BadInventoryFormat):
400
# No cached copy available, retrieve from the repository.
401
# FIXME? RBC 20060403 should we cache the inventory locally
404
return self.branch.repository.revision_tree(revision_id)
405
except errors.RevisionNotPresent:
406
# the basis tree *may* be a ghost or a low level error may have
407
# occured. If the revision is present, its a problem, if its not
409
if self.branch.repository.has_revision(revision_id):
411
# the basis tree is a ghost so return an empty tree.
412
return self.branch.repository.revision_tree(None)
415
@deprecated_method(zero_eight)
416
def create(branch, directory):
417
"""Create a workingtree for branch at directory.
419
If existing_directory already exists it must have a .bzr directory.
420
If it does not exist, it will be created.
422
This returns a new WorkingTree object for the new checkout.
424
TODO FIXME RBC 20060124 when we have checkout formats in place this
425
should accept an optional revisionid to checkout [and reject this if
426
checking out into the same dir as a pre-checkout-aware branch format.]
428
XXX: When BzrDir is present, these should be created through that
431
warnings.warn('delete WorkingTree.create', stacklevel=3)
432
transport = get_transport(directory)
433
if branch.bzrdir.root_transport.base == transport.base:
435
return branch.bzrdir.create_workingtree()
436
# different directory,
437
# create a branch reference
438
# and now a working tree.
439
raise NotImplementedError
442
@deprecated_method(zero_eight)
443
def create_standalone(directory):
444
"""Create a checkout and a branch and a repo at directory.
446
Directory must exist and be empty.
448
please use BzrDir.create_standalone_workingtree
450
return bzrdir.BzrDir.create_standalone_workingtree(directory)
452
def relpath(self, path):
453
"""Return the local path portion from a given path.
455
The path may be absolute or relative. If its a relative path it is
456
interpreted relative to the python current working directory.
458
return osutils.relpath(self.basedir, path)
460
def has_filename(self, filename):
461
return osutils.lexists(self.abspath(filename))
463
def get_file(self, file_id):
464
return self.get_file_byname(self.id2path(file_id))
466
def get_file_text(self, file_id):
467
return self.get_file(file_id).read()
469
def get_file_byname(self, filename):
470
return file(self.abspath(filename), 'rb')
472
def get_parent_ids(self):
473
"""See Tree.get_parent_ids.
475
This implementation reads the pending merges list and last_revision
476
value and uses that to decide what the parents list should be.
478
last_rev = self._last_revision()
484
merges_file = self._control_files.get_utf8('pending-merges')
488
for l in merges_file.readlines():
489
parents.append(l.rstrip('\n'))
493
def get_root_id(self):
494
"""Return the id of this trees root"""
495
return self._inventory.root.file_id
497
def _get_store_filename(self, file_id):
498
## XXX: badly named; this is not in the store at all
499
return self.abspath(self.id2path(file_id))
502
def clone(self, to_bzrdir, revision_id=None, basis=None):
503
"""Duplicate this working tree into to_bzr, including all state.
505
Specifically modified files are kept as modified, but
506
ignored and unknown files are discarded.
508
If you want to make a new line of development, see bzrdir.sprout()
511
If not None, the cloned tree will have its last revision set to
512
revision, and and difference between the source trees last revision
513
and this one merged in.
516
If not None, a closer copy of a tree which may have some files in
517
common, and which file content should be preferentially copied from.
519
# assumes the target bzr dir format is compatible.
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id)
525
def copy_content_into(self, tree, revision_id=None):
526
"""Copy the current content and user files of this tree into tree."""
527
tree.set_root_id(self.get_root_id())
528
if revision_id is None:
529
merge.transform_tree(tree, self)
531
# TODO now merge from tree.last_revision to revision (to preserve
532
# user local changes)
533
merge.transform_tree(tree, self)
534
tree.set_parent_ids([revision_id])
536
def id2abspath(self, file_id):
537
return self.abspath(self.id2path(file_id))
539
def has_id(self, file_id):
540
# files that have been deleted are excluded
541
inv = self._inventory
542
if not inv.has_id(file_id):
544
path = inv.id2path(file_id)
545
return osutils.lexists(self.abspath(path))
547
def has_or_had_id(self, file_id):
548
if file_id == self.inventory.root.file_id:
550
return self.inventory.has_id(file_id)
552
__contains__ = has_id
554
def get_file_size(self, file_id):
555
return os.path.getsize(self.id2abspath(file_id))
558
def get_file_sha1(self, file_id, path=None):
560
path = self._inventory.id2path(file_id)
561
return self._hashcache.get_sha1(path)
563
def get_file_mtime(self, file_id, path=None):
565
path = self._inventory.id2path(file_id)
566
return os.lstat(self.abspath(path)).st_mtime
568
if not supports_executable():
569
def is_executable(self, file_id, path=None):
570
return self._inventory[file_id].executable
572
def is_executable(self, file_id, path=None):
574
path = self._inventory.id2path(file_id)
575
mode = os.lstat(self.abspath(path)).st_mode
576
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
579
def _add(self, files, ids, kinds):
580
"""See MutableTree._add."""
581
# TODO: Re-adding a file that is removed in the working copy
582
# should probably put it back with the previous ID.
583
# the read and write working inventory should not occur in this
584
# function - they should be part of lock_write and unlock.
585
inv = self.read_working_inventory()
586
for f, file_id, kind in zip(files, ids, kinds):
587
assert kind is not None
589
inv.add_path(f, kind=kind)
591
inv.add_path(f, kind=kind, file_id=file_id)
592
self._write_inventory(inv)
594
@needs_tree_write_lock
595
def _gather_kinds(self, files, kinds):
596
"""See MutableTree._gather_kinds."""
597
for pos, f in enumerate(files):
598
if kinds[pos] is None:
599
fullpath = normpath(self.abspath(f))
601
kinds[pos] = file_kind(fullpath)
603
if e.errno == errno.ENOENT:
604
raise NoSuchFile(fullpath)
607
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
608
"""Add revision_id as a parent.
610
This is equivalent to retrieving the current list of parent ids
611
and setting the list to its value plus revision_id.
613
:param revision_id: The revision id to add to the parent list. It may
614
be a ghost revision as long as its not the first parent to be added,
615
or the allow_leftmost_as_ghost parameter is set True.
616
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
618
parents = self.get_parent_ids() + [revision_id]
619
self.set_parent_ids(parents,
620
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
622
@needs_tree_write_lock
623
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
624
"""Add revision_id, tree tuple as a parent.
626
This is equivalent to retrieving the current list of parent trees
627
and setting the list to its value plus parent_tuple. See also
628
add_parent_tree_id - if you only have a parent id available it will be
629
simpler to use that api. If you have the parent already available, using
630
this api is preferred.
632
:param parent_tuple: The (revision id, tree) to add to the parent list.
633
If the revision_id is a ghost, pass None for the tree.
634
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
636
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
637
if len(parent_ids) > 1:
638
# the leftmost may have already been a ghost, preserve that if it
640
allow_leftmost_as_ghost = True
641
self.set_parent_ids(parent_ids,
642
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_pending_merge(self, *revision_ids):
646
# TODO: Perhaps should check at this point that the
647
# history of the revision is actually present?
648
parents = self.get_parent_ids()
650
for rev_id in revision_ids:
651
if rev_id in parents:
653
parents.append(rev_id)
656
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
658
@deprecated_method(zero_eleven)
660
def pending_merges(self):
661
"""Return a list of pending merges.
663
These are revisions that have been merged into the working
664
directory but not yet committed.
666
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
667
instead - which is available on all tree objects.
669
return self.get_parent_ids()[1:]
671
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
672
"""Common ghost checking functionality from set_parent_*.
674
This checks that the left hand-parent exists if there are any
677
if len(revision_ids) > 0:
678
leftmost_id = revision_ids[0]
679
if (not allow_leftmost_as_ghost and not
680
self.branch.repository.has_revision(leftmost_id)):
681
raise errors.GhostRevisionUnusableHere(leftmost_id)
683
def _set_merges_from_parent_ids(self, parent_ids):
684
merges = parent_ids[1:]
685
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
687
@needs_tree_write_lock
688
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
689
"""Set the parent ids to revision_ids.
691
See also set_parent_trees. This api will try to retrieve the tree data
692
for each element of revision_ids from the trees repository. If you have
693
tree data already available, it is more efficient to use
694
set_parent_trees rather than set_parent_ids. set_parent_ids is however
695
an easier API to use.
697
:param revision_ids: The revision_ids to set as the parent ids of this
698
working tree. Any of these may be ghosts.
700
self._check_parents_for_ghosts(revision_ids,
701
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
703
if len(revision_ids) > 0:
704
self.set_last_revision(revision_ids[0])
706
self.set_last_revision(None)
708
self._set_merges_from_parent_ids(revision_ids)
710
@needs_tree_write_lock
711
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
712
"""See MutableTree.set_parent_trees."""
713
parent_ids = [rev for (rev, tree) in parents_list]
715
self._check_parents_for_ghosts(parent_ids,
716
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
718
if len(parent_ids) == 0:
719
leftmost_parent_id = None
720
leftmost_parent_tree = None
722
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
724
if self._change_last_revision(leftmost_parent_id):
725
if leftmost_parent_tree is None:
726
# If we don't have a tree, fall back to reading the
727
# parent tree from the repository.
728
self._cache_basis_inventory(leftmost_parent_id)
730
inv = leftmost_parent_tree.inventory
731
xml = self._create_basis_xml_from_inventory(
732
leftmost_parent_id, inv)
733
self._write_basis_inventory(xml)
734
self._set_merges_from_parent_ids(parent_ids)
736
@needs_tree_write_lock
737
def set_pending_merges(self, rev_list):
738
parents = self.get_parent_ids()
739
leftmost = parents[:1]
740
new_parents = leftmost + rev_list
741
self.set_parent_ids(new_parents)
743
@needs_tree_write_lock
744
def set_merge_modified(self, modified_hashes):
746
for file_id, hash in modified_hashes.iteritems():
747
yield Stanza(file_id=file_id, hash=hash)
748
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
750
@needs_tree_write_lock
751
def _put_rio(self, filename, stanzas, header):
752
my_file = rio_file(stanzas, header)
753
self._control_files.put(filename, my_file)
755
@needs_write_lock # because merge pulls data into the branch.
756
def merge_from_branch(self, branch, to_revision=None):
757
"""Merge from a branch into this working tree.
759
:param branch: The branch to merge from.
760
:param to_revision: If non-None, the merge will merge to to_revision, but
761
not beyond it. to_revision does not need to be in the history of
762
the branch when it is supplied. If None, to_revision defaults to
763
branch.last_revision().
765
from bzrlib.merge import Merger, Merge3Merger
766
pb = bzrlib.ui.ui_factory.nested_progress_bar()
768
merger = Merger(self.branch, this_tree=self, pb=pb)
769
merger.pp = ProgressPhase("Merge phase", 5, pb)
770
merger.pp.next_phase()
771
# check that there are no
773
merger.check_basis(check_clean=True, require_commits=False)
774
if to_revision is None:
775
to_revision = branch.last_revision()
776
merger.other_rev_id = to_revision
777
if merger.other_rev_id is None:
778
raise error.NoCommits(branch)
779
self.branch.fetch(branch, last_revision=merger.other_rev_id)
780
merger.other_basis = merger.other_rev_id
781
merger.other_tree = self.branch.repository.revision_tree(
783
merger.pp.next_phase()
785
if merger.base_rev_id == merger.other_rev_id:
786
raise errors.PointlessMerge
787
merger.backup_files = False
788
merger.merge_type = Merge3Merger
789
merger.set_interesting_files(None)
790
merger.show_base = False
791
merger.reprocess = False
792
conflicts = merger.do_merge()
799
def merge_modified(self):
801
hashfile = self._control_files.get('merge-hashes')
806
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
807
raise MergeModifiedFormatError()
808
except StopIteration:
809
raise MergeModifiedFormatError()
810
for s in RioReader(hashfile):
811
file_id = s.get("file_id")
812
if file_id not in self.inventory:
815
if hash == self.get_file_sha1(file_id):
816
merge_hashes[file_id] = hash
820
def mkdir(self, path, file_id=None):
821
"""See MutableTree.mkdir()."""
823
file_id = generate_ids.gen_file_id(os.path.basename(path))
824
os.mkdir(self.abspath(path))
825
self.add(path, file_id, 'directory')
828
def get_symlink_target(self, file_id):
829
return os.readlink(self.id2abspath(file_id))
831
def file_class(self, filename):
832
if self.path2id(filename):
834
elif self.is_ignored(filename):
840
"""Write the in memory inventory to disk."""
841
# TODO: Maybe this should only write on dirty ?
842
if self._control_files._lock_mode != 'w':
843
raise errors.NotWriteLocked(self)
845
xml5.serializer_v5.write_inventory(self._inventory, sio)
847
self._control_files.put('inventory', sio)
848
self._inventory_is_modified = False
850
def list_files(self, include_root=False):
851
"""Recursively list all files as (path, class, kind, id, entry).
853
Lists, but does not descend into unversioned directories.
855
This does not include files that have been deleted in this
858
Skips the control directory.
860
inv = self._inventory
861
if include_root is True:
862
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
863
# Convert these into local objects to save lookup times
864
pathjoin = osutils.pathjoin
865
file_kind = osutils.file_kind
867
# transport.base ends in a slash, we want the piece
868
# between the last two slashes
869
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
871
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
873
# directory file_id, relative path, absolute path, reverse sorted children
874
children = os.listdir(self.basedir)
876
# jam 20060527 The kernel sized tree seems equivalent whether we
877
# use a deque and popleft to keep them sorted, or if we use a plain
878
# list and just reverse() them.
879
children = collections.deque(children)
880
stack = [(inv.root.file_id, u'', self.basedir, children)]
882
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
885
f = children.popleft()
886
## TODO: If we find a subdirectory with its own .bzr
887
## directory, then that is a separate tree and we
888
## should exclude it.
890
# the bzrdir for this tree
891
if transport_base_dir == f:
894
# we know that from_dir_relpath and from_dir_abspath never end in a slash
895
# and 'f' doesn't begin with one, we can do a string op, rather
896
# than the checks of pathjoin(), all relative paths will have an extra slash
898
fp = from_dir_relpath + '/' + f
901
fap = from_dir_abspath + '/' + f
903
f_ie = inv.get_child(from_dir_id, f)
906
elif self.is_ignored(fp[1:]):
909
# we may not have found this file, because of a unicode issue
910
f_norm, can_access = osutils.normalized_filename(f)
911
if f == f_norm or not can_access:
912
# No change, so treat this file normally
915
# this file can be accessed by a normalized path
916
# check again if it is versioned
917
# these lines are repeated here for performance
919
fp = from_dir_relpath + '/' + f
920
fap = from_dir_abspath + '/' + f
921
f_ie = inv.get_child(from_dir_id, f)
924
elif self.is_ignored(fp[1:]):
933
raise BzrCheckError("file %r entered as kind %r id %r, "
935
% (fap, f_ie.kind, f_ie.file_id, fk))
937
# make a last minute entry
939
yield fp[1:], c, fk, f_ie.file_id, f_ie
942
yield fp[1:], c, fk, None, fk_entries[fk]()
944
yield fp[1:], c, fk, None, TreeEntry()
947
if fk != 'directory':
950
# But do this child first
951
new_children = os.listdir(fap)
953
new_children = collections.deque(new_children)
954
stack.append((f_ie.file_id, fp, fap, new_children))
955
# Break out of inner loop, so that we start outer loop with child
958
# if we finished all children, pop it off the stack
961
@needs_tree_write_lock
962
def move(self, from_paths, to_name):
965
to_name must exist in the inventory.
967
If to_name exists and is a directory, the files are moved into
968
it, keeping their old names.
970
Note that to_name is only the last component of the new name;
971
this doesn't change the directory.
973
This returns a list of (from_path, to_path) pairs for each
977
## TODO: Option to move IDs only
978
assert not isinstance(from_paths, basestring)
980
to_abs = self.abspath(to_name)
981
if not isdir(to_abs):
982
raise BzrError("destination %r is not a directory" % to_abs)
983
if not self.has_filename(to_name):
984
raise BzrError("destination %r not in working directory" % to_abs)
985
to_dir_id = inv.path2id(to_name)
986
if to_dir_id is None and to_name != '':
987
raise BzrError("destination %r is not a versioned directory" % to_name)
988
to_dir_ie = inv[to_dir_id]
989
if to_dir_ie.kind != 'directory':
990
raise BzrError("destination %r is not a directory" % to_abs)
992
to_idpath = inv.get_idpath(to_dir_id)
995
if not self.has_filename(f):
996
raise BzrError("%r does not exist in working tree" % f)
997
f_id = inv.path2id(f)
999
raise BzrError("%r is not versioned" % f)
1000
name_tail = splitpath(f)[-1]
1001
dest_path = pathjoin(to_name, name_tail)
1002
if self.has_filename(dest_path):
1003
raise BzrError("destination %r already exists" % dest_path)
1004
if f_id in to_idpath:
1005
raise BzrError("can't move %r to a subdirectory of itself" % f)
1007
# OK, so there's a race here, it's possible that someone will
1008
# create a file in this interval and then the rename might be
1009
# left half-done. But we should have caught most problems.
1010
orig_inv = deepcopy(self.inventory)
1011
original_modified = self._inventory_is_modified
1014
self._inventory_is_modified = True
1015
for f in from_paths:
1016
name_tail = splitpath(f)[-1]
1017
dest_path = pathjoin(to_name, name_tail)
1018
result.append((f, dest_path))
1019
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1021
osutils.rename(self.abspath(f), self.abspath(dest_path))
1023
raise BzrError("failed to rename %r to %r: %s" %
1024
(f, dest_path, e[1]),
1025
["rename rolled back"])
1027
# restore the inventory on error
1028
self._set_inventory(orig_inv, dirty=original_modified)
1030
self._write_inventory(inv)
1033
@needs_tree_write_lock
1034
def rename_one(self, from_rel, to_rel):
1037
This can change the directory or the filename or both.
1039
inv = self.inventory
1040
if not self.has_filename(from_rel):
1041
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1042
if self.has_filename(to_rel):
1043
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1045
file_id = inv.path2id(from_rel)
1047
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1049
entry = inv[file_id]
1050
from_parent = entry.parent_id
1051
from_name = entry.name
1053
if inv.path2id(to_rel):
1054
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1056
to_dir, to_tail = os.path.split(to_rel)
1057
to_dir_id = inv.path2id(to_dir)
1058
if to_dir_id is None and to_dir != '':
1059
raise BzrError("can't determine destination directory id for %r" % to_dir)
1061
mutter("rename_one:")
1062
mutter(" file_id {%s}" % file_id)
1063
mutter(" from_rel %r" % from_rel)
1064
mutter(" to_rel %r" % to_rel)
1065
mutter(" to_dir %r" % to_dir)
1066
mutter(" to_dir_id {%s}" % to_dir_id)
1068
inv.rename(file_id, to_dir_id, to_tail)
1070
from_abs = self.abspath(from_rel)
1071
to_abs = self.abspath(to_rel)
1073
osutils.rename(from_abs, to_abs)
1075
inv.rename(file_id, from_parent, from_name)
1076
raise BzrError("failed to rename %r to %r: %s"
1077
% (from_abs, to_abs, e[1]),
1078
["rename rolled back"])
1079
self._write_inventory(inv)
1083
"""Return all unknown files.
1085
These are files in the working directory that are not versioned or
1086
control files or ignored.
1088
for subp in self.extras():
1089
if not self.is_ignored(subp):
1092
@needs_tree_write_lock
1093
def unversion(self, file_ids):
1094
"""Remove the file ids in file_ids from the current versioned set.
1096
When a file_id is unversioned, all of its children are automatically
1099
:param file_ids: The file ids to stop versioning.
1100
:raises: NoSuchId if any fileid is not currently versioned.
1102
for file_id in file_ids:
1103
if self._inventory.has_id(file_id):
1104
self._inventory.remove_recursive_id(file_id)
1106
raise errors.NoSuchId(self, file_id)
1108
# in the future this should just set a dirty bit to wait for the
1109
# final unlock. However, until all methods of workingtree start
1110
# with the current in -memory inventory rather than triggering
1111
# a read, it is more complex - we need to teach read_inventory
1112
# to know when to read, and when to not read first... and possibly
1113
# to save first when the in memory one may be corrupted.
1114
# so for now, we just only write it if it is indeed dirty.
1116
self._write_inventory(self._inventory)
1118
@deprecated_method(zero_eight)
1119
def iter_conflicts(self):
1120
"""List all files in the tree that have text or content conflicts.
1121
DEPRECATED. Use conflicts instead."""
1122
return self._iter_conflicts()
1124
def _iter_conflicts(self):
1126
for info in self.list_files():
1128
stem = get_conflicted_stem(path)
1131
if stem not in conflicted:
1132
conflicted.add(stem)
1136
def pull(self, source, overwrite=False, stop_revision=None):
1137
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1140
pp = ProgressPhase("Pull phase", 2, top_pb)
1142
old_revision_history = self.branch.revision_history()
1143
basis_tree = self.basis_tree()
1144
count = self.branch.pull(source, overwrite, stop_revision)
1145
new_revision_history = self.branch.revision_history()
1146
if new_revision_history != old_revision_history:
1148
if len(old_revision_history):
1149
other_revision = old_revision_history[-1]
1151
other_revision = None
1152
repository = self.branch.repository
1153
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1155
new_basis_tree = self.branch.basis_tree()
1162
if (basis_tree.inventory.root is None and
1163
new_basis_tree.inventory.root is not None):
1164
self.set_root_id(new_basis_tree.inventory.root.file_id)
1167
# TODO - dedup parents list with things merged by pull ?
1168
# reuse the revisiontree we merged against to set the new
1170
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1171
# we have to pull the merge trees out again, because
1172
# merge_inner has set the ids. - this corner is not yet
1173
# layered well enough to prevent double handling.
1174
merges = self.get_parent_ids()[1:]
1175
parent_trees.extend([
1176
(parent, repository.revision_tree(parent)) for
1178
self.set_parent_trees(parent_trees)
1185
def put_file_bytes_non_atomic(self, file_id, bytes):
1186
"""See MutableTree.put_file_bytes_non_atomic."""
1187
stream = file(self.id2abspath(file_id), 'wb')
1192
# TODO: update the hashcache here ?
1195
"""Yield all unknown files in this WorkingTree.
1197
If there are any unknown directories then only the directory is
1198
returned, not all its children. But if there are unknown files
1199
under a versioned subdirectory, they are returned.
1201
Currently returned depth-first, sorted by name within directories.
1203
## TODO: Work from given directory downwards
1204
for path, dir_entry in self.inventory.directories():
1205
# mutter("search for unknowns in %r", path)
1206
dirabs = self.abspath(path)
1207
if not isdir(dirabs):
1208
# e.g. directory deleted
1212
for subf in os.listdir(dirabs):
1215
if subf not in dir_entry.children:
1216
subf_norm, can_access = osutils.normalized_filename(subf)
1217
if subf_norm != subf and can_access:
1218
if subf_norm not in dir_entry.children:
1219
fl.append(subf_norm)
1225
subp = pathjoin(path, subf)
1228
def _translate_ignore_rule(self, rule):
1229
"""Translate a single ignore rule to a regex.
1231
There are two types of ignore rules. Those that do not contain a / are
1232
matched against the tail of the filename (that is, they do not care
1233
what directory the file is in.) Rules which do contain a slash must
1234
match the entire path. As a special case, './' at the start of the
1235
string counts as a slash in the string but is removed before matching
1236
(e.g. ./foo.c, ./src/foo.c)
1238
:return: The translated regex.
1240
if rule[:2] in ('./', '.\\'):
1242
result = fnmatch.translate(rule[2:])
1243
elif '/' in rule or '\\' in rule:
1245
result = fnmatch.translate(rule)
1247
# default rule style.
1248
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1249
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1250
return "(" + result + ")"
1252
def _combine_ignore_rules(self, rules):
1253
"""Combine a list of ignore rules into a single regex object.
1255
Each individual rule is combined with | to form a big regex, which then
1256
has $ added to it to form something like ()|()|()$. The group index for
1257
each subregex's outermost group is placed in a dictionary mapping back
1258
to the rule. This allows quick identification of the matching rule that
1260
:return: a list of the compiled regex and the matching-group index
1261
dictionaries. We return a list because python complains if you try to
1262
combine more than 100 regexes.
1267
translated_rules = []
1269
translated_rule = self._translate_ignore_rule(rule)
1270
compiled_rule = re.compile(translated_rule)
1271
groups[next_group] = rule
1272
next_group += compiled_rule.groups
1273
translated_rules.append(translated_rule)
1274
if next_group == 99:
1275
result.append((re.compile("|".join(translated_rules)), groups))
1278
translated_rules = []
1279
if len(translated_rules):
1280
result.append((re.compile("|".join(translated_rules)), groups))
1283
def ignored_files(self):
1284
"""Yield list of PATH, IGNORE_PATTERN"""
1285
for subp in self.extras():
1286
pat = self.is_ignored(subp)
1290
def get_ignore_list(self):
1291
"""Return list of ignore patterns.
1293
Cached in the Tree object after the first call.
1295
ignoreset = getattr(self, '_ignoreset', None)
1296
if ignoreset is not None:
1299
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1300
ignore_globs.update(ignores.get_runtime_ignores())
1302
ignore_globs.update(ignores.get_user_ignores())
1304
if self.has_filename(bzrlib.IGNORE_FILENAME):
1305
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1307
ignore_globs.update(ignores.parse_ignore_file(f))
1311
self._ignoreset = ignore_globs
1312
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1315
def _get_ignore_rules_as_regex(self):
1316
"""Return a regex of the ignore rules and a mapping dict.
1318
:return: (ignore rules compiled regex, dictionary mapping rule group
1319
indices to original rule.)
1321
if getattr(self, '_ignoreset', None) is None:
1322
self.get_ignore_list()
1323
return self._ignore_regex
1325
def is_ignored(self, filename):
1326
r"""Check whether the filename matches an ignore pattern.
1328
Patterns containing '/' or '\' need to match the whole path;
1329
others match against only the last component.
1331
If the file is ignored, returns the pattern which caused it to
1332
be ignored, otherwise None. So this can simply be used as a
1333
boolean if desired."""
1335
# TODO: Use '**' to match directories, and other extended
1336
# globbing stuff from cvs/rsync.
1338
# XXX: fnmatch is actually not quite what we want: it's only
1339
# approximately the same as real Unix fnmatch, and doesn't
1340
# treat dotfiles correctly and allows * to match /.
1341
# Eventually it should be replaced with something more
1344
rules = self._get_ignore_rules_as_regex()
1345
for regex, mapping in rules:
1346
match = regex.match(filename)
1347
if match is not None:
1348
# one or more of the groups in mapping will have a non-None
1350
groups = match.groups()
1351
rules = [mapping[group] for group in
1352
mapping if groups[group] is not None]
1356
def kind(self, file_id):
1357
return file_kind(self.id2abspath(file_id))
1359
def last_revision(self):
1360
"""Return the last revision of the branch for this tree.
1362
This format tree does not support a separate marker for last-revision
1363
compared to the branch.
1365
See MutableTree.last_revision
1367
return self._last_revision()
1370
def _last_revision(self):
1371
"""helper for get_parent_ids."""
1372
return self.branch.last_revision()
1374
def is_locked(self):
1375
return self._control_files.is_locked()
1377
def lock_read(self):
1378
"""See Branch.lock_read, and WorkingTree.unlock."""
1379
self.branch.lock_read()
1381
return self._control_files.lock_read()
1383
self.branch.unlock()
1386
def lock_tree_write(self):
1387
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1388
self.branch.lock_read()
1390
return self._control_files.lock_write()
1392
self.branch.unlock()
1395
def lock_write(self):
1396
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1397
self.branch.lock_write()
1399
return self._control_files.lock_write()
1401
self.branch.unlock()
1404
def get_physical_lock_status(self):
1405
return self._control_files.get_physical_lock_status()
1407
def _basis_inventory_name(self):
1408
return 'basis-inventory-cache'
1410
@needs_tree_write_lock
1411
def set_last_revision(self, new_revision):
1412
"""Change the last revision in the working tree."""
1413
if self._change_last_revision(new_revision):
1414
self._cache_basis_inventory(new_revision)
1416
def _change_last_revision(self, new_revision):
1417
"""Template method part of set_last_revision to perform the change.
1419
This is used to allow WorkingTree3 instances to not affect branch
1420
when their last revision is set.
1422
if new_revision is None:
1423
self.branch.set_revision_history([])
1426
self.branch.generate_revision_history(new_revision)
1427
except errors.NoSuchRevision:
1428
# not present in the repo - dont try to set it deeper than the tip
1429
self.branch.set_revision_history([new_revision])
1432
def _write_basis_inventory(self, xml):
1433
"""Write the basis inventory XML to the basis-inventory file"""
1434
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1435
path = self._basis_inventory_name()
1437
self._control_files.put(path, sio)
1439
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1440
"""Create the text that will be saved in basis-inventory"""
1441
inventory.revision_id = revision_id
1442
return xml6.serializer_v6.write_inventory_to_string(inventory)
1444
def _cache_basis_inventory(self, new_revision):
1445
"""Cache new_revision as the basis inventory."""
1446
# TODO: this should allow the ready-to-use inventory to be passed in,
1447
# as commit already has that ready-to-use [while the format is the
1450
# this double handles the inventory - unpack and repack -
1451
# but is easier to understand. We can/should put a conditional
1452
# in here based on whether the inventory is in the latest format
1453
# - perhaps we should repack all inventories on a repository
1455
# the fast path is to copy the raw xml from the repository. If the
1456
# xml contains 'revision_id="', then we assume the right
1457
# revision_id is set. We must check for this full string, because a
1458
# root node id can legitimately look like 'revision_id' but cannot
1460
xml = self.branch.repository.get_inventory_xml(new_revision)
1461
firstline = xml.split('\n', 1)[0]
1462
if (not 'revision_id="' in firstline or
1463
'format="6"' not in firstline):
1464
inv = self.branch.repository.deserialise_inventory(
1466
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1467
self._write_basis_inventory(xml)
1468
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1471
def read_basis_inventory(self):
1472
"""Read the cached basis inventory."""
1473
path = self._basis_inventory_name()
1474
return self._control_files.get(path).read()
1477
def read_working_inventory(self):
1478
"""Read the working inventory.
1480
:raises errors.InventoryModified: read_working_inventory will fail
1481
when the current in memory inventory has been modified.
1483
# conceptually this should be an implementation detail of the tree.
1484
# XXX: Deprecate this.
1485
# ElementTree does its own conversion from UTF-8, so open in
1487
if self._inventory_is_modified:
1488
raise errors.InventoryModified(self)
1489
result = xml5.serializer_v5.read_inventory(
1490
self._control_files.get('inventory'))
1491
self._set_inventory(result, dirty=False)
1494
@needs_tree_write_lock
1495
def remove(self, files, verbose=False, to_file=None):
1496
"""Remove nominated files from the working inventory..
1498
This does not remove their text. This does not run on XXX on what? RBC
1500
TODO: Refuse to remove modified files unless --force is given?
1502
TODO: Do something useful with directories.
1504
TODO: Should this remove the text or not? Tough call; not
1505
removing may be useful and the user can just use use rm, and
1506
is the opposite of add. Removing it is consistent with most
1507
other tools. Maybe an option.
1509
## TODO: Normalize names
1510
## TODO: Remove nested loops; better scalability
1511
if isinstance(files, basestring):
1514
inv = self.inventory
1516
# do this before any modifications
1518
fid = inv.path2id(f)
1520
# TODO: Perhaps make this just a warning, and continue?
1521
# This tends to happen when
1522
raise NotVersionedError(path=f)
1524
# having remove it, it must be either ignored or unknown
1525
if self.is_ignored(f):
1529
textui.show_status(new_status, inv[fid].kind, f,
1533
self._write_inventory(inv)
1535
@needs_tree_write_lock
1536
def revert(self, filenames, old_tree=None, backups=True,
1537
pb=DummyProgress()):
1538
from bzrlib.conflicts import resolve
1539
if old_tree is None:
1540
old_tree = self.basis_tree()
1541
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1542
if not len(filenames):
1543
self.set_parent_ids(self.get_parent_ids()[:1])
1546
resolve(self, filenames, ignore_misses=True)
1549
# XXX: This method should be deprecated in favour of taking in a proper
1550
# new Inventory object.
1551
@needs_tree_write_lock
1552
def set_inventory(self, new_inventory_list):
1553
from bzrlib.inventory import (Inventory,
1558
inv = Inventory(self.get_root_id())
1559
for path, file_id, parent, kind in new_inventory_list:
1560
name = os.path.basename(path)
1563
# fixme, there should be a factory function inv,add_??
1564
if kind == 'directory':
1565
inv.add(InventoryDirectory(file_id, name, parent))
1566
elif kind == 'file':
1567
inv.add(InventoryFile(file_id, name, parent))
1568
elif kind == 'symlink':
1569
inv.add(InventoryLink(file_id, name, parent))
1571
raise BzrError("unknown kind %r" % kind)
1572
self._write_inventory(inv)
1574
@needs_tree_write_lock
1575
def set_root_id(self, file_id):
1576
"""Set the root id for this tree."""
1579
symbol_versioning.warn(symbol_versioning.zero_twelve
1580
% 'WorkingTree.set_root_id with fileid=None',
1584
inv = self._inventory
1585
orig_root_id = inv.root.file_id
1586
# TODO: it might be nice to exit early if there was nothing
1587
# to do, saving us from trigger a sync on unlock.
1588
self._inventory_is_modified = True
1589
# we preserve the root inventory entry object, but
1590
# unlinkit from the byid index
1591
del inv._byid[inv.root.file_id]
1592
inv.root.file_id = file_id
1593
# and link it into the index with the new changed id.
1594
inv._byid[inv.root.file_id] = inv.root
1595
# and finally update all children to reference the new id.
1596
# XXX: this should be safe to just look at the root.children
1597
# list, not the WHOLE INVENTORY.
1600
if entry.parent_id == orig_root_id:
1601
entry.parent_id = inv.root.file_id
1604
"""See Branch.unlock.
1606
WorkingTree locking just uses the Branch locking facilities.
1607
This is current because all working trees have an embedded branch
1608
within them. IF in the future, we were to make branch data shareable
1609
between multiple working trees, i.e. via shared storage, then we
1610
would probably want to lock both the local tree, and the branch.
1612
raise NotImplementedError(self.unlock)
1615
"""Update a working tree along its branch.
1617
This will update the branch if its bound too, which means we have
1618
multiple trees involved:
1620
- The new basis tree of the master.
1621
- The old basis tree of the branch.
1622
- The old basis tree of the working tree.
1623
- The current working tree state.
1625
Pathologically, all three may be different, and non-ancestors of each
1626
other. Conceptually we want to:
1628
- Preserve the wt.basis->wt.state changes
1629
- Transform the wt.basis to the new master basis.
1630
- Apply a merge of the old branch basis to get any 'local' changes from
1632
- Restore the wt.basis->wt.state changes.
1634
There isn't a single operation at the moment to do that, so we:
1635
- Merge current state -> basis tree of the master w.r.t. the old tree
1637
- Do a 'normal' merge of the old branch basis if it is relevant.
1639
if self.branch.get_master_branch() is not None:
1641
update_branch = True
1643
self.lock_tree_write()
1644
update_branch = False
1647
old_tip = self.branch.update()
1650
return self._update_tree(old_tip)
1654
@needs_tree_write_lock
1655
def _update_tree(self, old_tip=None):
1656
"""Update a tree to the master branch.
1658
:param old_tip: if supplied, the previous tip revision the branch,
1659
before it was changed to the master branch's tip.
1661
# here if old_tip is not None, it is the old tip of the branch before
1662
# it was updated from the master branch. This should become a pending
1663
# merge in the working tree to preserve the user existing work. we
1664
# cant set that until we update the working trees last revision to be
1665
# one from the new branch, because it will just get absorbed by the
1666
# parent de-duplication logic.
1668
# We MUST save it even if an error occurs, because otherwise the users
1669
# local work is unreferenced and will appear to have been lost.
1673
last_rev = self.get_parent_ids()[0]
1676
if last_rev != self.branch.last_revision():
1677
# merge tree state up to new branch tip.
1678
basis = self.basis_tree()
1679
to_tree = self.branch.basis_tree()
1680
if basis.inventory.root is None:
1681
self.set_root_id(to_tree.inventory.root.file_id)
1682
result += merge.merge_inner(
1687
# TODO - dedup parents list with things merged by pull ?
1688
# reuse the tree we've updated to to set the basis:
1689
parent_trees = [(self.branch.last_revision(), to_tree)]
1690
merges = self.get_parent_ids()[1:]
1691
# Ideally we ask the tree for the trees here, that way the working
1692
# tree can decide whether to give us teh entire tree or give us a
1693
# lazy initialised tree. dirstate for instance will have the trees
1694
# in ram already, whereas a last-revision + basis-inventory tree
1695
# will not, but also does not need them when setting parents.
1696
for parent in merges:
1697
parent_trees.append(
1698
(parent, self.branch.repository.revision_tree(parent)))
1699
if old_tip is not None:
1700
parent_trees.append(
1701
(old_tip, self.branch.repository.revision_tree(old_tip)))
1702
self.set_parent_trees(parent_trees)
1703
last_rev = parent_trees[0][0]
1705
# the working tree had the same last-revision as the master
1706
# branch did. We may still have pivot local work from the local
1707
# branch into old_tip:
1708
if old_tip is not None:
1709
self.add_parent_tree_id(old_tip)
1710
if old_tip and old_tip != last_rev:
1711
# our last revision was not the prior branch last revision
1712
# and we have converted that last revision to a pending merge.
1713
# base is somewhere between the branch tip now
1714
# and the now pending merge
1715
from bzrlib.revision import common_ancestor
1717
base_rev_id = common_ancestor(self.branch.last_revision(),
1719
self.branch.repository)
1720
except errors.NoCommonAncestor:
1722
base_tree = self.branch.repository.revision_tree(base_rev_id)
1723
other_tree = self.branch.repository.revision_tree(old_tip)
1724
result += merge.merge_inner(
1731
@needs_tree_write_lock
1732
def _write_inventory(self, inv):
1733
"""Write inventory as the current inventory."""
1734
self._set_inventory(inv, dirty=True)
1737
def set_conflicts(self, arg):
1738
raise UnsupportedOperation(self.set_conflicts, self)
1740
def add_conflicts(self, arg):
1741
raise UnsupportedOperation(self.add_conflicts, self)
1744
def conflicts(self):
1745
conflicts = _mod_conflicts.ConflictList()
1746
for conflicted in self._iter_conflicts():
1749
if file_kind(self.abspath(conflicted)) != "file":
1751
except errors.NoSuchFile:
1754
for suffix in ('.THIS', '.OTHER'):
1756
kind = file_kind(self.abspath(conflicted+suffix))
1759
except errors.NoSuchFile:
1763
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1764
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1766
file_id=self.path2id(conflicted)))
1770
class WorkingTree2(WorkingTree):
1771
"""This is the Format 2 working tree.
1773
This was the first weave based working tree.
1774
- uses os locks for locking.
1775
- uses the branch last-revision.
1778
def lock_tree_write(self):
1779
"""See WorkingTree.lock_tree_write().
1781
In Format2 WorkingTrees we have a single lock for the branch and tree
1782
so lock_tree_write() degrades to lock_write().
1784
self.branch.lock_write()
1786
return self._control_files.lock_write()
1788
self.branch.unlock()
1792
# we share control files:
1793
if self._control_files._lock_count == 3:
1794
# _inventory_is_modified is always False during a read lock.
1795
if self._inventory_is_modified:
1797
if self._hashcache.needs_write:
1798
self._hashcache.write()
1799
# reverse order of locking.
1801
return self._control_files.unlock()
1803
self.branch.unlock()
1806
class WorkingTree3(WorkingTree):
1807
"""This is the Format 3 working tree.
1809
This differs from the base WorkingTree by:
1810
- having its own file lock
1811
- having its own last-revision property.
1813
This is new in bzr 0.8
1817
def _last_revision(self):
1818
"""See Mutable.last_revision."""
1820
return self._control_files.get_utf8('last-revision').read()
1824
def _change_last_revision(self, revision_id):
1825
"""See WorkingTree._change_last_revision."""
1826
if revision_id is None or revision_id == NULL_REVISION:
1828
self._control_files._transport.delete('last-revision')
1829
except errors.NoSuchFile:
1833
self._control_files.put_utf8('last-revision', revision_id)
1836
@needs_tree_write_lock
1837
def set_conflicts(self, conflicts):
1838
self._put_rio('conflicts', conflicts.to_stanzas(),
1841
@needs_tree_write_lock
1842
def add_conflicts(self, new_conflicts):
1843
conflict_set = set(self.conflicts())
1844
conflict_set.update(set(list(new_conflicts)))
1845
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1846
key=_mod_conflicts.Conflict.sort_key)))
1849
def conflicts(self):
1851
confile = self._control_files.get('conflicts')
1853
return _mod_conflicts.ConflictList()
1855
if confile.next() != CONFLICT_HEADER_1 + '\n':
1856
raise ConflictFormatError()
1857
except StopIteration:
1858
raise ConflictFormatError()
1859
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1862
if self._control_files._lock_count == 1:
1863
# _inventory_is_modified is always False during a read lock.
1864
if self._inventory_is_modified:
1866
if self._hashcache.needs_write:
1867
self._hashcache.write()
1868
# reverse order of locking.
1870
return self._control_files.unlock()
1872
self.branch.unlock()
1875
def get_conflicted_stem(path):
1876
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1877
if path.endswith(suffix):
1878
return path[:-len(suffix)]
1880
@deprecated_function(zero_eight)
1881
def is_control_file(filename):
1882
"""See WorkingTree.is_control_filename(filename)."""
1883
## FIXME: better check
1884
filename = normpath(filename)
1885
while filename != '':
1886
head, tail = os.path.split(filename)
1887
## mutter('check %r for control file' % ((head, tail),))
1890
if filename == head:
1896
class WorkingTreeFormat(object):
1897
"""An encapsulation of the initialization and open routines for a format.
1899
Formats provide three things:
1900
* An initialization routine,
1904
Formats are placed in an dict by their format string for reference
1905
during workingtree opening. Its not required that these be instances, they
1906
can be classes themselves with class methods - it simply depends on
1907
whether state is needed for a given format or not.
1909
Once a format is deprecated, just deprecate the initialize and open
1910
methods on the format class. Do not deprecate the object, as the
1911
object will be created every time regardless.
1914
_default_format = None
1915
"""The default format used for new trees."""
1918
"""The known formats."""
1921
def find_format(klass, a_bzrdir):
1922
"""Return the format for the working tree object in a_bzrdir."""
1924
transport = a_bzrdir.get_workingtree_transport(None)
1925
format_string = transport.get("format").read()
1926
return klass._formats[format_string]
1928
raise errors.NoWorkingTree(base=transport.base)
1930
raise errors.UnknownFormatError(format=format_string)
1933
def get_default_format(klass):
1934
"""Return the current default format."""
1935
return klass._default_format
1937
def get_format_string(self):
1938
"""Return the ASCII format string that identifies this format."""
1939
raise NotImplementedError(self.get_format_string)
1941
def get_format_description(self):
1942
"""Return the short description for this format."""
1943
raise NotImplementedError(self.get_format_description)
1945
def is_supported(self):
1946
"""Is this format supported?
1948
Supported formats can be initialized and opened.
1949
Unsupported formats may not support initialization or committing or
1950
some other features depending on the reason for not being supported.
1955
def register_format(klass, format):
1956
klass._formats[format.get_format_string()] = format
1959
def set_default_format(klass, format):
1960
klass._default_format = format
1963
def unregister_format(klass, format):
1964
assert klass._formats[format.get_format_string()] is format
1965
del klass._formats[format.get_format_string()]
1969
class WorkingTreeFormat2(WorkingTreeFormat):
1970
"""The second working tree format.
1972
This format modified the hash cache from the format 1 hash cache.
1975
def get_format_description(self):
1976
"""See WorkingTreeFormat.get_format_description()."""
1977
return "Working tree format 2"
1979
def stub_initialize_remote(self, control_files):
1980
"""As a special workaround create critical control files for a remote working tree
1982
This ensures that it can later be updated and dealt with locally,
1983
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1984
no working tree. (See bug #43064).
1988
xml5.serializer_v5.write_inventory(inv, sio)
1990
control_files.put('inventory', sio)
1992
control_files.put_utf8('pending-merges', '')
1995
def initialize(self, a_bzrdir, revision_id=None):
1996
"""See WorkingTreeFormat.initialize()."""
1997
if not isinstance(a_bzrdir.transport, LocalTransport):
1998
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1999
branch = a_bzrdir.open_branch()
2000
if revision_id is not None:
2003
revision_history = branch.revision_history()
2005
position = revision_history.index(revision_id)
2007
raise errors.NoSuchRevision(branch, revision_id)
2008
branch.set_revision_history(revision_history[:position + 1])
2011
revision = branch.last_revision()
2013
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2019
basis_tree = branch.repository.revision_tree(revision)
2020
if basis_tree.inventory.root is not None:
2021
wt.set_root_id(basis_tree.inventory.root.file_id)
2022
# set the parent list and cache the basis tree.
2023
wt.set_parent_trees([(revision, basis_tree)])
2024
transform.build_tree(basis_tree, wt)
2028
super(WorkingTreeFormat2, self).__init__()
2029
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2031
def open(self, a_bzrdir, _found=False):
2032
"""Return the WorkingTree object for a_bzrdir
2034
_found is a private parameter, do not use it. It is used to indicate
2035
if format probing has already been done.
2038
# we are being called directly and must probe.
2039
raise NotImplementedError
2040
if not isinstance(a_bzrdir.transport, LocalTransport):
2041
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2042
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2048
class WorkingTreeFormat3(WorkingTreeFormat):
2049
"""The second working tree format updated to record a format marker.
2052
- exists within a metadir controlling .bzr
2053
- includes an explicit version marker for the workingtree control
2054
files, separate from the BzrDir format
2055
- modifies the hash cache format
2057
- uses a LockDir to guard access for writes.
2060
def get_format_string(self):
2061
"""See WorkingTreeFormat.get_format_string()."""
2062
return "Bazaar-NG Working Tree format 3"
2064
def get_format_description(self):
2065
"""See WorkingTreeFormat.get_format_description()."""
2066
return "Working tree format 3"
2068
_lock_file_name = 'lock'
2069
_lock_class = LockDir
2071
def _open_control_files(self, a_bzrdir):
2072
transport = a_bzrdir.get_workingtree_transport(None)
2073
return LockableFiles(transport, self._lock_file_name,
2076
def initialize(self, a_bzrdir, revision_id=None):
2077
"""See WorkingTreeFormat.initialize().
2079
revision_id allows creating a working tree at a different
2080
revision than the branch is at.
2082
if not isinstance(a_bzrdir.transport, LocalTransport):
2083
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2084
transport = a_bzrdir.get_workingtree_transport(self)
2085
control_files = self._open_control_files(a_bzrdir)
2086
control_files.create_lock()
2087
control_files.lock_write()
2088
control_files.put_utf8('format', self.get_format_string())
2089
branch = a_bzrdir.open_branch()
2090
if revision_id is None:
2091
revision_id = branch.last_revision()
2092
# WorkingTree3 can handle an inventory which has a unique root id.
2093
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2094
# those trees. And because there isn't a format bump inbetween, we
2095
# are maintaining compatibility with older clients.
2096
# inv = Inventory(root_id=gen_root_id())
2098
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2104
_control_files=control_files)
2105
wt.lock_tree_write()
2107
basis_tree = branch.repository.revision_tree(revision_id)
2108
# only set an explicit root id if there is one to set.
2109
if basis_tree.inventory.root is not None:
2110
wt.set_root_id(basis_tree.inventory.root.file_id)
2111
if revision_id == NULL_REVISION:
2112
wt.set_parent_trees([])
2114
wt.set_parent_trees([(revision_id, basis_tree)])
2115
transform.build_tree(basis_tree, wt)
2117
# Unlock in this order so that the unlock-triggers-flush in
2118
# WorkingTree is given a chance to fire.
2119
control_files.unlock()
2124
super(WorkingTreeFormat3, self).__init__()
2125
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2127
def open(self, a_bzrdir, _found=False):
2128
"""Return the WorkingTree object for a_bzrdir
2130
_found is a private parameter, do not use it. It is used to indicate
2131
if format probing has already been done.
2134
# we are being called directly and must probe.
2135
raise NotImplementedError
2136
if not isinstance(a_bzrdir.transport, LocalTransport):
2137
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2138
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2140
def _open(self, a_bzrdir, control_files):
2141
"""Open the tree itself.
2143
:param a_bzrdir: the dir for the tree.
2144
:param control_files: the control files for the tree.
2146
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2150
_control_files=control_files)
2153
return self.get_format_string()
2156
# formats which have no format string are not discoverable
2157
# and not independently creatable, so are not registered.
2158
__default_format = WorkingTreeFormat3()
2159
WorkingTreeFormat.register_format(__default_format)
2160
WorkingTreeFormat.set_default_format(__default_format)
2161
_legacy_formats = [WorkingTreeFormat2(),
2165
class WorkingTreeTestProviderAdapter(object):
2166
"""A tool to generate a suite testing multiple workingtree formats at once.
2168
This is done by copying the test once for each transport and injecting
2169
the transport_server, transport_readonly_server, and workingtree_format
2170
classes into each copy. Each copy is also given a new id() to make it
2174
def __init__(self, transport_server, transport_readonly_server, formats):
2175
self._transport_server = transport_server
2176
self._transport_readonly_server = transport_readonly_server
2177
self._formats = formats
2179
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2180
"""Clone test for adaption."""
2181
new_test = deepcopy(test)
2182
new_test.transport_server = self._transport_server
2183
new_test.transport_readonly_server = self._transport_readonly_server
2184
new_test.bzrdir_format = bzrdir_format
2185
new_test.workingtree_format = workingtree_format
2186
def make_new_test_id():
2187
new_id = "%s(%s)" % (test.id(), variation)
2188
return lambda: new_id
2189
new_test.id = make_new_test_id()
2192
def adapt(self, test):
2193
from bzrlib.tests import TestSuite
2194
result = TestSuite()
2195
for workingtree_format, bzrdir_format in self._formats:
2196
new_test = self._clone_test(
2199
workingtree_format, workingtree_format.__class__.__name__)
2200
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
