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
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
import bzrlib.mutabletree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
import bzrlib.revisiontree
95
from bzrlib.rio import RioReader, rio_file, Stanza
96
from bzrlib.symbol_versioning import (deprecated_passed,
102
from bzrlib.trace import mutter, note
103
from bzrlib.transform import build_tree
104
from bzrlib.transport import get_transport
105
from bzrlib.transport.local import LocalTransport
106
from bzrlib.textui import show_status
111
# the regex removes any weird characters; we don't escape them
112
# but rather just pull them out
113
_gen_file_id_re = re.compile(r'[^\w.]')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# The real randomness is in the _next_id_suffix, the
142
# rest of the identifier is just to be nice.
144
# 1) Remove non-ascii word characters to keep the ids portable
145
# 2) squash to lowercase, so the file id doesn't have to
146
# be escaped (case insensitive filesystems would bork for ids
147
# that only differred in case without escaping).
148
# 3) truncate the filename to 20 chars. Long filenames also bork on some
150
# 4) Removing starting '.' characters to prevent the file ids from
151
# being considered hidden.
152
ascii_word_only = _gen_file_id_re.sub('', name.lower())
153
short_no_dots = ascii_word_only.lstrip('.')[:20]
154
return short_no_dots + _next_id_suffix()
158
"""Return a new tree-root file id."""
159
return gen_file_id('TREE_ROOT')
162
class TreeEntry(object):
163
"""An entry that implements the minimum interface used by commands.
165
This needs further inspection, it may be better to have
166
InventoryEntries without ids - though that seems wrong. For now,
167
this is a parallel hierarchy to InventoryEntry, and needs to become
168
one of several things: decorates to that hierarchy, children of, or
170
Another note is that these objects are currently only used when there is
171
no InventoryEntry available - i.e. for unversioned objects.
172
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
175
def __eq__(self, other):
176
# yes, this us ugly, TODO: best practice __eq__ style.
177
return (isinstance(other, TreeEntry)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeDirectory(TreeEntry):
185
"""See TreeEntry. This is a directory in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeDirectory)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeFile(TreeEntry):
196
"""See TreeEntry. This is a regular file in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeFile)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class TreeLink(TreeEntry):
207
"""See TreeEntry. This is a symlink in a working tree."""
209
def __eq__(self, other):
210
return (isinstance(other, TreeLink)
211
and other.__class__ == self.__class__)
213
def kind_character(self):
217
class WorkingTree(bzrlib.mutabletree.MutableTree):
218
"""Working copy tree.
220
The inventory is held in the `Branch` working-inventory, and the
221
files are in a directory on disk.
223
It is possible for a `WorkingTree` to have a filename which is
224
not listed in the Inventory and vice versa.
227
def __init__(self, basedir='.',
228
branch=DEPRECATED_PARAMETER,
234
"""Construct a WorkingTree for basedir.
236
If the branch is not supplied, it is opened automatically.
237
If the branch is supplied, it must be the branch for this basedir.
238
(branch.base is not cross checked, because for remote branches that
239
would be meaningless).
241
self._format = _format
242
self.bzrdir = _bzrdir
244
# not created via open etc.
245
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
246
"Please use bzrdir.open_workingtree or WorkingTree.open().",
249
wt = WorkingTree.open(basedir)
250
self._branch = wt.branch
251
self.basedir = wt.basedir
252
self._control_files = wt._control_files
253
self._hashcache = wt._hashcache
254
self._set_inventory(wt._inventory)
255
self._format = wt._format
256
self.bzrdir = wt.bzrdir
257
from bzrlib.hashcache import HashCache
258
from bzrlib.trace import note, mutter
259
assert isinstance(basedir, basestring), \
260
"base directory %r is not a string" % basedir
261
basedir = safe_unicode(basedir)
262
mutter("opening working tree %r", basedir)
263
if deprecated_passed(branch):
265
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
266
" Please use bzrdir.open_workingtree() or"
267
" WorkingTree.open().",
271
self._branch = branch
273
self._branch = self.bzrdir.open_branch()
274
self.basedir = realpath(basedir)
275
# if branch is at our basedir and is a format 6 or less
276
if isinstance(self._format, WorkingTreeFormat2):
277
# share control object
278
self._control_files = self.branch.control_files
280
# assume all other formats have their own control files.
281
assert isinstance(_control_files, LockableFiles), \
282
"_control_files must be a LockableFiles, not %r" \
284
self._control_files = _control_files
285
# update the whole cache up front and write to disk if anything changed;
286
# in the future we might want to do this more selectively
287
# two possible ways offer themselves : in self._unlock, write the cache
288
# if needed, or, when the cache sees a change, append it to the hash
289
# cache file, and have the parser take the most recent entry for a
291
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
292
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
294
# is this scan needed ? it makes things kinda slow.
301
if _inventory is None:
302
self._set_inventory(self.read_working_inventory())
304
self._set_inventory(_inventory)
307
fget=lambda self: self._branch,
308
doc="""The branch this WorkingTree is connected to.
310
This cannot be set - it is reflective of the actual disk structure
311
the working tree has been constructed from.
314
def break_lock(self):
315
"""Break a lock if one is present from another instance.
317
Uses the ui factory to ask for confirmation if the lock may be from
320
This will probe the repository for its lock as well.
322
self._control_files.break_lock()
323
self.branch.break_lock()
325
def _set_inventory(self, inv):
326
assert inv.root is not None
327
self._inventory = inv
330
def open(path=None, _unsupported=False):
331
"""Open an existing working tree at path.
335
path = os.path.getcwdu()
336
control = bzrdir.BzrDir.open(path, _unsupported)
337
return control.open_workingtree(_unsupported)
340
def open_containing(path=None):
341
"""Open an existing working tree which has its root about path.
343
This probes for a working tree at path and searches upwards from there.
345
Basically we keep looking up until we find the control directory or
346
run into /. If there isn't one, raises NotBranchError.
347
TODO: give this a new exception.
348
If there is one, it is returned, along with the unused portion of path.
350
:return: The WorkingTree that contains 'path', and the rest of path
353
path = osutils.getcwd()
354
control, relpath = bzrdir.BzrDir.open_containing(path)
356
return control.open_workingtree(), relpath
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
367
"""Iterate through file_ids for this tree.
369
file_ids are in a WorkingTree if they are in the working inventory
370
and the working file exists.
372
inv = self._inventory
373
for path, ie in inv.iter_entries():
374
if osutils.lexists(self.abspath(path)):
378
return "<%s of %s>" % (self.__class__.__name__,
379
getattr(self, 'basedir', None))
381
def abspath(self, filename):
382
return pathjoin(self.basedir, filename)
384
def basis_tree(self):
385
"""Return RevisionTree for the current last revision.
387
If the left most parent is a ghost then the returned tree will be an
388
empty tree - one obtained by calling repository.revision_tree(None).
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
395
inv.root.revision = revision_id
398
if inv is not None and inv.revision_id == revision_id:
399
return bzrlib.revisiontree.RevisionTree(self.branch.repository,
401
# FIXME? RBC 20060403 should we cache the inventory here ?
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 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'))
491
def get_root_id(self):
492
"""Return the id of this trees root"""
493
inv = self.read_working_inventory()
494
return inv.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
if revision_id is None:
527
transform_tree(tree, self)
529
# TODO now merge from tree.last_revision to revision (to preserve
530
# user local changes)
531
transform_tree(tree, self)
532
tree.set_parent_ids([revision_id])
534
def id2abspath(self, file_id):
535
return self.abspath(self.id2path(file_id))
537
def has_id(self, file_id):
538
# files that have been deleted are excluded
539
inv = self._inventory
540
if not inv.has_id(file_id):
542
path = inv.id2path(file_id)
543
return osutils.lexists(self.abspath(path))
545
def has_or_had_id(self, file_id):
546
if file_id == self.inventory.root.file_id:
548
return self.inventory.has_id(file_id)
550
__contains__ = has_id
552
def get_file_size(self, file_id):
553
return os.path.getsize(self.id2abspath(file_id))
556
def get_file_sha1(self, file_id, path=None):
558
path = self._inventory.id2path(file_id)
559
return self._hashcache.get_sha1(path)
561
def get_file_mtime(self, file_id, path=None):
563
path = self._inventory.id2path(file_id)
564
return os.lstat(self.abspath(path)).st_mtime
566
if not supports_executable():
567
def is_executable(self, file_id, path=None):
568
return self._inventory[file_id].executable
570
def is_executable(self, file_id, path=None):
572
path = self._inventory.id2path(file_id)
573
mode = os.lstat(self.abspath(path)).st_mode
574
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
577
def _add(self, files, ids, kinds):
578
"""See MutableTree._add."""
579
# TODO: Re-adding a file that is removed in the working copy
580
# should probably put it back with the previous ID.
581
# the read and write working inventory should not occur in this
582
# function - they should be part of lock_write and unlock.
583
inv = self.read_working_inventory()
584
for f, file_id, kind in zip(files, ids, kinds):
585
assert kind is not None
587
inv.add_path(f, kind=kind)
589
inv.add_path(f, kind=kind, file_id=file_id)
590
self._write_inventory(inv)
592
def _gather_kinds(self, files, kinds):
593
"""See MutableTree._gather_kinds."""
594
for pos, f in enumerate(files):
595
if kinds[pos] is None:
596
fullpath = normpath(self.abspath(f))
598
kinds[pos] = file_kind(fullpath)
600
if e.errno == errno.ENOENT:
601
raise NoSuchFile(fullpath)
604
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
605
"""Add revision_id as a parent.
607
This is equivalent to retrieving the current list of parent ids
608
and setting the list to its value plus revision_id.
610
:param revision_id: The revision id to add to the parent list. It may
611
be a ghost revision as long as its not the first parent to be added,
612
or the allow_leftmost_as_ghost parameter is set True.
613
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
615
parents = self.get_parent_ids() + [revision_id]
616
self.set_parent_ids(parents,
617
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
620
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
621
"""Add revision_id, tree tuple as a parent.
623
This is equivalent to retrieving the current list of parent trees
624
and setting the list to its value plus parent_tuple. See also
625
add_parent_tree_id - if you only have a parent id available it will be
626
simpler to use that api. If you have the parent already available, using
627
this api is preferred.
629
:param parent_tuple: The (revision id, tree) to add to the parent list.
630
If the revision_id is a ghost, pass None for the tree.
631
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
633
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
634
if len(parent_ids) > 1:
635
# the leftmost may have already been a ghost, preserve that if it
637
allow_leftmost_as_ghost = True
638
self.set_parent_ids(parent_ids,
639
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
642
def add_pending_merge(self, *revision_ids):
643
# TODO: Perhaps should check at this point that the
644
# history of the revision is actually present?
645
parents = self.get_parent_ids()
647
for rev_id in revision_ids:
648
if rev_id in parents:
650
parents.append(rev_id)
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
656
def pending_merges(self):
657
"""Return a list of pending merges.
659
These are revisions that have been merged into the working
660
directory but not yet committed.
662
return self.get_parent_ids()[1:]
665
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
666
"""Set the parent ids to revision_ids.
668
See also set_parent_trees. This api will try to retrieve the tree data
669
for each element of revision_ids from the trees repository. If you have
670
tree data already available, it is more efficient to use
671
set_parent_trees rather than set_parent_ids. set_parent_ids is however
672
an easier API to use.
674
:param revision_ids: The revision_ids to set as the parent ids of this
675
working tree. Any of these may be ghosts.
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)
682
self.set_last_revision(leftmost_id)
684
self.set_last_revision(None)
685
merges = revision_ids[1:]
686
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
689
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
690
"""See MutableTree.set_parent_trees."""
691
# parent trees are not used in current format trees, delegate to
693
self.set_parent_ids([rev for (rev, tree) in parents_list],
694
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
697
def set_pending_merges(self, rev_list):
698
parents = self.get_parent_ids()
699
leftmost = parents[:1]
700
new_parents = leftmost + rev_list
701
self.set_parent_ids(new_parents)
704
def set_merge_modified(self, modified_hashes):
706
for file_id, hash in modified_hashes.iteritems():
707
yield Stanza(file_id=file_id, hash=hash)
708
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
711
def _put_rio(self, filename, stanzas, header):
712
my_file = rio_file(stanzas, header)
713
self._control_files.put(filename, my_file)
716
def merge_from_branch(self, branch, to_revision=None):
717
"""Merge from a branch into this working tree.
719
:param branch: The branch to merge from.
720
:param to_revision: If non-None, the merge will merge to to_revision, but
721
not beyond it. to_revision does not need to be in the history of
722
the branch when it is supplied. If None, to_revision defaults to
723
branch.last_revision().
725
from bzrlib.merge import Merger, Merge3Merger
726
pb = bzrlib.ui.ui_factory.nested_progress_bar()
728
merger = Merger(self.branch, this_tree=self, pb=pb)
729
merger.pp = ProgressPhase("Merge phase", 5, pb)
730
merger.pp.next_phase()
731
# check that there are no
733
merger.check_basis(check_clean=True, require_commits=False)
734
if to_revision is None:
735
to_revision = branch.last_revision()
736
merger.other_rev_id = to_revision
737
if merger.other_rev_id is None:
738
raise error.NoCommits(branch)
739
self.branch.fetch(branch, last_revision=merger.other_rev_id)
740
merger.other_basis = merger.other_rev_id
741
merger.other_tree = self.branch.repository.revision_tree(
743
merger.pp.next_phase()
745
if merger.base_rev_id == merger.other_rev_id:
746
raise errors.PointlessMerge
747
merger.backup_files = False
748
merger.merge_type = Merge3Merger
749
merger.set_interesting_files(None)
750
merger.show_base = False
751
merger.reprocess = False
752
conflicts = merger.do_merge()
759
def merge_modified(self):
761
hashfile = self._control_files.get('merge-hashes')
766
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
767
raise MergeModifiedFormatError()
768
except StopIteration:
769
raise MergeModifiedFormatError()
770
for s in RioReader(hashfile):
771
file_id = s.get("file_id")
772
if file_id not in self.inventory:
775
if hash == self.get_file_sha1(file_id):
776
merge_hashes[file_id] = hash
780
def mkdir(self, path, file_id=None):
781
"""See MutableTree.mkdir()."""
783
file_id = gen_file_id(os.path.basename(path))
784
os.mkdir(self.abspath(path))
785
self.add(path, file_id, 'directory')
788
def get_symlink_target(self, file_id):
789
return os.readlink(self.id2abspath(file_id))
791
def file_class(self, filename):
792
if self.path2id(filename):
794
elif self.is_ignored(filename):
799
def list_files(self):
800
"""Recursively list all files as (path, class, kind, id, entry).
802
Lists, but does not descend into unversioned directories.
804
This does not include files that have been deleted in this
807
Skips the control directory.
809
inv = self._inventory
810
# Convert these into local objects to save lookup times
811
pathjoin = osutils.pathjoin
812
file_kind = osutils.file_kind
814
# transport.base ends in a slash, we want the piece
815
# between the last two slashes
816
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
818
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
820
# directory file_id, relative path, absolute path, reverse sorted children
821
children = os.listdir(self.basedir)
823
# jam 20060527 The kernel sized tree seems equivalent whether we
824
# use a deque and popleft to keep them sorted, or if we use a plain
825
# list and just reverse() them.
826
children = collections.deque(children)
827
stack = [(inv.root.file_id, u'', self.basedir, children)]
829
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
832
f = children.popleft()
833
## TODO: If we find a subdirectory with its own .bzr
834
## directory, then that is a separate tree and we
835
## should exclude it.
837
# the bzrdir for this tree
838
if transport_base_dir == f:
841
# we know that from_dir_relpath and from_dir_abspath never end in a slash
842
# and 'f' doesn't begin with one, we can do a string op, rather
843
# than the checks of pathjoin(), all relative paths will have an extra slash
845
fp = from_dir_relpath + '/' + f
848
fap = from_dir_abspath + '/' + f
850
f_ie = inv.get_child(from_dir_id, f)
853
elif self.is_ignored(fp[1:]):
856
# we may not have found this file, because of a unicode issue
857
f_norm, can_access = osutils.normalized_filename(f)
858
if f == f_norm or not can_access:
859
# No change, so treat this file normally
862
# this file can be accessed by a normalized path
863
# check again if it is versioned
864
# these lines are repeated here for performance
866
fp = from_dir_relpath + '/' + f
867
fap = from_dir_abspath + '/' + f
868
f_ie = inv.get_child(from_dir_id, f)
871
elif self.is_ignored(fp[1:]):
880
raise BzrCheckError("file %r entered as kind %r id %r, "
882
% (fap, f_ie.kind, f_ie.file_id, fk))
884
# make a last minute entry
886
yield fp[1:], c, fk, f_ie.file_id, f_ie
889
yield fp[1:], c, fk, None, fk_entries[fk]()
891
yield fp[1:], c, fk, None, TreeEntry()
894
if fk != 'directory':
897
# But do this child first
898
new_children = os.listdir(fap)
900
new_children = collections.deque(new_children)
901
stack.append((f_ie.file_id, fp, fap, new_children))
902
# Break out of inner loop, so that we start outer loop with child
905
# if we finished all children, pop it off the stack
910
def move(self, from_paths, to_name):
913
to_name must exist in the inventory.
915
If to_name exists and is a directory, the files are moved into
916
it, keeping their old names.
918
Note that to_name is only the last component of the new name;
919
this doesn't change the directory.
921
This returns a list of (from_path, to_path) pairs for each
925
## TODO: Option to move IDs only
926
assert not isinstance(from_paths, basestring)
928
to_abs = self.abspath(to_name)
929
if not isdir(to_abs):
930
raise BzrError("destination %r is not a directory" % to_abs)
931
if not self.has_filename(to_name):
932
raise BzrError("destination %r not in working directory" % to_abs)
933
to_dir_id = inv.path2id(to_name)
934
if to_dir_id == None and to_name != '':
935
raise BzrError("destination %r is not a versioned directory" % to_name)
936
to_dir_ie = inv[to_dir_id]
937
if to_dir_ie.kind != 'directory':
938
raise BzrError("destination %r is not a directory" % to_abs)
940
to_idpath = inv.get_idpath(to_dir_id)
943
if not self.has_filename(f):
944
raise BzrError("%r does not exist in working tree" % f)
945
f_id = inv.path2id(f)
947
raise BzrError("%r is not versioned" % f)
948
name_tail = splitpath(f)[-1]
949
dest_path = pathjoin(to_name, name_tail)
950
if self.has_filename(dest_path):
951
raise BzrError("destination %r already exists" % dest_path)
952
if f_id in to_idpath:
953
raise BzrError("can't move %r to a subdirectory of itself" % f)
955
# OK, so there's a race here, it's possible that someone will
956
# create a file in this interval and then the rename might be
957
# left half-done. But we should have caught most problems.
958
orig_inv = deepcopy(self.inventory)
961
name_tail = splitpath(f)[-1]
962
dest_path = pathjoin(to_name, name_tail)
963
result.append((f, dest_path))
964
inv.rename(inv.path2id(f), to_dir_id, name_tail)
966
rename(self.abspath(f), self.abspath(dest_path))
968
raise BzrError("failed to rename %r to %r: %s" %
969
(f, dest_path, e[1]),
970
["rename rolled back"])
972
# restore the inventory on error
973
self._set_inventory(orig_inv)
975
self._write_inventory(inv)
979
def rename_one(self, from_rel, to_rel):
982
This can change the directory or the filename or both.
985
if not self.has_filename(from_rel):
986
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
987
if self.has_filename(to_rel):
988
raise BzrError("can't rename: new working file %r already exists" % to_rel)
990
file_id = inv.path2id(from_rel)
992
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
995
from_parent = entry.parent_id
996
from_name = entry.name
998
if inv.path2id(to_rel):
999
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1001
to_dir, to_tail = os.path.split(to_rel)
1002
to_dir_id = inv.path2id(to_dir)
1003
if to_dir_id == None and to_dir != '':
1004
raise BzrError("can't determine destination directory id for %r" % to_dir)
1006
mutter("rename_one:")
1007
mutter(" file_id {%s}" % file_id)
1008
mutter(" from_rel %r" % from_rel)
1009
mutter(" to_rel %r" % to_rel)
1010
mutter(" to_dir %r" % to_dir)
1011
mutter(" to_dir_id {%s}" % to_dir_id)
1013
inv.rename(file_id, to_dir_id, to_tail)
1015
from_abs = self.abspath(from_rel)
1016
to_abs = self.abspath(to_rel)
1018
rename(from_abs, to_abs)
1020
inv.rename(file_id, from_parent, from_name)
1021
raise BzrError("failed to rename %r to %r: %s"
1022
% (from_abs, to_abs, e[1]),
1023
["rename rolled back"])
1024
self._write_inventory(inv)
1028
"""Return all unknown files.
1030
These are files in the working directory that are not versioned or
1031
control files or ignored.
1033
for subp in self.extras():
1034
if not self.is_ignored(subp):
1037
@deprecated_method(zero_eight)
1038
def iter_conflicts(self):
1039
"""List all files in the tree that have text or content conflicts.
1040
DEPRECATED. Use conflicts instead."""
1041
return self._iter_conflicts()
1043
def _iter_conflicts(self):
1045
for info in self.list_files():
1047
stem = get_conflicted_stem(path)
1050
if stem not in conflicted:
1051
conflicted.add(stem)
1055
def pull(self, source, overwrite=False, stop_revision=None):
1056
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1059
pp = ProgressPhase("Pull phase", 2, top_pb)
1061
old_revision_history = self.branch.revision_history()
1062
basis_tree = self.basis_tree()
1063
count = self.branch.pull(source, overwrite, stop_revision)
1064
new_revision_history = self.branch.revision_history()
1065
if new_revision_history != old_revision_history:
1067
if len(old_revision_history):
1068
other_revision = old_revision_history[-1]
1070
other_revision = None
1071
repository = self.branch.repository
1072
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1074
new_basis_tree = self.branch.basis_tree()
1075
merge_inner(self.branch,
1082
# TODO - dedup parents list with things merged by pull ?
1083
# reuse the revisiontree we merged against to set the new
1085
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1086
# we have to pull the merge trees out again, because
1087
# merge_inner has set the ids. - this corner is not yet
1088
# layered well enough to prevent double handling.
1089
merges = self.get_parent_ids()[1:]
1090
parent_trees.extend([
1091
(parent, repository.revision_tree(parent)) for
1093
self.set_parent_trees(parent_trees)
1100
def put_file_bytes_non_atomic(self, file_id, bytes):
1101
"""See MutableTree.put_file_bytes_non_atomic."""
1102
stream = file(self.id2abspath(file_id), 'wb')
1107
# TODO: update the hashcache here ?
1110
"""Yield all unknown files in this WorkingTree.
1112
If there are any unknown directories then only the directory is
1113
returned, not all its children. But if there are unknown files
1114
under a versioned subdirectory, they are returned.
1116
Currently returned depth-first, sorted by name within directories.
1118
## TODO: Work from given directory downwards
1119
for path, dir_entry in self.inventory.directories():
1120
# mutter("search for unknowns in %r", path)
1121
dirabs = self.abspath(path)
1122
if not isdir(dirabs):
1123
# e.g. directory deleted
1127
for subf in os.listdir(dirabs):
1130
if subf not in dir_entry.children:
1131
subf_norm, can_access = osutils.normalized_filename(subf)
1132
if subf_norm != subf and can_access:
1133
if subf_norm not in dir_entry.children:
1134
fl.append(subf_norm)
1140
subp = pathjoin(path, subf)
1143
def _translate_ignore_rule(self, rule):
1144
"""Translate a single ignore rule to a regex.
1146
There are two types of ignore rules. Those that do not contain a / are
1147
matched against the tail of the filename (that is, they do not care
1148
what directory the file is in.) Rules which do contain a slash must
1149
match the entire path. As a special case, './' at the start of the
1150
string counts as a slash in the string but is removed before matching
1151
(e.g. ./foo.c, ./src/foo.c)
1153
:return: The translated regex.
1155
if rule[:2] in ('./', '.\\'):
1157
result = fnmatch.translate(rule[2:])
1158
elif '/' in rule or '\\' in rule:
1160
result = fnmatch.translate(rule)
1162
# default rule style.
1163
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1164
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1165
return "(" + result + ")"
1167
def _combine_ignore_rules(self, rules):
1168
"""Combine a list of ignore rules into a single regex object.
1170
Each individual rule is combined with | to form a big regex, which then
1171
has $ added to it to form something like ()|()|()$. The group index for
1172
each subregex's outermost group is placed in a dictionary mapping back
1173
to the rule. This allows quick identification of the matching rule that
1175
:return: a list of the compiled regex and the matching-group index
1176
dictionaries. We return a list because python complains if you try to
1177
combine more than 100 regexes.
1182
translated_rules = []
1184
translated_rule = self._translate_ignore_rule(rule)
1185
compiled_rule = re.compile(translated_rule)
1186
groups[next_group] = rule
1187
next_group += compiled_rule.groups
1188
translated_rules.append(translated_rule)
1189
if next_group == 99:
1190
result.append((re.compile("|".join(translated_rules)), groups))
1193
translated_rules = []
1194
if len(translated_rules):
1195
result.append((re.compile("|".join(translated_rules)), groups))
1198
def ignored_files(self):
1199
"""Yield list of PATH, IGNORE_PATTERN"""
1200
for subp in self.extras():
1201
pat = self.is_ignored(subp)
1205
def get_ignore_list(self):
1206
"""Return list of ignore patterns.
1208
Cached in the Tree object after the first call.
1210
ignoreset = getattr(self, '_ignoreset', None)
1211
if ignoreset is not None:
1214
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1215
ignore_globs.update(ignores.get_runtime_ignores())
1217
ignore_globs.update(ignores.get_user_ignores())
1219
if self.has_filename(bzrlib.IGNORE_FILENAME):
1220
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1222
ignore_globs.update(ignores.parse_ignore_file(f))
1226
self._ignoreset = ignore_globs
1227
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1230
def _get_ignore_rules_as_regex(self):
1231
"""Return a regex of the ignore rules and a mapping dict.
1233
:return: (ignore rules compiled regex, dictionary mapping rule group
1234
indices to original rule.)
1236
if getattr(self, '_ignoreset', None) is None:
1237
self.get_ignore_list()
1238
return self._ignore_regex
1240
def is_ignored(self, filename):
1241
r"""Check whether the filename matches an ignore pattern.
1243
Patterns containing '/' or '\' need to match the whole path;
1244
others match against only the last component.
1246
If the file is ignored, returns the pattern which caused it to
1247
be ignored, otherwise None. So this can simply be used as a
1248
boolean if desired."""
1250
# TODO: Use '**' to match directories, and other extended
1251
# globbing stuff from cvs/rsync.
1253
# XXX: fnmatch is actually not quite what we want: it's only
1254
# approximately the same as real Unix fnmatch, and doesn't
1255
# treat dotfiles correctly and allows * to match /.
1256
# Eventually it should be replaced with something more
1259
rules = self._get_ignore_rules_as_regex()
1260
for regex, mapping in rules:
1261
match = regex.match(filename)
1262
if match is not None:
1263
# one or more of the groups in mapping will have a non-None
1265
groups = match.groups()
1266
rules = [mapping[group] for group in
1267
mapping if groups[group] is not None]
1271
def kind(self, file_id):
1272
return file_kind(self.id2abspath(file_id))
1275
def last_revision(self):
1276
"""Return the last revision id of this working tree.
1278
In early branch formats this was == the branch last_revision,
1279
but that cannot be relied upon - for working tree operations,
1280
always use tree.last_revision().
1282
return self.branch.last_revision()
1284
def is_locked(self):
1285
return self._control_files.is_locked()
1287
def lock_read(self):
1288
"""See Branch.lock_read, and WorkingTree.unlock."""
1289
self.branch.lock_read()
1291
return self._control_files.lock_read()
1293
self.branch.unlock()
1296
def lock_write(self):
1297
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1298
self.branch.lock_write()
1300
return self._control_files.lock_write()
1302
self.branch.unlock()
1305
def get_physical_lock_status(self):
1306
return self._control_files.get_physical_lock_status()
1308
def _basis_inventory_name(self):
1309
return 'basis-inventory'
1312
def set_last_revision(self, new_revision):
1313
"""Change the last revision in the working tree."""
1314
if self._change_last_revision(new_revision):
1315
self._cache_basis_inventory(new_revision)
1317
def _change_last_revision(self, new_revision):
1318
"""Template method part of set_last_revision to perform the change.
1320
This is used to allow WorkingTree3 instances to not affect branch
1321
when their last revision is set.
1323
if new_revision is None:
1324
self.branch.set_revision_history([])
1327
self.branch.generate_revision_history(new_revision)
1328
except errors.NoSuchRevision:
1329
# not present in the repo - dont try to set it deeper than the tip
1330
self.branch.set_revision_history([new_revision])
1333
def _cache_basis_inventory(self, new_revision):
1334
"""Cache new_revision as the basis inventory."""
1335
# TODO: this should allow the ready-to-use inventory to be passed in,
1336
# as commit already has that ready-to-use [while the format is the
1339
# this double handles the inventory - unpack and repack -
1340
# but is easier to understand. We can/should put a conditional
1341
# in here based on whether the inventory is in the latest format
1342
# - perhaps we should repack all inventories on a repository
1344
# the fast path is to copy the raw xml from the repository. If the
1345
# xml contains 'revision_id="', then we assume the right
1346
# revision_id is set. We must check for this full string, because a
1347
# root node id can legitimately look like 'revision_id' but cannot
1349
xml = self.branch.repository.get_inventory_xml(new_revision)
1350
if not 'revision_id="' in xml.split('\n', 1)[0]:
1351
inv = self.branch.repository.deserialise_inventory(
1353
inv.revision_id = new_revision
1354
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1355
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1356
path = self._basis_inventory_name()
1358
self._control_files.put(path, sio)
1359
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1362
def read_basis_inventory(self):
1363
"""Read the cached basis inventory."""
1364
path = self._basis_inventory_name()
1365
return self._control_files.get(path).read()
1368
def read_working_inventory(self):
1369
"""Read the working inventory."""
1370
# ElementTree does its own conversion from UTF-8, so open in
1372
result = bzrlib.xml5.serializer_v5.read_inventory(
1373
self._control_files.get('inventory'))
1374
self._set_inventory(result)
1378
def remove(self, files, verbose=False, to_file=None):
1379
"""Remove nominated files from the working inventory..
1381
This does not remove their text. This does not run on XXX on what? RBC
1383
TODO: Refuse to remove modified files unless --force is given?
1385
TODO: Do something useful with directories.
1387
TODO: Should this remove the text or not? Tough call; not
1388
removing may be useful and the user can just use use rm, and
1389
is the opposite of add. Removing it is consistent with most
1390
other tools. Maybe an option.
1392
## TODO: Normalize names
1393
## TODO: Remove nested loops; better scalability
1394
if isinstance(files, basestring):
1397
inv = self.inventory
1399
# do this before any modifications
1401
fid = inv.path2id(f)
1403
# TODO: Perhaps make this just a warning, and continue?
1404
# This tends to happen when
1405
raise NotVersionedError(path=f)
1407
# having remove it, it must be either ignored or unknown
1408
if self.is_ignored(f):
1412
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1415
self._write_inventory(inv)
1418
def revert(self, filenames, old_tree=None, backups=True,
1419
pb=DummyProgress()):
1420
from transform import revert
1421
from conflicts import resolve
1422
if old_tree is None:
1423
old_tree = self.basis_tree()
1424
conflicts = revert(self, old_tree, filenames, backups, pb)
1425
if not len(filenames):
1426
self.set_parent_ids(self.get_parent_ids()[:1])
1429
resolve(self, filenames, ignore_misses=True)
1432
# XXX: This method should be deprecated in favour of taking in a proper
1433
# new Inventory object.
1435
def set_inventory(self, new_inventory_list):
1436
from bzrlib.inventory import (Inventory,
1441
inv = Inventory(self.get_root_id())
1442
for path, file_id, parent, kind in new_inventory_list:
1443
name = os.path.basename(path)
1446
# fixme, there should be a factory function inv,add_??
1447
if kind == 'directory':
1448
inv.add(InventoryDirectory(file_id, name, parent))
1449
elif kind == 'file':
1450
inv.add(InventoryFile(file_id, name, parent))
1451
elif kind == 'symlink':
1452
inv.add(InventoryLink(file_id, name, parent))
1454
raise BzrError("unknown kind %r" % kind)
1455
self._write_inventory(inv)
1458
def set_root_id(self, file_id):
1459
"""Set the root id for this tree."""
1460
inv = self.read_working_inventory()
1461
orig_root_id = inv.root.file_id
1462
del inv._byid[inv.root.file_id]
1463
inv.root.file_id = file_id
1464
inv._byid[inv.root.file_id] = inv.root
1467
if entry.parent_id == orig_root_id:
1468
entry.parent_id = inv.root.file_id
1469
self._write_inventory(inv)
1472
"""See Branch.unlock.
1474
WorkingTree locking just uses the Branch locking facilities.
1475
This is current because all working trees have an embedded branch
1476
within them. IF in the future, we were to make branch data shareable
1477
between multiple working trees, i.e. via shared storage, then we
1478
would probably want to lock both the local tree, and the branch.
1480
raise NotImplementedError(self.unlock)
1484
"""Update a working tree along its branch.
1486
This will update the branch if its bound too, which means we have multiple trees involved:
1487
The new basis tree of the master.
1488
The old basis tree of the branch.
1489
The old basis tree of the working tree.
1490
The current working tree state.
1491
pathologically all three may be different, and non ancestors of each other.
1492
Conceptually we want to:
1493
Preserve the wt.basis->wt.state changes
1494
Transform the wt.basis to the new master basis.
1495
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1496
Restore the wt.basis->wt.state changes.
1498
There isn't a single operation at the moment to do that, so we:
1499
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1500
Do a 'normal' merge of the old branch basis if it is relevant.
1502
old_tip = self.branch.update()
1503
# here if old_tip is not None, it is the old tip of the branch before
1504
# it was updated from the master branch. This should become a pending
1505
# merge in the working tree to preserve the user existing work. we
1506
# cant set that until we update the working trees last revision to be
1507
# one from the new branch, because it will just get absorbed by the
1508
# parent de-duplication logic.
1510
# We MUST save it even if an error occurs, because otherwise the users
1511
# local work is unreferenced and will appear to have been lost.
1514
if self.last_revision() != self.branch.last_revision():
1515
# merge tree state up to new branch tip.
1516
basis = self.basis_tree()
1517
to_tree = self.branch.basis_tree()
1518
result += merge_inner(self.branch,
1522
# TODO - dedup parents list with things merged by pull ?
1523
# reuse the tree we've updated to to set the basis:
1524
parent_trees = [(self.branch.last_revision(), to_tree)]
1525
merges = self.get_parent_ids()[1:]
1526
# Ideally we ask the tree for the trees here, that way the working
1527
# tree can decide whether to give us teh entire tree or give us a
1528
# lazy initialised tree. dirstate for instance will have the trees
1529
# in ram already, whereas a last-revision + basis-inventory tree
1530
# will not, but also does not need them when setting parents.
1531
for parent in merges:
1532
parent_trees.append(
1533
(parent, self.branch.repository.revision_tree(parent)))
1534
if old_tip is not None:
1535
parent_trees.append(
1536
(old_tip, self.branch.repository.revision_tree(old_tip)))
1537
self.set_parent_trees(parent_trees)
1539
# the working tree had the same last-revision as the master
1540
# branch did. We may still have pivot local work from the local
1541
# branch into old_tip:
1542
if old_tip is not None:
1543
self.add_parent_tree_id(old_tip)
1544
if old_tip and old_tip != self.last_revision():
1545
# our last revision was not the prior branch last revision
1546
# and we have converted that last revision to a pending merge.
1547
# base is somewhere between the branch tip now
1548
# and the now pending merge
1549
from bzrlib.revision import common_ancestor
1551
base_rev_id = common_ancestor(self.branch.last_revision(),
1553
self.branch.repository)
1554
except errors.NoCommonAncestor:
1556
base_tree = self.branch.repository.revision_tree(base_rev_id)
1557
other_tree = self.branch.repository.revision_tree(old_tip)
1558
result += merge_inner(self.branch,
1565
def _write_inventory(self, inv):
1566
"""Write inventory as the current inventory."""
1568
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1570
self._control_files.put('inventory', sio)
1571
self._set_inventory(inv)
1572
mutter('wrote working inventory')
1574
def set_conflicts(self, arg):
1575
raise UnsupportedOperation(self.set_conflicts, self)
1577
def add_conflicts(self, arg):
1578
raise UnsupportedOperation(self.add_conflicts, self)
1581
def conflicts(self):
1582
conflicts = ConflictList()
1583
for conflicted in self._iter_conflicts():
1586
if file_kind(self.abspath(conflicted)) != "file":
1588
except errors.NoSuchFile:
1591
for suffix in ('.THIS', '.OTHER'):
1593
kind = file_kind(self.abspath(conflicted+suffix))
1596
except errors.NoSuchFile:
1600
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1601
conflicts.append(Conflict.factory(ctype, path=conflicted,
1602
file_id=self.path2id(conflicted)))
1606
class WorkingTree2(WorkingTree):
1607
"""This is the Format 2 working tree.
1609
This was the first weave based working tree.
1610
- uses os locks for locking.
1611
- uses the branch last-revision.
1615
# we share control files:
1616
if self._hashcache.needs_write and self._control_files._lock_count==3:
1617
self._hashcache.write()
1618
# reverse order of locking.
1620
return self._control_files.unlock()
1622
self.branch.unlock()
1625
class WorkingTree3(WorkingTree):
1626
"""This is the Format 3 working tree.
1628
This differs from the base WorkingTree by:
1629
- having its own file lock
1630
- having its own last-revision property.
1632
This is new in bzr 0.8
1636
def last_revision(self):
1637
"""See WorkingTree.last_revision."""
1639
return self._control_files.get_utf8('last-revision').read()
1643
def _change_last_revision(self, revision_id):
1644
"""See WorkingTree._change_last_revision."""
1645
if revision_id is None or revision_id == NULL_REVISION:
1647
self._control_files._transport.delete('last-revision')
1648
except errors.NoSuchFile:
1652
self._control_files.put_utf8('last-revision', revision_id)
1656
def set_conflicts(self, conflicts):
1657
self._put_rio('conflicts', conflicts.to_stanzas(),
1661
def add_conflicts(self, new_conflicts):
1662
conflict_set = set(self.conflicts())
1663
conflict_set.update(set(list(new_conflicts)))
1664
self.set_conflicts(ConflictList(sorted(conflict_set,
1665
key=Conflict.sort_key)))
1668
def conflicts(self):
1670
confile = self._control_files.get('conflicts')
1672
return ConflictList()
1674
if confile.next() != CONFLICT_HEADER_1 + '\n':
1675
raise ConflictFormatError()
1676
except StopIteration:
1677
raise ConflictFormatError()
1678
return ConflictList.from_stanzas(RioReader(confile))
1681
if self._hashcache.needs_write and self._control_files._lock_count==1:
1682
self._hashcache.write()
1683
# reverse order of locking.
1685
return self._control_files.unlock()
1687
self.branch.unlock()
1690
def get_conflicted_stem(path):
1691
for suffix in CONFLICT_SUFFIXES:
1692
if path.endswith(suffix):
1693
return path[:-len(suffix)]
1695
@deprecated_function(zero_eight)
1696
def is_control_file(filename):
1697
"""See WorkingTree.is_control_filename(filename)."""
1698
## FIXME: better check
1699
filename = normpath(filename)
1700
while filename != '':
1701
head, tail = os.path.split(filename)
1702
## mutter('check %r for control file' % ((head, tail),))
1705
if filename == head:
1711
class WorkingTreeFormat(object):
1712
"""An encapsulation of the initialization and open routines for a format.
1714
Formats provide three things:
1715
* An initialization routine,
1719
Formats are placed in an dict by their format string for reference
1720
during workingtree opening. Its not required that these be instances, they
1721
can be classes themselves with class methods - it simply depends on
1722
whether state is needed for a given format or not.
1724
Once a format is deprecated, just deprecate the initialize and open
1725
methods on the format class. Do not deprecate the object, as the
1726
object will be created every time regardless.
1729
_default_format = None
1730
"""The default format used for new trees."""
1733
"""The known formats."""
1736
def find_format(klass, a_bzrdir):
1737
"""Return the format for the working tree object in a_bzrdir."""
1739
transport = a_bzrdir.get_workingtree_transport(None)
1740
format_string = transport.get("format").read()
1741
return klass._formats[format_string]
1743
raise errors.NoWorkingTree(base=transport.base)
1745
raise errors.UnknownFormatError(format=format_string)
1748
def get_default_format(klass):
1749
"""Return the current default format."""
1750
return klass._default_format
1752
def get_format_string(self):
1753
"""Return the ASCII format string that identifies this format."""
1754
raise NotImplementedError(self.get_format_string)
1756
def get_format_description(self):
1757
"""Return the short description for this format."""
1758
raise NotImplementedError(self.get_format_description)
1760
def is_supported(self):
1761
"""Is this format supported?
1763
Supported formats can be initialized and opened.
1764
Unsupported formats may not support initialization or committing or
1765
some other features depending on the reason for not being supported.
1770
def register_format(klass, format):
1771
klass._formats[format.get_format_string()] = format
1774
def set_default_format(klass, format):
1775
klass._default_format = format
1778
def unregister_format(klass, format):
1779
assert klass._formats[format.get_format_string()] is format
1780
del klass._formats[format.get_format_string()]
1784
class WorkingTreeFormat2(WorkingTreeFormat):
1785
"""The second working tree format.
1787
This format modified the hash cache from the format 1 hash cache.
1790
def get_format_description(self):
1791
"""See WorkingTreeFormat.get_format_description()."""
1792
return "Working tree format 2"
1794
def stub_initialize_remote(self, control_files):
1795
"""As a special workaround create critical control files for a remote working tree
1797
This ensures that it can later be updated and dealt with locally,
1798
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1799
no working tree. (See bug #43064).
1803
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1805
control_files.put('inventory', sio)
1807
control_files.put_utf8('pending-merges', '')
1810
def initialize(self, a_bzrdir, revision_id=None):
1811
"""See WorkingTreeFormat.initialize()."""
1812
if not isinstance(a_bzrdir.transport, LocalTransport):
1813
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1814
branch = a_bzrdir.open_branch()
1815
if revision_id is not None:
1818
revision_history = branch.revision_history()
1820
position = revision_history.index(revision_id)
1822
raise errors.NoSuchRevision(branch, revision_id)
1823
branch.set_revision_history(revision_history[:position + 1])
1826
revision = branch.last_revision()
1828
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1834
wt._write_inventory(inv)
1835
wt.set_root_id(inv.root.file_id)
1836
basis_tree = branch.repository.revision_tree(revision)
1837
wt.set_parent_trees([(revision, basis_tree)])
1838
build_tree(basis_tree, wt)
1842
super(WorkingTreeFormat2, self).__init__()
1843
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1845
def open(self, a_bzrdir, _found=False):
1846
"""Return the WorkingTree object for a_bzrdir
1848
_found is a private parameter, do not use it. It is used to indicate
1849
if format probing has already been done.
1852
# we are being called directly and must probe.
1853
raise NotImplementedError
1854
if not isinstance(a_bzrdir.transport, LocalTransport):
1855
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1856
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1862
class WorkingTreeFormat3(WorkingTreeFormat):
1863
"""The second working tree format updated to record a format marker.
1866
- exists within a metadir controlling .bzr
1867
- includes an explicit version marker for the workingtree control
1868
files, separate from the BzrDir format
1869
- modifies the hash cache format
1871
- uses a LockDir to guard access for writes.
1874
def get_format_string(self):
1875
"""See WorkingTreeFormat.get_format_string()."""
1876
return "Bazaar-NG Working Tree format 3"
1878
def get_format_description(self):
1879
"""See WorkingTreeFormat.get_format_description()."""
1880
return "Working tree format 3"
1882
_lock_file_name = 'lock'
1883
_lock_class = LockDir
1885
def _open_control_files(self, a_bzrdir):
1886
transport = a_bzrdir.get_workingtree_transport(None)
1887
return LockableFiles(transport, self._lock_file_name,
1890
def initialize(self, a_bzrdir, revision_id=None):
1891
"""See WorkingTreeFormat.initialize().
1893
revision_id allows creating a working tree at a different
1894
revision than the branch is at.
1896
if not isinstance(a_bzrdir.transport, LocalTransport):
1897
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1898
transport = a_bzrdir.get_workingtree_transport(self)
1899
control_files = self._open_control_files(a_bzrdir)
1900
control_files.create_lock()
1901
control_files.lock_write()
1902
control_files.put_utf8('format', self.get_format_string())
1903
branch = a_bzrdir.open_branch()
1904
if revision_id is None:
1905
revision_id = branch.last_revision()
1907
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1913
_control_files=control_files)
1916
wt._write_inventory(inv)
1917
wt.set_root_id(inv.root.file_id)
1918
basis_tree = branch.repository.revision_tree(revision_id)
1919
if revision_id == bzrlib.revision.NULL_REVISION:
1920
wt.set_parent_trees([])
1922
wt.set_parent_trees([(revision_id, basis_tree)])
1923
build_tree(basis_tree, wt)
1926
control_files.unlock()
1930
super(WorkingTreeFormat3, self).__init__()
1931
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1933
def open(self, a_bzrdir, _found=False):
1934
"""Return the WorkingTree object for a_bzrdir
1936
_found is a private parameter, do not use it. It is used to indicate
1937
if format probing has already been done.
1940
# we are being called directly and must probe.
1941
raise NotImplementedError
1942
if not isinstance(a_bzrdir.transport, LocalTransport):
1943
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1944
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1946
def _open(self, a_bzrdir, control_files):
1947
"""Open the tree itself.
1949
:param a_bzrdir: the dir for the tree.
1950
:param control_files: the control files for the tree.
1952
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1956
_control_files=control_files)
1959
return self.get_format_string()
1962
# formats which have no format string are not discoverable
1963
# and not independently creatable, so are not registered.
1964
__default_format = WorkingTreeFormat3()
1965
WorkingTreeFormat.register_format(__default_format)
1966
WorkingTreeFormat.set_default_format(__default_format)
1967
_legacy_formats = [WorkingTreeFormat2(),
1971
class WorkingTreeTestProviderAdapter(object):
1972
"""A tool to generate a suite testing multiple workingtree formats at once.
1974
This is done by copying the test once for each transport and injecting
1975
the transport_server, transport_readonly_server, and workingtree_format
1976
classes into each copy. Each copy is also given a new id() to make it
1980
def __init__(self, transport_server, transport_readonly_server, formats):
1981
self._transport_server = transport_server
1982
self._transport_readonly_server = transport_readonly_server
1983
self._formats = formats
1985
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1986
"""Clone test for adaption."""
1987
new_test = deepcopy(test)
1988
new_test.transport_server = self._transport_server
1989
new_test.transport_readonly_server = self._transport_readonly_server
1990
new_test.bzrdir_format = bzrdir_format
1991
new_test.workingtree_format = workingtree_format
1992
def make_new_test_id():
1993
new_id = "%s(%s)" % (test.id(), variation)
1994
return lambda: new_id
1995
new_test.id = make_new_test_id()
1998
def adapt(self, test):
1999
from bzrlib.tests import TestSuite
2000
result = TestSuite()
2001
for workingtree_format, bzrdir_format in self._formats:
2002
new_test = self._clone_test(
2005
workingtree_format, workingtree_format.__class__.__name__)
2006
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
