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
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
45
from copy import deepcopy
54
conflicts as _mod_conflicts,
68
from bzrlib.transport import get_transport
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.errors import (BzrCheckError,
77
WeaveRevisionNotPresent,
81
MergeModifiedFormatError,
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
@deprecated_function(zero_thirteen)
123
def gen_file_id(name):
124
"""Return new file id for the basename 'name'.
126
Use bzrlib.generate_ids.gen_file_id() instead
128
return generate_ids.gen_file_id(name)
131
@deprecated_function(zero_thirteen)
133
"""Return a new tree-root file id.
135
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
137
return generate_ids.gen_root_id()
140
class TreeEntry(object):
141
"""An entry that implements the minimum interface used by commands.
143
This needs further inspection, it may be better to have
144
InventoryEntries without ids - though that seems wrong. For now,
145
this is a parallel hierarchy to InventoryEntry, and needs to become
146
one of several things: decorates to that hierarchy, children of, or
148
Another note is that these objects are currently only used when there is
149
no InventoryEntry available - i.e. for unversioned objects.
150
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
153
def __eq__(self, other):
154
# yes, this us ugly, TODO: best practice __eq__ style.
155
return (isinstance(other, TreeEntry)
156
and other.__class__ == self.__class__)
158
def kind_character(self):
162
class TreeDirectory(TreeEntry):
163
"""See TreeEntry. This is a directory in a working tree."""
165
def __eq__(self, other):
166
return (isinstance(other, TreeDirectory)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeFile(TreeEntry):
174
"""See TreeEntry. This is a regular file in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeFile)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeLink(TreeEntry):
185
"""See TreeEntry. This is a symlink in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeLink)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class WorkingTree(bzrlib.mutabletree.MutableTree):
196
"""Working copy tree.
198
The inventory is held in the `Branch` working-inventory, and the
199
files are in a directory on disk.
201
It is possible for a `WorkingTree` to have a filename which is
202
not listed in the Inventory and vice versa.
205
def __init__(self, basedir='.',
206
branch=DEPRECATED_PARAMETER,
212
"""Construct a WorkingTree for basedir.
214
If the branch is not supplied, it is opened automatically.
215
If the branch is supplied, it must be the branch for this basedir.
216
(branch.base is not cross checked, because for remote branches that
217
would be meaningless).
219
self._format = _format
220
self.bzrdir = _bzrdir
222
# not created via open etc.
223
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
224
"Please use bzrdir.open_workingtree or WorkingTree.open().",
227
wt = WorkingTree.open(basedir)
228
self._branch = wt.branch
229
self.basedir = wt.basedir
230
self._control_files = wt._control_files
231
self._hashcache = wt._hashcache
232
self._set_inventory(wt._inventory, dirty=False)
233
self._format = wt._format
234
self.bzrdir = wt.bzrdir
235
from bzrlib.hashcache import HashCache
236
from bzrlib.trace import note, mutter
237
assert isinstance(basedir, basestring), \
238
"base directory %r is not a string" % basedir
239
basedir = safe_unicode(basedir)
240
mutter("opening working tree %r", basedir)
241
if deprecated_passed(branch):
243
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
244
" Please use bzrdir.open_workingtree() or"
245
" WorkingTree.open().",
249
self._branch = branch
251
self._branch = self.bzrdir.open_branch()
252
self.basedir = realpath(basedir)
253
# if branch is at our basedir and is a format 6 or less
254
if isinstance(self._format, WorkingTreeFormat2):
255
# share control object
256
self._control_files = self.branch.control_files
258
# assume all other formats have their own control files.
259
assert isinstance(_control_files, LockableFiles), \
260
"_control_files must be a LockableFiles, not %r" \
262
self._control_files = _control_files
263
# update the whole cache up front and write to disk if anything changed;
264
# in the future we might want to do this more selectively
265
# two possible ways offer themselves : in self._unlock, write the cache
266
# if needed, or, when the cache sees a change, append it to the hash
267
# cache file, and have the parser take the most recent entry for a
269
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
270
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
# is this scan needed ? it makes things kinda slow.
279
if _inventory is None:
280
self._inventory_is_modified = False
281
self.read_working_inventory()
283
# the caller of __init__ has provided an inventory,
284
# we assume they know what they are doing - as its only
285
# the Format factory and creation methods that are
286
# permitted to do this.
287
self._set_inventory(_inventory, dirty=False)
290
fget=lambda self: self._branch,
291
doc="""The branch this WorkingTree is connected to.
293
This cannot be set - it is reflective of the actual disk structure
294
the working tree has been constructed from.
297
def break_lock(self):
298
"""Break a lock if one is present from another instance.
300
Uses the ui factory to ask for confirmation if the lock may be from
303
This will probe the repository for its lock as well.
305
self._control_files.break_lock()
306
self.branch.break_lock()
308
def _set_inventory(self, inv, dirty):
309
"""Set the internal cached inventory.
311
:param inv: The inventory to set.
312
:param dirty: A boolean indicating whether the inventory is the same
313
logical inventory as whats on disk. If True the inventory is not
314
the same and should be written to disk or data will be lost, if
315
False then the inventory is the same as that on disk and any
316
serialisation would be unneeded overhead.
318
assert inv.root is not None
319
self._inventory = inv
320
self._inventory_is_modified = dirty
323
def open(path=None, _unsupported=False):
324
"""Open an existing working tree at path.
328
path = os.path.getcwdu()
329
control = bzrdir.BzrDir.open(path, _unsupported)
330
return control.open_workingtree(_unsupported)
333
def open_containing(path=None):
334
"""Open an existing working tree which has its root about path.
336
This probes for a working tree at path and searches upwards from there.
338
Basically we keep looking up until we find the control directory or
339
run into /. If there isn't one, raises NotBranchError.
340
TODO: give this a new exception.
341
If there is one, it is returned, along with the unused portion of path.
343
:return: The WorkingTree that contains 'path', and the rest of path
346
path = osutils.getcwd()
347
control, relpath = bzrdir.BzrDir.open_containing(path)
349
return control.open_workingtree(), relpath
352
def open_downlevel(path=None):
353
"""Open an unsupported working tree.
355
Only intended for advanced situations like upgrading part of a bzrdir.
357
return WorkingTree.open(path, _unsupported=True)
360
"""Iterate through file_ids for this tree.
362
file_ids are in a WorkingTree if they are in the working inventory
363
and the working file exists.
365
inv = self._inventory
366
for path, ie in inv.iter_entries():
367
if osutils.lexists(self.abspath(path)):
371
return "<%s of %s>" % (self.__class__.__name__,
372
getattr(self, 'basedir', None))
374
def abspath(self, filename):
375
return pathjoin(self.basedir, filename)
377
def basis_tree(self):
378
"""Return RevisionTree for the current last revision.
380
If the left most parent is a ghost then the returned tree will be an
381
empty tree - one obtained by calling repository.revision_tree(None).
384
revision_id = self.get_parent_ids()[0]
386
# no parents, return an empty revision tree.
387
# in the future this should return the tree for
388
# 'empty:' - the implicit root empty tree.
389
return self.branch.repository.revision_tree(None)
392
xml = self.read_basis_inventory()
393
inv = xml6.serializer_v6.read_inventory_from_string(xml)
394
if inv is not None and inv.revision_id == revision_id:
395
return bzrlib.revisiontree.RevisionTree(
396
self.branch.repository, inv, revision_id)
397
except (NoSuchFile, errors.BadInventoryFormat):
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except errors.RevisionNotPresent:
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(None)
414
@deprecated_method(zero_eight)
415
def create(branch, directory):
416
"""Create a workingtree for branch at directory.
418
If existing_directory already exists it must have a .bzr directory.
419
If it does not exist, it will be created.
421
This returns a new WorkingTree object for the new checkout.
423
TODO FIXME RBC 20060124 when we have checkout formats in place this
424
should accept an optional revisionid to checkout [and reject this if
425
checking out into the same dir as a pre-checkout-aware branch format.]
427
XXX: When BzrDir is present, these should be created through that
430
warnings.warn('delete WorkingTree.create', stacklevel=3)
431
transport = get_transport(directory)
432
if branch.bzrdir.root_transport.base == transport.base:
434
return branch.bzrdir.create_workingtree()
435
# different directory,
436
# create a branch reference
437
# and now a working tree.
438
raise NotImplementedError
441
@deprecated_method(zero_eight)
442
def create_standalone(directory):
443
"""Create a checkout and a branch and a repo at directory.
445
Directory must exist and be empty.
447
please use BzrDir.create_standalone_workingtree
449
return bzrdir.BzrDir.create_standalone_workingtree(directory)
451
def relpath(self, path):
452
"""Return the local path portion from a given path.
454
The path may be absolute or relative. If its a relative path it is
455
interpreted relative to the python current working directory.
457
return osutils.relpath(self.basedir, path)
459
def has_filename(self, filename):
460
return osutils.lexists(self.abspath(filename))
462
def get_file(self, file_id):
463
return self.get_file_byname(self.id2path(file_id))
465
def get_file_text(self, file_id):
466
return self.get_file(file_id).read()
468
def get_file_byname(self, filename):
469
return file(self.abspath(filename), 'rb')
471
def get_parent_ids(self):
472
"""See Tree.get_parent_ids.
474
This implementation reads the pending merges list and last_revision
475
value and uses that to decide what the parents list should be.
477
last_rev = self._last_revision()
483
merges_file = self._control_files.get_utf8('pending-merges')
487
for l in merges_file.readlines():
488
parents.append(l.rstrip('\n'))
492
def get_root_id(self):
493
"""Return the id of this trees root"""
494
return self._inventory.root.file_id
496
def _get_store_filename(self, file_id):
497
## XXX: badly named; this is not in the store at all
498
return self.abspath(self.id2path(file_id))
501
def clone(self, to_bzrdir, revision_id=None, basis=None):
502
"""Duplicate this working tree into to_bzr, including all state.
504
Specifically modified files are kept as modified, but
505
ignored and unknown files are discarded.
507
If you want to make a new line of development, see bzrdir.sprout()
510
If not None, the cloned tree will have its last revision set to
511
revision, and and difference between the source trees last revision
512
and this one merged in.
515
If not None, a closer copy of a tree which may have some files in
516
common, and which file content should be preferentially copied from.
518
# assumes the target bzr dir format is compatible.
519
result = self._format.initialize(to_bzrdir)
520
self.copy_content_into(result, revision_id)
524
def copy_content_into(self, tree, revision_id=None):
525
"""Copy the current content and user files of this tree into tree."""
526
tree.set_root_id(self.get_root_id())
527
if revision_id is None:
528
merge.transform_tree(tree, self)
530
# TODO now merge from tree.last_revision to revision (to preserve
531
# user local changes)
532
merge.transform_tree(tree, self)
533
tree.set_parent_ids([revision_id])
535
def id2abspath(self, file_id):
536
return self.abspath(self.id2path(file_id))
538
def has_id(self, file_id):
539
# files that have been deleted are excluded
540
inv = self._inventory
541
if not inv.has_id(file_id):
543
path = inv.id2path(file_id)
544
return osutils.lexists(self.abspath(path))
546
def has_or_had_id(self, file_id):
547
if file_id == self.inventory.root.file_id:
549
return self.inventory.has_id(file_id)
551
__contains__ = has_id
553
def get_file_size(self, file_id):
554
return os.path.getsize(self.id2abspath(file_id))
557
def get_file_sha1(self, file_id, path=None):
559
path = self._inventory.id2path(file_id)
560
return self._hashcache.get_sha1(path)
562
def get_file_mtime(self, file_id, path=None):
564
path = self._inventory.id2path(file_id)
565
return os.lstat(self.abspath(path)).st_mtime
567
if not supports_executable():
568
def is_executable(self, file_id, path=None):
569
return self._inventory[file_id].executable
571
def is_executable(self, file_id, path=None):
573
path = self._inventory.id2path(file_id)
574
mode = os.lstat(self.abspath(path)).st_mode
575
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
578
def _add(self, files, ids, kinds):
579
"""See MutableTree._add."""
580
# TODO: Re-adding a file that is removed in the working copy
581
# should probably put it back with the previous ID.
582
# the read and write working inventory should not occur in this
583
# function - they should be part of lock_write and unlock.
584
inv = self.read_working_inventory()
585
for f, file_id, kind in zip(files, ids, kinds):
586
assert kind is not None
588
inv.add_path(f, kind=kind)
590
inv.add_path(f, kind=kind, file_id=file_id)
591
self._write_inventory(inv)
593
@needs_tree_write_lock
594
def _gather_kinds(self, files, kinds):
595
"""See MutableTree._gather_kinds."""
596
for pos, f in enumerate(files):
597
if kinds[pos] is None:
598
fullpath = normpath(self.abspath(f))
600
kinds[pos] = file_kind(fullpath)
602
if e.errno == errno.ENOENT:
603
raise NoSuchFile(fullpath)
606
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
607
"""Add revision_id as a parent.
609
This is equivalent to retrieving the current list of parent ids
610
and setting the list to its value plus revision_id.
612
:param revision_id: The revision id to add to the parent list. It may
613
be a ghost revision as long as its not the first parent to be added,
614
or the allow_leftmost_as_ghost parameter is set True.
615
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
617
parents = self.get_parent_ids() + [revision_id]
618
self.set_parent_ids(parents,
619
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
621
@needs_tree_write_lock
622
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
623
"""Add revision_id, tree tuple as a parent.
625
This is equivalent to retrieving the current list of parent trees
626
and setting the list to its value plus parent_tuple. See also
627
add_parent_tree_id - if you only have a parent id available it will be
628
simpler to use that api. If you have the parent already available, using
629
this api is preferred.
631
:param parent_tuple: The (revision id, tree) to add to the parent list.
632
If the revision_id is a ghost, pass None for the tree.
633
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
635
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
636
if len(parent_ids) > 1:
637
# the leftmost may have already been a ghost, preserve that if it
639
allow_leftmost_as_ghost = True
640
self.set_parent_ids(parent_ids,
641
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
643
@needs_tree_write_lock
644
def add_pending_merge(self, *revision_ids):
645
# TODO: Perhaps should check at this point that the
646
# history of the revision is actually present?
647
parents = self.get_parent_ids()
649
for rev_id in revision_ids:
650
if rev_id in parents:
652
parents.append(rev_id)
655
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
657
@deprecated_method(zero_eleven)
659
def pending_merges(self):
660
"""Return a list of pending merges.
662
These are revisions that have been merged into the working
663
directory but not yet committed.
665
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
666
instead - which is available on all tree objects.
668
return self.get_parent_ids()[1:]
670
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
671
"""Common ghost checking functionality from set_parent_*.
673
This checks that the left hand-parent exists if there are any
676
if len(revision_ids) > 0:
677
leftmost_id = revision_ids[0]
678
if (not allow_leftmost_as_ghost and not
679
self.branch.repository.has_revision(leftmost_id)):
680
raise errors.GhostRevisionUnusableHere(leftmost_id)
682
def _set_merges_from_parent_ids(self, parent_ids):
683
merges = parent_ids[1:]
684
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
686
@needs_tree_write_lock
687
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
688
"""Set the parent ids to revision_ids.
690
See also set_parent_trees. This api will try to retrieve the tree data
691
for each element of revision_ids from the trees repository. If you have
692
tree data already available, it is more efficient to use
693
set_parent_trees rather than set_parent_ids. set_parent_ids is however
694
an easier API to use.
696
:param revision_ids: The revision_ids to set as the parent ids of this
697
working tree. Any of these may be ghosts.
699
self._check_parents_for_ghosts(revision_ids,
700
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
702
if len(revision_ids) > 0:
703
self.set_last_revision(revision_ids[0])
705
self.set_last_revision(None)
707
self._set_merges_from_parent_ids(revision_ids)
709
@needs_tree_write_lock
710
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
711
"""See MutableTree.set_parent_trees."""
712
parent_ids = [rev for (rev, tree) in parents_list]
714
self._check_parents_for_ghosts(parent_ids,
715
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
717
if len(parent_ids) == 0:
718
leftmost_parent_id = None
719
leftmost_parent_tree = None
721
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
723
if self._change_last_revision(leftmost_parent_id):
724
if leftmost_parent_tree is None:
725
# If we don't have a tree, fall back to reading the
726
# parent tree from the repository.
727
self._cache_basis_inventory(leftmost_parent_id)
729
inv = leftmost_parent_tree.inventory
730
xml = self._create_basis_xml_from_inventory(
731
leftmost_parent_id, inv)
732
self._write_basis_inventory(xml)
733
self._set_merges_from_parent_ids(parent_ids)
735
@needs_tree_write_lock
736
def set_pending_merges(self, rev_list):
737
parents = self.get_parent_ids()
738
leftmost = parents[:1]
739
new_parents = leftmost + rev_list
740
self.set_parent_ids(new_parents)
742
@needs_tree_write_lock
743
def set_merge_modified(self, modified_hashes):
745
for file_id, hash in modified_hashes.iteritems():
746
yield Stanza(file_id=file_id, hash=hash)
747
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
749
@needs_tree_write_lock
750
def _put_rio(self, filename, stanzas, header):
751
my_file = rio_file(stanzas, header)
752
self._control_files.put(filename, my_file)
754
@needs_write_lock # because merge pulls data into the branch.
755
def merge_from_branch(self, branch, to_revision=None):
756
"""Merge from a branch into this working tree.
758
:param branch: The branch to merge from.
759
:param to_revision: If non-None, the merge will merge to to_revision, but
760
not beyond it. to_revision does not need to be in the history of
761
the branch when it is supplied. If None, to_revision defaults to
762
branch.last_revision().
764
from bzrlib.merge import Merger, Merge3Merger
765
pb = bzrlib.ui.ui_factory.nested_progress_bar()
767
merger = Merger(self.branch, this_tree=self, pb=pb)
768
merger.pp = ProgressPhase("Merge phase", 5, pb)
769
merger.pp.next_phase()
770
# check that there are no
772
merger.check_basis(check_clean=True, require_commits=False)
773
if to_revision is None:
774
to_revision = branch.last_revision()
775
merger.other_rev_id = to_revision
776
if merger.other_rev_id is None:
777
raise error.NoCommits(branch)
778
self.branch.fetch(branch, last_revision=merger.other_rev_id)
779
merger.other_basis = merger.other_rev_id
780
merger.other_tree = self.branch.repository.revision_tree(
782
merger.pp.next_phase()
784
if merger.base_rev_id == merger.other_rev_id:
785
raise errors.PointlessMerge
786
merger.backup_files = False
787
merger.merge_type = Merge3Merger
788
merger.set_interesting_files(None)
789
merger.show_base = False
790
merger.reprocess = False
791
conflicts = merger.do_merge()
798
def merge_modified(self):
800
hashfile = self._control_files.get('merge-hashes')
805
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
806
raise MergeModifiedFormatError()
807
except StopIteration:
808
raise MergeModifiedFormatError()
809
for s in RioReader(hashfile):
810
file_id = s.get("file_id")
811
if file_id not in self.inventory:
814
if hash == self.get_file_sha1(file_id):
815
merge_hashes[file_id] = hash
819
def mkdir(self, path, file_id=None):
820
"""See MutableTree.mkdir()."""
822
file_id = generate_ids.gen_file_id(os.path.basename(path))
823
os.mkdir(self.abspath(path))
824
self.add(path, file_id, 'directory')
827
def get_symlink_target(self, file_id):
828
return os.readlink(self.id2abspath(file_id))
830
def file_class(self, filename):
831
if self.path2id(filename):
833
elif self.is_ignored(filename):
839
"""Write the in memory inventory to disk."""
840
# TODO: Maybe this should only write on dirty ?
841
if self._control_files._lock_mode != 'w':
842
raise errors.NotWriteLocked(self)
844
xml5.serializer_v5.write_inventory(self._inventory, sio)
846
self._control_files.put('inventory', sio)
847
self._inventory_is_modified = False
849
def list_files(self, include_root=False):
850
"""Recursively list all files as (path, class, kind, id, entry).
852
Lists, but does not descend into unversioned directories.
854
This does not include files that have been deleted in this
857
Skips the control directory.
859
inv = self._inventory
860
if include_root is True:
861
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
862
# Convert these into local objects to save lookup times
863
pathjoin = osutils.pathjoin
864
file_kind = osutils.file_kind
866
# transport.base ends in a slash, we want the piece
867
# between the last two slashes
868
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
870
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
872
# directory file_id, relative path, absolute path, reverse sorted children
873
children = os.listdir(self.basedir)
875
# jam 20060527 The kernel sized tree seems equivalent whether we
876
# use a deque and popleft to keep them sorted, or if we use a plain
877
# list and just reverse() them.
878
children = collections.deque(children)
879
stack = [(inv.root.file_id, u'', self.basedir, children)]
881
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
884
f = children.popleft()
885
## TODO: If we find a subdirectory with its own .bzr
886
## directory, then that is a separate tree and we
887
## should exclude it.
889
# the bzrdir for this tree
890
if transport_base_dir == f:
893
# we know that from_dir_relpath and from_dir_abspath never end in a slash
894
# and 'f' doesn't begin with one, we can do a string op, rather
895
# than the checks of pathjoin(), all relative paths will have an extra slash
897
fp = from_dir_relpath + '/' + f
900
fap = from_dir_abspath + '/' + f
902
f_ie = inv.get_child(from_dir_id, f)
905
elif self.is_ignored(fp[1:]):
908
# we may not have found this file, because of a unicode issue
909
f_norm, can_access = osutils.normalized_filename(f)
910
if f == f_norm or not can_access:
911
# No change, so treat this file normally
914
# this file can be accessed by a normalized path
915
# check again if it is versioned
916
# these lines are repeated here for performance
918
fp = from_dir_relpath + '/' + f
919
fap = from_dir_abspath + '/' + f
920
f_ie = inv.get_child(from_dir_id, f)
923
elif self.is_ignored(fp[1:]):
932
raise BzrCheckError("file %r entered as kind %r id %r, "
934
% (fap, f_ie.kind, f_ie.file_id, fk))
936
# make a last minute entry
938
yield fp[1:], c, fk, f_ie.file_id, f_ie
941
yield fp[1:], c, fk, None, fk_entries[fk]()
943
yield fp[1:], c, fk, None, TreeEntry()
946
if fk != 'directory':
949
# But do this child first
950
new_children = os.listdir(fap)
952
new_children = collections.deque(new_children)
953
stack.append((f_ie.file_id, fp, fap, new_children))
954
# Break out of inner loop, so that we start outer loop with child
957
# if we finished all children, pop it off the stack
960
@needs_tree_write_lock
961
def move(self, from_paths, to_name):
964
to_name must exist in the inventory.
966
If to_name exists and is a directory, the files are moved into
967
it, keeping their old names.
969
Note that to_name is only the last component of the new name;
970
this doesn't change the directory.
972
This returns a list of (from_path, to_path) pairs for each
976
## TODO: Option to move IDs only
977
assert not isinstance(from_paths, basestring)
979
to_abs = self.abspath(to_name)
980
if not isdir(to_abs):
981
raise BzrError("destination %r is not a directory" % to_abs)
982
if not self.has_filename(to_name):
983
raise BzrError("destination %r not in working directory" % to_abs)
984
to_dir_id = inv.path2id(to_name)
985
if to_dir_id is None and to_name != '':
986
raise BzrError("destination %r is not a versioned directory" % to_name)
987
to_dir_ie = inv[to_dir_id]
988
if to_dir_ie.kind != 'directory':
989
raise BzrError("destination %r is not a directory" % to_abs)
991
to_idpath = inv.get_idpath(to_dir_id)
994
if not self.has_filename(f):
995
raise BzrError("%r does not exist in working tree" % f)
996
f_id = inv.path2id(f)
998
raise BzrError("%r is not versioned" % f)
999
name_tail = splitpath(f)[-1]
1000
dest_path = pathjoin(to_name, name_tail)
1001
if self.has_filename(dest_path):
1002
raise BzrError("destination %r already exists" % dest_path)
1003
if f_id in to_idpath:
1004
raise BzrError("can't move %r to a subdirectory of itself" % f)
1006
# OK, so there's a race here, it's possible that someone will
1007
# create a file in this interval and then the rename might be
1008
# left half-done. But we should have caught most problems.
1009
orig_inv = deepcopy(self.inventory)
1010
original_modified = self._inventory_is_modified
1013
self._inventory_is_modified = True
1014
for f in from_paths:
1015
name_tail = splitpath(f)[-1]
1016
dest_path = pathjoin(to_name, name_tail)
1017
result.append((f, dest_path))
1018
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1020
osutils.rename(self.abspath(f), self.abspath(dest_path))
1022
raise BzrError("failed to rename %r to %r: %s" %
1023
(f, dest_path, e[1]))
1025
# restore the inventory on error
1026
self._set_inventory(orig_inv, dirty=original_modified)
1028
self._write_inventory(inv)
1031
@needs_tree_write_lock
1032
def rename_one(self, from_rel, to_rel):
1035
This can change the directory or the filename or both.
1037
inv = self.inventory
1038
if not self.has_filename(from_rel):
1039
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1040
if self.has_filename(to_rel):
1041
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1043
file_id = inv.path2id(from_rel)
1045
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1047
entry = inv[file_id]
1048
from_parent = entry.parent_id
1049
from_name = entry.name
1051
if inv.path2id(to_rel):
1052
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1054
to_dir, to_tail = os.path.split(to_rel)
1055
to_dir_id = inv.path2id(to_dir)
1056
if to_dir_id is None and to_dir != '':
1057
raise BzrError("can't determine destination directory id for %r" % to_dir)
1059
mutter("rename_one:")
1060
mutter(" file_id {%s}" % file_id)
1061
mutter(" from_rel %r" % from_rel)
1062
mutter(" to_rel %r" % to_rel)
1063
mutter(" to_dir %r" % to_dir)
1064
mutter(" to_dir_id {%s}" % to_dir_id)
1066
inv.rename(file_id, to_dir_id, to_tail)
1068
from_abs = self.abspath(from_rel)
1069
to_abs = self.abspath(to_rel)
1071
osutils.rename(from_abs, to_abs)
1073
inv.rename(file_id, from_parent, from_name)
1074
raise BzrError("failed to rename %r to %r: %s"
1075
% (from_abs, to_abs, e[1]))
1076
self._write_inventory(inv)
1080
"""Return all unknown files.
1082
These are files in the working directory that are not versioned or
1083
control files or ignored.
1085
for subp in self.extras():
1086
if not self.is_ignored(subp):
1089
@needs_tree_write_lock
1090
def unversion(self, file_ids):
1091
"""Remove the file ids in file_ids from the current versioned set.
1093
When a file_id is unversioned, all of its children are automatically
1096
:param file_ids: The file ids to stop versioning.
1097
:raises: NoSuchId if any fileid is not currently versioned.
1099
for file_id in file_ids:
1100
if self._inventory.has_id(file_id):
1101
self._inventory.remove_recursive_id(file_id)
1103
raise errors.NoSuchId(self, file_id)
1105
# in the future this should just set a dirty bit to wait for the
1106
# final unlock. However, until all methods of workingtree start
1107
# with the current in -memory inventory rather than triggering
1108
# a read, it is more complex - we need to teach read_inventory
1109
# to know when to read, and when to not read first... and possibly
1110
# to save first when the in memory one may be corrupted.
1111
# so for now, we just only write it if it is indeed dirty.
1113
self._write_inventory(self._inventory)
1115
@deprecated_method(zero_eight)
1116
def iter_conflicts(self):
1117
"""List all files in the tree that have text or content conflicts.
1118
DEPRECATED. Use conflicts instead."""
1119
return self._iter_conflicts()
1121
def _iter_conflicts(self):
1123
for info in self.list_files():
1125
stem = get_conflicted_stem(path)
1128
if stem not in conflicted:
1129
conflicted.add(stem)
1133
def pull(self, source, overwrite=False, stop_revision=None):
1134
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1137
pp = ProgressPhase("Pull phase", 2, top_pb)
1139
old_revision_history = self.branch.revision_history()
1140
basis_tree = self.basis_tree()
1141
count = self.branch.pull(source, overwrite, stop_revision)
1142
new_revision_history = self.branch.revision_history()
1143
if new_revision_history != old_revision_history:
1145
if len(old_revision_history):
1146
other_revision = old_revision_history[-1]
1148
other_revision = None
1149
repository = self.branch.repository
1150
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1152
new_basis_tree = self.branch.basis_tree()
1159
if (basis_tree.inventory.root is None and
1160
new_basis_tree.inventory.root is not None):
1161
self.set_root_id(new_basis_tree.inventory.root.file_id)
1164
# TODO - dedup parents list with things merged by pull ?
1165
# reuse the revisiontree we merged against to set the new
1167
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1168
# we have to pull the merge trees out again, because
1169
# merge_inner has set the ids. - this corner is not yet
1170
# layered well enough to prevent double handling.
1171
merges = self.get_parent_ids()[1:]
1172
parent_trees.extend([
1173
(parent, repository.revision_tree(parent)) for
1175
self.set_parent_trees(parent_trees)
1182
def put_file_bytes_non_atomic(self, file_id, bytes):
1183
"""See MutableTree.put_file_bytes_non_atomic."""
1184
stream = file(self.id2abspath(file_id), 'wb')
1189
# TODO: update the hashcache here ?
1192
"""Yield all unknown files in this WorkingTree.
1194
If there are any unknown directories then only the directory is
1195
returned, not all its children. But if there are unknown files
1196
under a versioned subdirectory, they are returned.
1198
Currently returned depth-first, sorted by name within directories.
1200
## TODO: Work from given directory downwards
1201
for path, dir_entry in self.inventory.directories():
1202
# mutter("search for unknowns in %r", path)
1203
dirabs = self.abspath(path)
1204
if not isdir(dirabs):
1205
# e.g. directory deleted
1209
for subf in os.listdir(dirabs):
1212
if subf not in dir_entry.children:
1213
subf_norm, can_access = osutils.normalized_filename(subf)
1214
if subf_norm != subf and can_access:
1215
if subf_norm not in dir_entry.children:
1216
fl.append(subf_norm)
1222
subp = pathjoin(path, subf)
1226
def ignored_files(self):
1227
"""Yield list of PATH, IGNORE_PATTERN"""
1228
for subp in self.extras():
1229
pat = self.is_ignored(subp)
1233
def get_ignore_list(self):
1234
"""Return list of ignore patterns.
1236
Cached in the Tree object after the first call.
1238
ignoreset = getattr(self, '_ignoreset', None)
1239
if ignoreset is not None:
1242
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1243
ignore_globs.update(ignores.get_runtime_ignores())
1244
ignore_globs.update(ignores.get_user_ignores())
1245
if self.has_filename(bzrlib.IGNORE_FILENAME):
1246
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1248
ignore_globs.update(ignores.parse_ignore_file(f))
1251
self._ignoreset = ignore_globs
1254
def _flush_ignore_list_cache(self):
1255
"""Resets the cached ignore list to force a cache rebuild."""
1256
self._ignoreset = None
1257
self._ignoreglobster = None
1259
def is_ignored(self, filename):
1260
r"""Check whether the filename matches an ignore pattern.
1262
Patterns containing '/' or '\' need to match the whole path;
1263
others match against only the last component.
1265
If the file is ignored, returns the pattern which caused it to
1266
be ignored, otherwise None. So this can simply be used as a
1267
boolean if desired."""
1268
if getattr(self, '_ignoreglobster', None) is None:
1269
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1270
return self._ignoreglobster.match(filename)
1272
def kind(self, file_id):
1273
return file_kind(self.id2abspath(file_id))
1275
def last_revision(self):
1276
"""Return the last revision of the branch for this tree.
1278
This format tree does not support a separate marker for last-revision
1279
compared to the branch.
1281
See MutableTree.last_revision
1283
return self._last_revision()
1286
def _last_revision(self):
1287
"""helper for get_parent_ids."""
1288
return self.branch.last_revision()
1290
def is_locked(self):
1291
return self._control_files.is_locked()
1293
def lock_read(self):
1294
"""See Branch.lock_read, and WorkingTree.unlock."""
1295
self.branch.lock_read()
1297
return self._control_files.lock_read()
1299
self.branch.unlock()
1302
def lock_tree_write(self):
1303
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1304
self.branch.lock_read()
1306
return self._control_files.lock_write()
1308
self.branch.unlock()
1311
def lock_write(self):
1312
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1313
self.branch.lock_write()
1315
return self._control_files.lock_write()
1317
self.branch.unlock()
1320
def get_physical_lock_status(self):
1321
return self._control_files.get_physical_lock_status()
1323
def _basis_inventory_name(self):
1324
return 'basis-inventory-cache'
1326
@needs_tree_write_lock
1327
def set_last_revision(self, new_revision):
1328
"""Change the last revision in the working tree."""
1329
if self._change_last_revision(new_revision):
1330
self._cache_basis_inventory(new_revision)
1332
def _change_last_revision(self, new_revision):
1333
"""Template method part of set_last_revision to perform the change.
1335
This is used to allow WorkingTree3 instances to not affect branch
1336
when their last revision is set.
1338
if new_revision is None:
1339
self.branch.set_revision_history([])
1342
self.branch.generate_revision_history(new_revision)
1343
except errors.NoSuchRevision:
1344
# not present in the repo - dont try to set it deeper than the tip
1345
self.branch.set_revision_history([new_revision])
1348
def _write_basis_inventory(self, xml):
1349
"""Write the basis inventory XML to the basis-inventory file"""
1350
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1351
path = self._basis_inventory_name()
1353
self._control_files.put(path, sio)
1355
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1356
"""Create the text that will be saved in basis-inventory"""
1357
inventory.revision_id = revision_id
1358
return xml6.serializer_v6.write_inventory_to_string(inventory)
1360
def _cache_basis_inventory(self, new_revision):
1361
"""Cache new_revision as the basis inventory."""
1362
# TODO: this should allow the ready-to-use inventory to be passed in,
1363
# as commit already has that ready-to-use [while the format is the
1366
# this double handles the inventory - unpack and repack -
1367
# but is easier to understand. We can/should put a conditional
1368
# in here based on whether the inventory is in the latest format
1369
# - perhaps we should repack all inventories on a repository
1371
# the fast path is to copy the raw xml from the repository. If the
1372
# xml contains 'revision_id="', then we assume the right
1373
# revision_id is set. We must check for this full string, because a
1374
# root node id can legitimately look like 'revision_id' but cannot
1376
xml = self.branch.repository.get_inventory_xml(new_revision)
1377
firstline = xml.split('\n', 1)[0]
1378
if (not 'revision_id="' in firstline or
1379
'format="6"' not in firstline):
1380
inv = self.branch.repository.deserialise_inventory(
1382
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1383
self._write_basis_inventory(xml)
1384
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1387
def read_basis_inventory(self):
1388
"""Read the cached basis inventory."""
1389
path = self._basis_inventory_name()
1390
return self._control_files.get(path).read()
1393
def read_working_inventory(self):
1394
"""Read the working inventory.
1396
:raises errors.InventoryModified: read_working_inventory will fail
1397
when the current in memory inventory has been modified.
1399
# conceptually this should be an implementation detail of the tree.
1400
# XXX: Deprecate this.
1401
# ElementTree does its own conversion from UTF-8, so open in
1403
if self._inventory_is_modified:
1404
raise errors.InventoryModified(self)
1405
result = xml5.serializer_v5.read_inventory(
1406
self._control_files.get('inventory'))
1407
self._set_inventory(result, dirty=False)
1410
@needs_tree_write_lock
1411
def remove(self, files, verbose=False, to_file=None):
1412
"""Remove nominated files from the working inventory..
1414
This does not remove their text. This does not run on XXX on what? RBC
1416
TODO: Refuse to remove modified files unless --force is given?
1418
TODO: Do something useful with directories.
1420
TODO: Should this remove the text or not? Tough call; not
1421
removing may be useful and the user can just use use rm, and
1422
is the opposite of add. Removing it is consistent with most
1423
other tools. Maybe an option.
1425
## TODO: Normalize names
1426
## TODO: Remove nested loops; better scalability
1427
if isinstance(files, basestring):
1430
inv = self.inventory
1432
# do this before any modifications
1434
fid = inv.path2id(f)
1436
# TODO: Perhaps make this just a warning, and continue?
1437
# This tends to happen when
1438
raise NotVersionedError(path=f)
1440
# having remove it, it must be either ignored or unknown
1441
if self.is_ignored(f):
1445
textui.show_status(new_status, inv[fid].kind, f,
1449
self._write_inventory(inv)
1451
@needs_tree_write_lock
1452
def revert(self, filenames, old_tree=None, backups=True,
1453
pb=DummyProgress()):
1454
from bzrlib.conflicts import resolve
1455
if old_tree is None:
1456
old_tree = self.basis_tree()
1457
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1458
if not len(filenames):
1459
self.set_parent_ids(self.get_parent_ids()[:1])
1462
resolve(self, filenames, ignore_misses=True)
1465
# XXX: This method should be deprecated in favour of taking in a proper
1466
# new Inventory object.
1467
@needs_tree_write_lock
1468
def set_inventory(self, new_inventory_list):
1469
from bzrlib.inventory import (Inventory,
1474
inv = Inventory(self.get_root_id())
1475
for path, file_id, parent, kind in new_inventory_list:
1476
name = os.path.basename(path)
1479
# fixme, there should be a factory function inv,add_??
1480
if kind == 'directory':
1481
inv.add(InventoryDirectory(file_id, name, parent))
1482
elif kind == 'file':
1483
inv.add(InventoryFile(file_id, name, parent))
1484
elif kind == 'symlink':
1485
inv.add(InventoryLink(file_id, name, parent))
1487
raise BzrError("unknown kind %r" % kind)
1488
self._write_inventory(inv)
1490
@needs_tree_write_lock
1491
def set_root_id(self, file_id):
1492
"""Set the root id for this tree."""
1495
symbol_versioning.warn(symbol_versioning.zero_twelve
1496
% 'WorkingTree.set_root_id with fileid=None',
1500
inv = self._inventory
1501
orig_root_id = inv.root.file_id
1502
# TODO: it might be nice to exit early if there was nothing
1503
# to do, saving us from trigger a sync on unlock.
1504
self._inventory_is_modified = True
1505
# we preserve the root inventory entry object, but
1506
# unlinkit from the byid index
1507
del inv._byid[inv.root.file_id]
1508
inv.root.file_id = file_id
1509
# and link it into the index with the new changed id.
1510
inv._byid[inv.root.file_id] = inv.root
1511
# and finally update all children to reference the new id.
1512
# XXX: this should be safe to just look at the root.children
1513
# list, not the WHOLE INVENTORY.
1516
if entry.parent_id == orig_root_id:
1517
entry.parent_id = inv.root.file_id
1520
"""See Branch.unlock.
1522
WorkingTree locking just uses the Branch locking facilities.
1523
This is current because all working trees have an embedded branch
1524
within them. IF in the future, we were to make branch data shareable
1525
between multiple working trees, i.e. via shared storage, then we
1526
would probably want to lock both the local tree, and the branch.
1528
raise NotImplementedError(self.unlock)
1531
"""Update a working tree along its branch.
1533
This will update the branch if its bound too, which means we have
1534
multiple trees involved:
1536
- The new basis tree of the master.
1537
- The old basis tree of the branch.
1538
- The old basis tree of the working tree.
1539
- The current working tree state.
1541
Pathologically, all three may be different, and non-ancestors of each
1542
other. Conceptually we want to:
1544
- Preserve the wt.basis->wt.state changes
1545
- Transform the wt.basis to the new master basis.
1546
- Apply a merge of the old branch basis to get any 'local' changes from
1548
- Restore the wt.basis->wt.state changes.
1550
There isn't a single operation at the moment to do that, so we:
1551
- Merge current state -> basis tree of the master w.r.t. the old tree
1553
- Do a 'normal' merge of the old branch basis if it is relevant.
1555
if self.branch.get_master_branch() is not None:
1557
update_branch = True
1559
self.lock_tree_write()
1560
update_branch = False
1563
old_tip = self.branch.update()
1566
return self._update_tree(old_tip)
1570
@needs_tree_write_lock
1571
def _update_tree(self, old_tip=None):
1572
"""Update a tree to the master branch.
1574
:param old_tip: if supplied, the previous tip revision the branch,
1575
before it was changed to the master branch's tip.
1577
# here if old_tip is not None, it is the old tip of the branch before
1578
# it was updated from the master branch. This should become a pending
1579
# merge in the working tree to preserve the user existing work. we
1580
# cant set that until we update the working trees last revision to be
1581
# one from the new branch, because it will just get absorbed by the
1582
# parent de-duplication logic.
1584
# We MUST save it even if an error occurs, because otherwise the users
1585
# local work is unreferenced and will appear to have been lost.
1589
last_rev = self.get_parent_ids()[0]
1592
if last_rev != self.branch.last_revision():
1593
# merge tree state up to new branch tip.
1594
basis = self.basis_tree()
1595
to_tree = self.branch.basis_tree()
1596
if basis.inventory.root is None:
1597
self.set_root_id(to_tree.inventory.root.file_id)
1598
result += merge.merge_inner(
1603
# TODO - dedup parents list with things merged by pull ?
1604
# reuse the tree we've updated to to set the basis:
1605
parent_trees = [(self.branch.last_revision(), to_tree)]
1606
merges = self.get_parent_ids()[1:]
1607
# Ideally we ask the tree for the trees here, that way the working
1608
# tree can decide whether to give us teh entire tree or give us a
1609
# lazy initialised tree. dirstate for instance will have the trees
1610
# in ram already, whereas a last-revision + basis-inventory tree
1611
# will not, but also does not need them when setting parents.
1612
for parent in merges:
1613
parent_trees.append(
1614
(parent, self.branch.repository.revision_tree(parent)))
1615
if old_tip is not None:
1616
parent_trees.append(
1617
(old_tip, self.branch.repository.revision_tree(old_tip)))
1618
self.set_parent_trees(parent_trees)
1619
last_rev = parent_trees[0][0]
1621
# the working tree had the same last-revision as the master
1622
# branch did. We may still have pivot local work from the local
1623
# branch into old_tip:
1624
if old_tip is not None:
1625
self.add_parent_tree_id(old_tip)
1626
if old_tip and old_tip != last_rev:
1627
# our last revision was not the prior branch last revision
1628
# and we have converted that last revision to a pending merge.
1629
# base is somewhere between the branch tip now
1630
# and the now pending merge
1631
from bzrlib.revision import common_ancestor
1633
base_rev_id = common_ancestor(self.branch.last_revision(),
1635
self.branch.repository)
1636
except errors.NoCommonAncestor:
1638
base_tree = self.branch.repository.revision_tree(base_rev_id)
1639
other_tree = self.branch.repository.revision_tree(old_tip)
1640
result += merge.merge_inner(
1647
@needs_tree_write_lock
1648
def _write_inventory(self, inv):
1649
"""Write inventory as the current inventory."""
1650
self._set_inventory(inv, dirty=True)
1653
def set_conflicts(self, arg):
1654
raise UnsupportedOperation(self.set_conflicts, self)
1656
def add_conflicts(self, arg):
1657
raise UnsupportedOperation(self.add_conflicts, self)
1660
def conflicts(self):
1661
conflicts = _mod_conflicts.ConflictList()
1662
for conflicted in self._iter_conflicts():
1665
if file_kind(self.abspath(conflicted)) != "file":
1667
except errors.NoSuchFile:
1670
for suffix in ('.THIS', '.OTHER'):
1672
kind = file_kind(self.abspath(conflicted+suffix))
1675
except errors.NoSuchFile:
1679
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1680
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1682
file_id=self.path2id(conflicted)))
1686
class WorkingTree2(WorkingTree):
1687
"""This is the Format 2 working tree.
1689
This was the first weave based working tree.
1690
- uses os locks for locking.
1691
- uses the branch last-revision.
1694
def lock_tree_write(self):
1695
"""See WorkingTree.lock_tree_write().
1697
In Format2 WorkingTrees we have a single lock for the branch and tree
1698
so lock_tree_write() degrades to lock_write().
1700
self.branch.lock_write()
1702
return self._control_files.lock_write()
1704
self.branch.unlock()
1708
# we share control files:
1709
if self._control_files._lock_count == 3:
1710
# _inventory_is_modified is always False during a read lock.
1711
if self._inventory_is_modified:
1713
if self._hashcache.needs_write:
1714
self._hashcache.write()
1715
# reverse order of locking.
1717
return self._control_files.unlock()
1719
self.branch.unlock()
1722
class WorkingTree3(WorkingTree):
1723
"""This is the Format 3 working tree.
1725
This differs from the base WorkingTree by:
1726
- having its own file lock
1727
- having its own last-revision property.
1729
This is new in bzr 0.8
1733
def _last_revision(self):
1734
"""See Mutable.last_revision."""
1736
return self._control_files.get_utf8('last-revision').read()
1740
def _change_last_revision(self, revision_id):
1741
"""See WorkingTree._change_last_revision."""
1742
if revision_id is None or revision_id == NULL_REVISION:
1744
self._control_files._transport.delete('last-revision')
1745
except errors.NoSuchFile:
1749
self._control_files.put_utf8('last-revision', revision_id)
1752
@needs_tree_write_lock
1753
def set_conflicts(self, conflicts):
1754
self._put_rio('conflicts', conflicts.to_stanzas(),
1757
@needs_tree_write_lock
1758
def add_conflicts(self, new_conflicts):
1759
conflict_set = set(self.conflicts())
1760
conflict_set.update(set(list(new_conflicts)))
1761
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1762
key=_mod_conflicts.Conflict.sort_key)))
1765
def conflicts(self):
1767
confile = self._control_files.get('conflicts')
1769
return _mod_conflicts.ConflictList()
1771
if confile.next() != CONFLICT_HEADER_1 + '\n':
1772
raise ConflictFormatError()
1773
except StopIteration:
1774
raise ConflictFormatError()
1775
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1778
if self._control_files._lock_count == 1:
1779
# _inventory_is_modified is always False during a read lock.
1780
if self._inventory_is_modified:
1782
if self._hashcache.needs_write:
1783
self._hashcache.write()
1784
# reverse order of locking.
1786
return self._control_files.unlock()
1788
self.branch.unlock()
1791
def get_conflicted_stem(path):
1792
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1793
if path.endswith(suffix):
1794
return path[:-len(suffix)]
1796
@deprecated_function(zero_eight)
1797
def is_control_file(filename):
1798
"""See WorkingTree.is_control_filename(filename)."""
1799
## FIXME: better check
1800
filename = normpath(filename)
1801
while filename != '':
1802
head, tail = os.path.split(filename)
1803
## mutter('check %r for control file' % ((head, tail),))
1806
if filename == head:
1812
class WorkingTreeFormat(object):
1813
"""An encapsulation of the initialization and open routines for a format.
1815
Formats provide three things:
1816
* An initialization routine,
1820
Formats are placed in an dict by their format string for reference
1821
during workingtree opening. Its not required that these be instances, they
1822
can be classes themselves with class methods - it simply depends on
1823
whether state is needed for a given format or not.
1825
Once a format is deprecated, just deprecate the initialize and open
1826
methods on the format class. Do not deprecate the object, as the
1827
object will be created every time regardless.
1830
_default_format = None
1831
"""The default format used for new trees."""
1834
"""The known formats."""
1837
def find_format(klass, a_bzrdir):
1838
"""Return the format for the working tree object in a_bzrdir."""
1840
transport = a_bzrdir.get_workingtree_transport(None)
1841
format_string = transport.get("format").read()
1842
return klass._formats[format_string]
1844
raise errors.NoWorkingTree(base=transport.base)
1846
raise errors.UnknownFormatError(format=format_string)
1849
def get_default_format(klass):
1850
"""Return the current default format."""
1851
return klass._default_format
1853
def get_format_string(self):
1854
"""Return the ASCII format string that identifies this format."""
1855
raise NotImplementedError(self.get_format_string)
1857
def get_format_description(self):
1858
"""Return the short description for this format."""
1859
raise NotImplementedError(self.get_format_description)
1861
def is_supported(self):
1862
"""Is this format supported?
1864
Supported formats can be initialized and opened.
1865
Unsupported formats may not support initialization or committing or
1866
some other features depending on the reason for not being supported.
1871
def register_format(klass, format):
1872
klass._formats[format.get_format_string()] = format
1875
def set_default_format(klass, format):
1876
klass._default_format = format
1879
def unregister_format(klass, format):
1880
assert klass._formats[format.get_format_string()] is format
1881
del klass._formats[format.get_format_string()]
1885
class WorkingTreeFormat2(WorkingTreeFormat):
1886
"""The second working tree format.
1888
This format modified the hash cache from the format 1 hash cache.
1891
def get_format_description(self):
1892
"""See WorkingTreeFormat.get_format_description()."""
1893
return "Working tree format 2"
1895
def stub_initialize_remote(self, control_files):
1896
"""As a special workaround create critical control files for a remote working tree
1898
This ensures that it can later be updated and dealt with locally,
1899
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1900
no working tree. (See bug #43064).
1904
xml5.serializer_v5.write_inventory(inv, sio)
1906
control_files.put('inventory', sio)
1908
control_files.put_utf8('pending-merges', '')
1911
def initialize(self, a_bzrdir, revision_id=None):
1912
"""See WorkingTreeFormat.initialize()."""
1913
if not isinstance(a_bzrdir.transport, LocalTransport):
1914
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1915
branch = a_bzrdir.open_branch()
1916
if revision_id is not None:
1919
revision_history = branch.revision_history()
1921
position = revision_history.index(revision_id)
1923
raise errors.NoSuchRevision(branch, revision_id)
1924
branch.set_revision_history(revision_history[:position + 1])
1927
revision = branch.last_revision()
1929
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1935
basis_tree = branch.repository.revision_tree(revision)
1936
if basis_tree.inventory.root is not None:
1937
wt.set_root_id(basis_tree.inventory.root.file_id)
1938
# set the parent list and cache the basis tree.
1939
wt.set_parent_trees([(revision, basis_tree)])
1940
transform.build_tree(basis_tree, wt)
1944
super(WorkingTreeFormat2, self).__init__()
1945
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1947
def open(self, a_bzrdir, _found=False):
1948
"""Return the WorkingTree object for a_bzrdir
1950
_found is a private parameter, do not use it. It is used to indicate
1951
if format probing has already been done.
1954
# we are being called directly and must probe.
1955
raise NotImplementedError
1956
if not isinstance(a_bzrdir.transport, LocalTransport):
1957
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1958
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1964
class WorkingTreeFormat3(WorkingTreeFormat):
1965
"""The second working tree format updated to record a format marker.
1968
- exists within a metadir controlling .bzr
1969
- includes an explicit version marker for the workingtree control
1970
files, separate from the BzrDir format
1971
- modifies the hash cache format
1973
- uses a LockDir to guard access for writes.
1976
def get_format_string(self):
1977
"""See WorkingTreeFormat.get_format_string()."""
1978
return "Bazaar-NG Working Tree format 3"
1980
def get_format_description(self):
1981
"""See WorkingTreeFormat.get_format_description()."""
1982
return "Working tree format 3"
1984
_lock_file_name = 'lock'
1985
_lock_class = LockDir
1987
def _open_control_files(self, a_bzrdir):
1988
transport = a_bzrdir.get_workingtree_transport(None)
1989
return LockableFiles(transport, self._lock_file_name,
1992
def initialize(self, a_bzrdir, revision_id=None):
1993
"""See WorkingTreeFormat.initialize().
1995
revision_id allows creating a working tree at a different
1996
revision than the branch is at.
1998
if not isinstance(a_bzrdir.transport, LocalTransport):
1999
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2000
transport = a_bzrdir.get_workingtree_transport(self)
2001
control_files = self._open_control_files(a_bzrdir)
2002
control_files.create_lock()
2003
control_files.lock_write()
2004
control_files.put_utf8('format', self.get_format_string())
2005
branch = a_bzrdir.open_branch()
2006
if revision_id is None:
2007
revision_id = branch.last_revision()
2008
# WorkingTree3 can handle an inventory which has a unique root id.
2009
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2010
# those trees. And because there isn't a format bump inbetween, we
2011
# are maintaining compatibility with older clients.
2012
# inv = Inventory(root_id=gen_root_id())
2014
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2020
_control_files=control_files)
2021
wt.lock_tree_write()
2023
basis_tree = branch.repository.revision_tree(revision_id)
2024
# only set an explicit root id if there is one to set.
2025
if basis_tree.inventory.root is not None:
2026
wt.set_root_id(basis_tree.inventory.root.file_id)
2027
if revision_id == NULL_REVISION:
2028
wt.set_parent_trees([])
2030
wt.set_parent_trees([(revision_id, basis_tree)])
2031
transform.build_tree(basis_tree, wt)
2033
# Unlock in this order so that the unlock-triggers-flush in
2034
# WorkingTree is given a chance to fire.
2035
control_files.unlock()
2040
super(WorkingTreeFormat3, self).__init__()
2041
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2043
def open(self, a_bzrdir, _found=False):
2044
"""Return the WorkingTree object for a_bzrdir
2046
_found is a private parameter, do not use it. It is used to indicate
2047
if format probing has already been done.
2050
# we are being called directly and must probe.
2051
raise NotImplementedError
2052
if not isinstance(a_bzrdir.transport, LocalTransport):
2053
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2054
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2056
def _open(self, a_bzrdir, control_files):
2057
"""Open the tree itself.
2059
:param a_bzrdir: the dir for the tree.
2060
:param control_files: the control files for the tree.
2062
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2066
_control_files=control_files)
2069
return self.get_format_string()
2072
# formats which have no format string are not discoverable
2073
# and not independently creatable, so are not registered.
2074
__default_format = WorkingTreeFormat3()
2075
WorkingTreeFormat.register_format(__default_format)
2076
WorkingTreeFormat.set_default_format(__default_format)
2077
_legacy_formats = [WorkingTreeFormat2(),
2081
class WorkingTreeTestProviderAdapter(object):
2082
"""A tool to generate a suite testing multiple workingtree formats at once.
2084
This is done by copying the test once for each transport and injecting
2085
the transport_server, transport_readonly_server, and workingtree_format
2086
classes into each copy. Each copy is also given a new id() to make it
2090
def __init__(self, transport_server, transport_readonly_server, formats):
2091
self._transport_server = transport_server
2092
self._transport_readonly_server = transport_readonly_server
2093
self._formats = formats
2095
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2096
"""Clone test for adaption."""
2097
new_test = deepcopy(test)
2098
new_test.transport_server = self._transport_server
2099
new_test.transport_readonly_server = self._transport_readonly_server
2100
new_test.bzrdir_format = bzrdir_format
2101
new_test.workingtree_format = workingtree_format
2102
def make_new_test_id():
2103
new_id = "%s(%s)" % (test.id(), variation)
2104
return lambda: new_id
2105
new_test.id = make_new_test_id()
2108
def adapt(self, test):
2109
from bzrlib.tests import TestSuite
2110
result = TestSuite()
2111
for workingtree_format, bzrdir_format in self._formats:
2112
new_test = self._clone_test(
2115
workingtree_format, workingtree_format.__class__.__name__)
2116
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
