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
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
216
class WorkingTree(bzrlib.tree.Tree):
217
"""Working copy tree.
219
The inventory is held in the `Branch` working-inventory, and the
220
files are in a directory on disk.
222
It is possible for a `WorkingTree` to have a filename which is
223
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
256
from bzrlib.hashcache import HashCache
257
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
284
# update the whole cache up front and write to disk if anything changed;
285
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
293
# is this scan needed ? it makes things kinda slow.
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
assert inv.root is not None
326
self._inventory = inv
327
self.path2id = self._inventory.path2id
329
def is_control_filename(self, filename):
330
"""True if filename is the name of a control file in this tree.
332
:param filename: A filename within the tree. This is a relative path
333
from the root of this tree.
335
This is true IF and ONLY IF the filename is part of the meta data
336
that bzr controls in this tree. I.E. a random .bzr directory placed
337
on disk will not be a control file for this tree.
339
return self.bzrdir.is_control_filename(filename)
342
def open(path=None, _unsupported=False):
343
"""Open an existing working tree at path.
347
path = os.path.getcwdu()
348
control = bzrdir.BzrDir.open(path, _unsupported)
349
return control.open_workingtree(_unsupported)
352
def open_containing(path=None):
353
"""Open an existing working tree which has its root about path.
355
This probes for a working tree at path and searches upwards from there.
357
Basically we keep looking up until we find the control directory or
358
run into /. If there isn't one, raises NotBranchError.
359
TODO: give this a new exception.
360
If there is one, it is returned, along with the unused portion of path.
362
:return: The WorkingTree that contains 'path', and the rest of path
365
path = osutils.getcwd()
366
control, relpath = bzrdir.BzrDir.open_containing(path)
368
return control.open_workingtree(), relpath
371
def open_downlevel(path=None):
372
"""Open an unsupported working tree.
374
Only intended for advanced situations like upgrading part of a bzrdir.
376
return WorkingTree.open(path, _unsupported=True)
379
"""Iterate through file_ids for this tree.
381
file_ids are in a WorkingTree if they are in the working inventory
382
and the working file exists.
384
inv = self._inventory
385
for path, ie in inv.iter_entries():
386
if osutils.lexists(self.abspath(path)):
390
return "<%s of %s>" % (self.__class__.__name__,
391
getattr(self, 'basedir', None))
393
def abspath(self, filename):
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling repository.revision_tree(None).
402
revision_id = self.last_revision()
403
if revision_id is not None:
405
xml = self.read_basis_inventory()
406
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
407
inv.root.revision = revision_id
410
if inv is not None and inv.revision_id == revision_id:
411
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
413
# FIXME? RBC 20060403 should we cache the inventory here ?
415
return self.branch.repository.revision_tree(revision_id)
416
except errors.RevisionNotPresent:
417
# the basis tree *may* be a ghost or a low level error may have
418
# occured. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(None)
426
@deprecated_method(zero_eight)
427
def create(branch, directory):
428
"""Create a workingtree for branch at directory.
430
If existing_directory already exists it must have a .bzr directory.
431
If it does not exist, it will be created.
433
This returns a new WorkingTree object for the new checkout.
435
TODO FIXME RBC 20060124 when we have checkout formats in place this
436
should accept an optional revisionid to checkout [and reject this if
437
checking out into the same dir as a pre-checkout-aware branch format.]
439
XXX: When BzrDir is present, these should be created through that
442
warnings.warn('delete WorkingTree.create', stacklevel=3)
443
transport = get_transport(directory)
444
if branch.bzrdir.root_transport.base == transport.base:
446
return branch.bzrdir.create_workingtree()
447
# different directory,
448
# create a branch reference
449
# and now a working tree.
450
raise NotImplementedError
453
@deprecated_method(zero_eight)
454
def create_standalone(directory):
455
"""Create a checkout and a branch and a repo at directory.
457
Directory must exist and be empty.
459
please use BzrDir.create_standalone_workingtree
461
return bzrdir.BzrDir.create_standalone_workingtree(directory)
463
def relpath(self, path):
464
"""Return the local path portion from a given path.
466
The path may be absolute or relative. If its a relative path it is
467
interpreted relative to the python current working directory.
469
return relpath(self.basedir, path)
471
def has_filename(self, filename):
472
return osutils.lexists(self.abspath(filename))
474
def get_file(self, file_id):
475
return self.get_file_byname(self.id2path(file_id))
477
def get_file_text(self, file_id):
478
return self.get_file(file_id).read()
480
def get_file_byname(self, filename):
481
return file(self.abspath(filename), 'rb')
483
def get_parent_ids(self):
484
"""See Tree.get_parent_ids.
486
This implementation reads the pending merges list and last_revision
487
value and uses that to decide what the parents list should be.
489
last_rev = self.last_revision()
494
other_parents = self.pending_merges()
495
return parents + other_parents
497
def get_root_id(self):
498
"""Return the id of this trees root"""
499
inv = self.read_working_inventory()
500
return inv.root.file_id
502
def _get_store_filename(self, file_id):
503
## XXX: badly named; this is not in the store at all
504
return self.abspath(self.id2path(file_id))
507
def clone(self, to_bzrdir, revision_id=None, basis=None):
508
"""Duplicate this working tree into to_bzr, including all state.
510
Specifically modified files are kept as modified, but
511
ignored and unknown files are discarded.
513
If you want to make a new line of development, see bzrdir.sprout()
516
If not None, the cloned tree will have its last revision set to
517
revision, and and difference between the source trees last revision
518
and this one merged in.
521
If not None, a closer copy of a tree which may have some files in
522
common, and which file content should be preferentially copied from.
524
# assumes the target bzr dir format is compatible.
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id)
530
def copy_content_into(self, tree, revision_id=None):
531
"""Copy the current content and user files of this tree into tree."""
532
if revision_id is None:
533
transform_tree(tree, self)
535
# TODO now merge from tree.last_revision to revision
536
transform_tree(tree, self)
537
tree.set_last_revision(revision_id)
540
def commit(self, message=None, revprops=None, *args, **kwargs):
541
# avoid circular imports
542
from bzrlib.commit import Commit
545
if not 'branch-nick' in revprops:
546
revprops['branch-nick'] = self.branch.nick
547
# args for wt.commit start at message from the Commit.commit method,
548
# but with branch a kwarg now, passing in args as is results in the
549
#message being used for the branch
550
args = (DEPRECATED_PARAMETER, message, ) + args
551
committed_id = Commit().commit( working_tree=self, revprops=revprops,
553
self._set_inventory(self.read_working_inventory())
556
def id2abspath(self, file_id):
557
return self.abspath(self.id2path(file_id))
559
def has_id(self, file_id):
560
# files that have been deleted are excluded
561
inv = self._inventory
562
if not inv.has_id(file_id):
564
path = inv.id2path(file_id)
565
return osutils.lexists(self.abspath(path))
567
def has_or_had_id(self, file_id):
568
if file_id == self.inventory.root.file_id:
570
return self.inventory.has_id(file_id)
572
__contains__ = has_id
574
def get_file_size(self, file_id):
575
return os.path.getsize(self.id2abspath(file_id))
578
def get_file_sha1(self, file_id, path=None):
580
path = self._inventory.id2path(file_id)
581
return self._hashcache.get_sha1(path)
583
def get_file_mtime(self, file_id, path=None):
585
path = self._inventory.id2path(file_id)
586
return os.lstat(self.abspath(path)).st_mtime
588
if not supports_executable():
589
def is_executable(self, file_id, path=None):
590
return self._inventory[file_id].executable
592
def is_executable(self, file_id, path=None):
594
path = self._inventory.id2path(file_id)
595
mode = os.lstat(self.abspath(path)).st_mode
596
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
599
def add(self, files, ids=None):
600
"""Make files versioned.
602
Note that the command line normally calls smart_add instead,
603
which can automatically recurse.
605
This adds the files to the inventory, so that they will be
606
recorded by the next commit.
609
List of paths to add, relative to the base of the tree.
612
If set, use these instead of automatically generated ids.
613
Must be the same length as the list of files, but may
614
contain None for ids that are to be autogenerated.
616
TODO: Perhaps have an option to add the ids even if the files do
619
TODO: Perhaps callback with the ids and paths as they're added.
621
# TODO: Re-adding a file that is removed in the working copy
622
# should probably put it back with the previous ID.
623
if isinstance(files, basestring):
624
assert(ids is None or isinstance(ids, basestring))
630
ids = [None] * len(files)
632
assert(len(ids) == len(files))
634
inv = self.read_working_inventory()
635
for f,file_id in zip(files, ids):
636
if self.is_control_filename(f):
637
raise errors.ForbiddenControlFileError(filename=f)
642
raise BzrError("cannot add top-level %r" % f)
644
fullpath = normpath(self.abspath(f))
646
kind = file_kind(fullpath)
648
if e.errno == errno.ENOENT:
649
raise NoSuchFile(fullpath)
650
if not InventoryEntry.versionable_kind(kind):
651
raise errors.BadFileKindError(filename=f, kind=kind)
653
inv.add_path(f, kind=kind)
655
inv.add_path(f, kind=kind, file_id=file_id)
657
self._write_inventory(inv)
660
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
661
"""Add revision_id as a parent.
663
This is equivalent to retrieving the current list of parent ids
664
and setting the list to its value plus revision_id.
666
:param revision_id: The revision id to add to the parent list. It may
667
be a ghost revision as long as its not the first parent to be added,
668
or the allow_leftmost_as_ghost parameter is set True.
669
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
671
parents = self.get_parent_ids() + [revision_id]
672
self.set_parent_ids(parents,
673
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
676
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
677
"""Add revision_id, tree tuple as a parent.
679
This is equivalent to retrieving the current list of parent trees
680
and setting the list to its value plus parent_tuple. See also
681
add_parent_tree_id - if you only have a parent id available it will be
682
simpler to use that api. If you have the parent already available, using
683
this api is preferred.
685
:param parent_tuple: The (revision id, tree) to add to the parent list.
686
If the revision_id is a ghost, pass None for the tree.
687
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
689
self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
690
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
693
def add_pending_merge(self, *revision_ids):
694
# TODO: Perhaps should check at this point that the
695
# history of the revision is actually present?
696
p = self.pending_merges()
697
existing_parents = self.get_parent_ids()
699
for rev_id in revision_ids:
702
if rev_id in existing_parents:
707
self.set_pending_merges(p)
710
def pending_merges(self):
711
"""Return a list of pending merges.
713
These are revisions that have been merged into the working
714
directory but not yet committed.
717
merges_file = self._control_files.get_utf8('pending-merges')
721
for l in merges_file.readlines():
722
p.append(l.rstrip('\n'))
726
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
727
"""Set the parent ids to revision_ids.
729
See also set_parent_trees. This api will try to retrieve the tree data
730
for each element of revision_ids from the trees repository. If you have
731
tree data already available, it is more efficient to use
732
set_parent_trees rather than set_parent_ids. set_parent_ids is however
733
an easier API to use.
735
:param revision_ids: The revision_ids to set as the parent ids of this
736
working tree. Any of these may be ghosts.
739
for rev_id in revision_ids:
742
(rev_id, self.branch.repository.revision_tree(rev_id)))
743
except errors.RevisionNotPresent:
744
trees.append((rev_id, None))
745
self.set_parent_trees(trees,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
749
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
"""Set the parents of the working tree.
752
:param parents_list: A list of (revision_id, tree) tuples.
753
If tree is None, then that element is treated as an unreachable
754
parent tree - i.e. a ghost.
756
if len(parents_list) > 0:
757
leftmost_id = parents_list[0][0]
758
if (not allow_leftmost_as_ghost and not
759
self.branch.repository.has_revision(leftmost_id)):
760
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
self.set_last_revision(leftmost_id)
763
self.set_last_revision(None)
764
merges = parents_list[1:]
765
self.set_pending_merges([revid for revid, tree in merges])
768
def set_pending_merges(self, rev_list):
769
if self.last_revision() is None:
770
new_last_list = rev_list[:1]
771
rev_list = rev_list[1:]
773
self.set_last_revision(new_last_list[0])
774
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
777
def set_merge_modified(self, modified_hashes):
779
for file_id, hash in modified_hashes.iteritems():
780
yield Stanza(file_id=file_id, hash=hash)
781
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
784
def _put_rio(self, filename, stanzas, header):
785
my_file = rio_file(stanzas, header)
786
self._control_files.put(filename, my_file)
789
def merge_modified(self):
791
hashfile = self._control_files.get('merge-hashes')
796
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
797
raise MergeModifiedFormatError()
798
except StopIteration:
799
raise MergeModifiedFormatError()
800
for s in RioReader(hashfile):
801
file_id = s.get("file_id")
802
if file_id not in self.inventory:
805
if hash == self.get_file_sha1(file_id):
806
merge_hashes[file_id] = hash
809
def get_symlink_target(self, file_id):
810
return os.readlink(self.id2abspath(file_id))
812
def file_class(self, filename):
813
if self.path2id(filename):
815
elif self.is_ignored(filename):
820
def list_files(self):
821
"""Recursively list all files as (path, class, kind, id, entry).
823
Lists, but does not descend into unversioned directories.
825
This does not include files that have been deleted in this
828
Skips the control directory.
830
inv = self._inventory
831
# Convert these into local objects to save lookup times
832
pathjoin = osutils.pathjoin
833
file_kind = osutils.file_kind
835
# transport.base ends in a slash, we want the piece
836
# between the last two slashes
837
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
839
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
841
# directory file_id, relative path, absolute path, reverse sorted children
842
children = os.listdir(self.basedir)
844
# jam 20060527 The kernel sized tree seems equivalent whether we
845
# use a deque and popleft to keep them sorted, or if we use a plain
846
# list and just reverse() them.
847
children = collections.deque(children)
848
stack = [(inv.root.file_id, u'', self.basedir, children)]
850
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
853
f = children.popleft()
854
## TODO: If we find a subdirectory with its own .bzr
855
## directory, then that is a separate tree and we
856
## should exclude it.
858
# the bzrdir for this tree
859
if transport_base_dir == f:
862
# we know that from_dir_relpath and from_dir_abspath never end in a slash
863
# and 'f' doesn't begin with one, we can do a string op, rather
864
# than the checks of pathjoin(), all relative paths will have an extra slash
866
fp = from_dir_relpath + '/' + f
869
fap = from_dir_abspath + '/' + f
871
f_ie = inv.get_child(from_dir_id, f)
874
elif self.is_ignored(fp[1:]):
877
# we may not have found this file, because of a unicode issue
878
f_norm, can_access = osutils.normalized_filename(f)
879
if f == f_norm or not can_access:
880
# No change, so treat this file normally
883
# this file can be accessed by a normalized path
884
# check again if it is versioned
885
# these lines are repeated here for performance
887
fp = from_dir_relpath + '/' + f
888
fap = from_dir_abspath + '/' + f
889
f_ie = inv.get_child(from_dir_id, f)
892
elif self.is_ignored(fp[1:]):
901
raise BzrCheckError("file %r entered as kind %r id %r, "
903
% (fap, f_ie.kind, f_ie.file_id, fk))
905
# make a last minute entry
907
yield fp[1:], c, fk, f_ie.file_id, f_ie
910
yield fp[1:], c, fk, None, fk_entries[fk]()
912
yield fp[1:], c, fk, None, TreeEntry()
915
if fk != 'directory':
918
# But do this child first
919
new_children = os.listdir(fap)
921
new_children = collections.deque(new_children)
922
stack.append((f_ie.file_id, fp, fap, new_children))
923
# Break out of inner loop, so that we start outer loop with child
926
# if we finished all children, pop it off the stack
931
def move(self, from_paths, to_name):
934
to_name must exist in the inventory.
936
If to_name exists and is a directory, the files are moved into
937
it, keeping their old names.
939
Note that to_name is only the last component of the new name;
940
this doesn't change the directory.
942
This returns a list of (from_path, to_path) pairs for each
946
## TODO: Option to move IDs only
947
assert not isinstance(from_paths, basestring)
949
to_abs = self.abspath(to_name)
950
if not isdir(to_abs):
951
raise BzrError("destination %r is not a directory" % to_abs)
952
if not self.has_filename(to_name):
953
raise BzrError("destination %r not in working directory" % to_abs)
954
to_dir_id = inv.path2id(to_name)
955
if to_dir_id == None and to_name != '':
956
raise BzrError("destination %r is not a versioned directory" % to_name)
957
to_dir_ie = inv[to_dir_id]
958
if to_dir_ie.kind != 'directory':
959
raise BzrError("destination %r is not a directory" % to_abs)
961
to_idpath = inv.get_idpath(to_dir_id)
964
if not self.has_filename(f):
965
raise BzrError("%r does not exist in working tree" % f)
966
f_id = inv.path2id(f)
968
raise BzrError("%r is not versioned" % f)
969
name_tail = splitpath(f)[-1]
970
dest_path = pathjoin(to_name, name_tail)
971
if self.has_filename(dest_path):
972
raise BzrError("destination %r already exists" % dest_path)
973
if f_id in to_idpath:
974
raise BzrError("can't move %r to a subdirectory of itself" % f)
976
# OK, so there's a race here, it's possible that someone will
977
# create a file in this interval and then the rename might be
978
# left half-done. But we should have caught most problems.
979
orig_inv = deepcopy(self.inventory)
982
name_tail = splitpath(f)[-1]
983
dest_path = pathjoin(to_name, name_tail)
984
result.append((f, dest_path))
985
inv.rename(inv.path2id(f), to_dir_id, name_tail)
987
rename(self.abspath(f), self.abspath(dest_path))
989
raise BzrError("failed to rename %r to %r: %s" %
990
(f, dest_path, e[1]),
991
["rename rolled back"])
993
# restore the inventory on error
994
self._set_inventory(orig_inv)
996
self._write_inventory(inv)
1000
def rename_one(self, from_rel, to_rel):
1003
This can change the directory or the filename or both.
1005
inv = self.inventory
1006
if not self.has_filename(from_rel):
1007
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1008
if self.has_filename(to_rel):
1009
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1011
file_id = inv.path2id(from_rel)
1013
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1015
entry = inv[file_id]
1016
from_parent = entry.parent_id
1017
from_name = entry.name
1019
if inv.path2id(to_rel):
1020
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1022
to_dir, to_tail = os.path.split(to_rel)
1023
to_dir_id = inv.path2id(to_dir)
1024
if to_dir_id == None and to_dir != '':
1025
raise BzrError("can't determine destination directory id for %r" % to_dir)
1027
mutter("rename_one:")
1028
mutter(" file_id {%s}" % file_id)
1029
mutter(" from_rel %r" % from_rel)
1030
mutter(" to_rel %r" % to_rel)
1031
mutter(" to_dir %r" % to_dir)
1032
mutter(" to_dir_id {%s}" % to_dir_id)
1034
inv.rename(file_id, to_dir_id, to_tail)
1036
from_abs = self.abspath(from_rel)
1037
to_abs = self.abspath(to_rel)
1039
rename(from_abs, to_abs)
1041
inv.rename(file_id, from_parent, from_name)
1042
raise BzrError("failed to rename %r to %r: %s"
1043
% (from_abs, to_abs, e[1]),
1044
["rename rolled back"])
1045
self._write_inventory(inv)
1049
"""Return all unknown files.
1051
These are files in the working directory that are not versioned or
1052
control files or ignored.
1054
for subp in self.extras():
1055
if not self.is_ignored(subp):
1058
@deprecated_method(zero_eight)
1059
def iter_conflicts(self):
1060
"""List all files in the tree that have text or content conflicts.
1061
DEPRECATED. Use conflicts instead."""
1062
return self._iter_conflicts()
1064
def _iter_conflicts(self):
1066
for info in self.list_files():
1068
stem = get_conflicted_stem(path)
1071
if stem not in conflicted:
1072
conflicted.add(stem)
1076
def pull(self, source, overwrite=False, stop_revision=None):
1077
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1080
pp = ProgressPhase("Pull phase", 2, top_pb)
1082
old_revision_history = self.branch.revision_history()
1083
basis_tree = self.basis_tree()
1084
count = self.branch.pull(source, overwrite, stop_revision)
1085
new_revision_history = self.branch.revision_history()
1086
if new_revision_history != old_revision_history:
1088
if len(old_revision_history):
1089
other_revision = old_revision_history[-1]
1091
other_revision = None
1092
repository = self.branch.repository
1093
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1095
merge_inner(self.branch,
1096
self.branch.basis_tree(),
1102
self.set_last_revision(self.branch.last_revision())
1109
"""Yield all unknown files in this WorkingTree.
1111
If there are any unknown directories then only the directory is
1112
returned, not all its children. But if there are unknown files
1113
under a versioned subdirectory, they are returned.
1115
Currently returned depth-first, sorted by name within directories.
1117
## TODO: Work from given directory downwards
1118
for path, dir_entry in self.inventory.directories():
1119
# mutter("search for unknowns in %r", path)
1120
dirabs = self.abspath(path)
1121
if not isdir(dirabs):
1122
# e.g. directory deleted
1126
for subf in os.listdir(dirabs):
1129
if subf not in dir_entry.children:
1130
subf_norm, can_access = osutils.normalized_filename(subf)
1131
if subf_norm != subf and can_access:
1132
if subf_norm not in dir_entry.children:
1133
fl.append(subf_norm)
1139
subp = pathjoin(path, subf)
1142
def _translate_ignore_rule(self, rule):
1143
"""Translate a single ignore rule to a regex.
1145
There are two types of ignore rules. Those that do not contain a / are
1146
matched against the tail of the filename (that is, they do not care
1147
what directory the file is in.) Rules which do contain a slash must
1148
match the entire path. As a special case, './' at the start of the
1149
string counts as a slash in the string but is removed before matching
1150
(e.g. ./foo.c, ./src/foo.c)
1152
:return: The translated regex.
1154
if rule[:2] in ('./', '.\\'):
1156
result = fnmatch.translate(rule[2:])
1157
elif '/' in rule or '\\' in rule:
1159
result = fnmatch.translate(rule)
1161
# default rule style.
1162
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1163
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1164
return "(" + result + ")"
1166
def _combine_ignore_rules(self, rules):
1167
"""Combine a list of ignore rules into a single regex object.
1169
Each individual rule is combined with | to form a big regex, which then
1170
has $ added to it to form something like ()|()|()$. The group index for
1171
each subregex's outermost group is placed in a dictionary mapping back
1172
to the rule. This allows quick identification of the matching rule that
1174
:return: a list of the compiled regex and the matching-group index
1175
dictionaries. We return a list because python complains if you try to
1176
combine more than 100 regexes.
1181
translated_rules = []
1183
translated_rule = self._translate_ignore_rule(rule)
1184
compiled_rule = re.compile(translated_rule)
1185
groups[next_group] = rule
1186
next_group += compiled_rule.groups
1187
translated_rules.append(translated_rule)
1188
if next_group == 99:
1189
result.append((re.compile("|".join(translated_rules)), groups))
1192
translated_rules = []
1193
if len(translated_rules):
1194
result.append((re.compile("|".join(translated_rules)), groups))
1197
def ignored_files(self):
1198
"""Yield list of PATH, IGNORE_PATTERN"""
1199
for subp in self.extras():
1200
pat = self.is_ignored(subp)
1204
def get_ignore_list(self):
1205
"""Return list of ignore patterns.
1207
Cached in the Tree object after the first call.
1209
ignoreset = getattr(self, '_ignoreset', None)
1210
if ignoreset is not None:
1213
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1214
ignore_globs.update(ignores.get_runtime_ignores())
1216
ignore_globs.update(ignores.get_user_ignores())
1218
if self.has_filename(bzrlib.IGNORE_FILENAME):
1219
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1221
ignore_globs.update(ignores.parse_ignore_file(f))
1225
self._ignoreset = ignore_globs
1226
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1229
def _get_ignore_rules_as_regex(self):
1230
"""Return a regex of the ignore rules and a mapping dict.
1232
:return: (ignore rules compiled regex, dictionary mapping rule group
1233
indices to original rule.)
1235
if getattr(self, '_ignoreset', None) is None:
1236
self.get_ignore_list()
1237
return self._ignore_regex
1239
def is_ignored(self, filename):
1240
r"""Check whether the filename matches an ignore pattern.
1242
Patterns containing '/' or '\' need to match the whole path;
1243
others match against only the last component.
1245
If the file is ignored, returns the pattern which caused it to
1246
be ignored, otherwise None. So this can simply be used as a
1247
boolean if desired."""
1249
# TODO: Use '**' to match directories, and other extended
1250
# globbing stuff from cvs/rsync.
1252
# XXX: fnmatch is actually not quite what we want: it's only
1253
# approximately the same as real Unix fnmatch, and doesn't
1254
# treat dotfiles correctly and allows * to match /.
1255
# Eventually it should be replaced with something more
1258
rules = self._get_ignore_rules_as_regex()
1259
for regex, mapping in rules:
1260
match = regex.match(filename)
1261
if match is not None:
1262
# one or more of the groups in mapping will have a non-None
1264
groups = match.groups()
1265
rules = [mapping[group] for group in
1266
mapping if groups[group] is not None]
1270
def kind(self, file_id):
1271
return file_kind(self.id2abspath(file_id))
1274
def last_revision(self):
1275
"""Return the last revision id of this working tree.
1277
In early branch formats this was == the branch last_revision,
1278
but that cannot be relied upon - for working tree operations,
1279
always use tree.last_revision().
1281
return self.branch.last_revision()
1283
def is_locked(self):
1284
return self._control_files.is_locked()
1286
def lock_read(self):
1287
"""See Branch.lock_read, and WorkingTree.unlock."""
1288
self.branch.lock_read()
1290
return self._control_files.lock_read()
1292
self.branch.unlock()
1295
def lock_write(self):
1296
"""See Branch.lock_write, and WorkingTree.unlock."""
1297
self.branch.lock_write()
1299
return self._control_files.lock_write()
1301
self.branch.unlock()
1304
def get_physical_lock_status(self):
1305
return self._control_files.get_physical_lock_status()
1307
def _basis_inventory_name(self):
1308
return 'basis-inventory'
1311
def set_last_revision(self, new_revision):
1312
"""Change the last revision in the working tree."""
1313
if self._change_last_revision(new_revision):
1314
self._cache_basis_inventory(new_revision)
1316
def _change_last_revision(self, new_revision):
1317
"""Template method part of set_last_revision to perform the change.
1319
This is used to allow WorkingTree3 instances to not affect branch
1320
when their last revision is set.
1322
if new_revision is None:
1323
self.branch.set_revision_history([])
1326
self.branch.generate_revision_history(new_revision)
1327
except errors.NoSuchRevision:
1328
# not present in the repo - dont try to set it deeper than the tip
1329
self.branch.set_revision_history([new_revision])
1332
def _cache_basis_inventory(self, new_revision):
1333
"""Cache new_revision as the basis inventory."""
1334
# TODO: this should allow the ready-to-use inventory to be passed in,
1335
# as commit already has that ready-to-use [while the format is the
1338
# this double handles the inventory - unpack and repack -
1339
# but is easier to understand. We can/should put a conditional
1340
# in here based on whether the inventory is in the latest format
1341
# - perhaps we should repack all inventories on a repository
1343
# the fast path is to copy the raw xml from the repository. If the
1344
# xml contains 'revision_id="', then we assume the right
1345
# revision_id is set. We must check for this full string, because a
1346
# root node id can legitimately look like 'revision_id' but cannot
1348
xml = self.branch.repository.get_inventory_xml(new_revision)
1349
if not 'revision_id="' in xml.split('\n', 1)[0]:
1350
inv = self.branch.repository.deserialise_inventory(
1352
inv.revision_id = new_revision
1353
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1354
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1355
path = self._basis_inventory_name()
1357
self._control_files.put(path, sio)
1358
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1361
def read_basis_inventory(self):
1362
"""Read the cached basis inventory."""
1363
path = self._basis_inventory_name()
1364
return self._control_files.get(path).read()
1367
def read_working_inventory(self):
1368
"""Read the working inventory."""
1369
# ElementTree does its own conversion from UTF-8, so open in
1371
result = bzrlib.xml5.serializer_v5.read_inventory(
1372
self._control_files.get('inventory'))
1373
self._set_inventory(result)
1377
def remove(self, files, verbose=False, to_file=None):
1378
"""Remove nominated files from the working inventory..
1380
This does not remove their text. This does not run on XXX on what? RBC
1382
TODO: Refuse to remove modified files unless --force is given?
1384
TODO: Do something useful with directories.
1386
TODO: Should this remove the text or not? Tough call; not
1387
removing may be useful and the user can just use use rm, and
1388
is the opposite of add. Removing it is consistent with most
1389
other tools. Maybe an option.
1391
## TODO: Normalize names
1392
## TODO: Remove nested loops; better scalability
1393
if isinstance(files, basestring):
1396
inv = self.inventory
1398
# do this before any modifications
1400
fid = inv.path2id(f)
1402
# TODO: Perhaps make this just a warning, and continue?
1403
# This tends to happen when
1404
raise NotVersionedError(path=f)
1406
# having remove it, it must be either ignored or unknown
1407
if self.is_ignored(f):
1411
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1414
self._write_inventory(inv)
1417
def revert(self, filenames, old_tree=None, backups=True,
1418
pb=DummyProgress()):
1419
from transform import revert
1420
from conflicts import resolve
1421
if old_tree is None:
1422
old_tree = self.basis_tree()
1423
conflicts = revert(self, old_tree, filenames, backups, pb)
1424
if not len(filenames):
1425
self.set_pending_merges([])
1428
resolve(self, filenames, ignore_misses=True)
1431
# XXX: This method should be deprecated in favour of taking in a proper
1432
# new Inventory object.
1434
def set_inventory(self, new_inventory_list):
1435
from bzrlib.inventory import (Inventory,
1440
inv = Inventory(self.get_root_id())
1441
for path, file_id, parent, kind in new_inventory_list:
1442
name = os.path.basename(path)
1445
# fixme, there should be a factory function inv,add_??
1446
if kind == 'directory':
1447
inv.add(InventoryDirectory(file_id, name, parent))
1448
elif kind == 'file':
1449
inv.add(InventoryFile(file_id, name, parent))
1450
elif kind == 'symlink':
1451
inv.add(InventoryLink(file_id, name, parent))
1453
raise BzrError("unknown kind %r" % kind)
1454
self._write_inventory(inv)
1457
def set_root_id(self, file_id):
1458
"""Set the root id for this tree."""
1459
inv = self.read_working_inventory()
1460
orig_root_id = inv.root.file_id
1461
del inv._byid[inv.root.file_id]
1462
inv.root.file_id = file_id
1463
inv._byid[inv.root.file_id] = inv.root
1466
if entry.parent_id == orig_root_id:
1467
entry.parent_id = inv.root.file_id
1468
self._write_inventory(inv)
1471
"""See Branch.unlock.
1473
WorkingTree locking just uses the Branch locking facilities.
1474
This is current because all working trees have an embedded branch
1475
within them. IF in the future, we were to make branch data shareable
1476
between multiple working trees, i.e. via shared storage, then we
1477
would probably want to lock both the local tree, and the branch.
1479
raise NotImplementedError(self.unlock)
1483
"""Update a working tree along its branch.
1485
This will update the branch if its bound too, which means we have multiple trees involved:
1486
The new basis tree of the master.
1487
The old basis tree of the branch.
1488
The old basis tree of the working tree.
1489
The current working tree state.
1490
pathologically all three may be different, and non ancestors of each other.
1491
Conceptually we want to:
1492
Preserve the wt.basis->wt.state changes
1493
Transform the wt.basis to the new master basis.
1494
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1495
Restore the wt.basis->wt.state changes.
1497
There isn't a single operation at the moment to do that, so we:
1498
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1499
Do a 'normal' merge of the old branch basis if it is relevant.
1501
old_tip = self.branch.update()
1502
# here if old_tip is not None, it is the old tip of the branch before
1503
# it was updated from the master branch. This should become a pending
1504
# merge in the working tree to preserve the user existing work. we
1505
# cant set that until we update the working trees last revision to be
1506
# one from the new branch, because it will just get absorbed by the
1507
# parent de-duplication logic.
1509
# We MUST save it even if an error occurs, because otherwise the users
1510
# local work is unreferenced and will appear to have been lost.
1513
if self.last_revision() != self.branch.last_revision():
1514
# merge tree state up to new branch tip.
1515
basis = self.basis_tree()
1516
to_tree = self.branch.basis_tree()
1517
result += merge_inner(self.branch,
1521
# when we have set_parent_ids/set_parent_trees we can
1522
# set the pending merge from old tip here if needed. We cant
1523
# set a pending merge for old tip until we've changed the
1524
# primary parent because it will typically have the same value.
1526
self.set_last_revision(self.branch.last_revision())
1528
if old_tip is not None:
1529
self.add_pending_merge(old_tip)
1531
# the working tree had the same last-revision as the master
1532
# branch did. We may still have pivot local work from the local
1533
# branch into old_tip:
1534
if old_tip is not None:
1535
self.add_pending_merge(old_tip)
1536
if old_tip and old_tip != self.last_revision():
1537
# our last revision was not the prior branch last revision
1538
# and we have converted that last revision to a pending merge.
1539
# base is somewhere between the branch tip now
1540
# and the now pending merge
1541
from bzrlib.revision import common_ancestor
1543
base_rev_id = common_ancestor(self.branch.last_revision(),
1545
self.branch.repository)
1546
except errors.NoCommonAncestor:
1548
base_tree = self.branch.repository.revision_tree(base_rev_id)
1549
other_tree = self.branch.repository.revision_tree(old_tip)
1550
result += merge_inner(self.branch,
1557
def _write_inventory(self, inv):
1558
"""Write inventory as the current inventory."""
1560
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1562
self._control_files.put('inventory', sio)
1563
self._set_inventory(inv)
1564
mutter('wrote working inventory')
1566
def set_conflicts(self, arg):
1567
raise UnsupportedOperation(self.set_conflicts, self)
1569
def add_conflicts(self, arg):
1570
raise UnsupportedOperation(self.add_conflicts, self)
1573
def conflicts(self):
1574
conflicts = ConflictList()
1575
for conflicted in self._iter_conflicts():
1578
if file_kind(self.abspath(conflicted)) != "file":
1580
except errors.NoSuchFile:
1583
for suffix in ('.THIS', '.OTHER'):
1585
kind = file_kind(self.abspath(conflicted+suffix))
1588
except errors.NoSuchFile:
1592
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1593
conflicts.append(Conflict.factory(ctype, path=conflicted,
1594
file_id=self.path2id(conflicted)))
1598
class WorkingTree2(WorkingTree):
1599
"""This is the Format 2 working tree.
1601
This was the first weave based working tree.
1602
- uses os locks for locking.
1603
- uses the branch last-revision.
1607
# we share control files:
1608
if self._hashcache.needs_write and self._control_files._lock_count==3:
1609
self._hashcache.write()
1610
# reverse order of locking.
1612
return self._control_files.unlock()
1614
self.branch.unlock()
1617
class WorkingTree3(WorkingTree):
1618
"""This is the Format 3 working tree.
1620
This differs from the base WorkingTree by:
1621
- having its own file lock
1622
- having its own last-revision property.
1624
This is new in bzr 0.8
1628
def last_revision(self):
1629
"""See WorkingTree.last_revision."""
1631
return self._control_files.get_utf8('last-revision').read()
1635
def _change_last_revision(self, revision_id):
1636
"""See WorkingTree._change_last_revision."""
1637
if revision_id is None or revision_id == NULL_REVISION:
1639
self._control_files._transport.delete('last-revision')
1640
except errors.NoSuchFile:
1644
self._control_files.put_utf8('last-revision', revision_id)
1648
def set_conflicts(self, conflicts):
1649
self._put_rio('conflicts', conflicts.to_stanzas(),
1653
def add_conflicts(self, new_conflicts):
1654
conflict_set = set(self.conflicts())
1655
conflict_set.update(set(list(new_conflicts)))
1656
self.set_conflicts(ConflictList(sorted(conflict_set,
1657
key=Conflict.sort_key)))
1660
def conflicts(self):
1662
confile = self._control_files.get('conflicts')
1664
return ConflictList()
1666
if confile.next() != CONFLICT_HEADER_1 + '\n':
1667
raise ConflictFormatError()
1668
except StopIteration:
1669
raise ConflictFormatError()
1670
return ConflictList.from_stanzas(RioReader(confile))
1673
if self._hashcache.needs_write and self._control_files._lock_count==1:
1674
self._hashcache.write()
1675
# reverse order of locking.
1677
return self._control_files.unlock()
1679
self.branch.unlock()
1682
def get_conflicted_stem(path):
1683
for suffix in CONFLICT_SUFFIXES:
1684
if path.endswith(suffix):
1685
return path[:-len(suffix)]
1687
@deprecated_function(zero_eight)
1688
def is_control_file(filename):
1689
"""See WorkingTree.is_control_filename(filename)."""
1690
## FIXME: better check
1691
filename = normpath(filename)
1692
while filename != '':
1693
head, tail = os.path.split(filename)
1694
## mutter('check %r for control file' % ((head, tail),))
1697
if filename == head:
1703
class WorkingTreeFormat(object):
1704
"""An encapsulation of the initialization and open routines for a format.
1706
Formats provide three things:
1707
* An initialization routine,
1711
Formats are placed in an dict by their format string for reference
1712
during workingtree opening. Its not required that these be instances, they
1713
can be classes themselves with class methods - it simply depends on
1714
whether state is needed for a given format or not.
1716
Once a format is deprecated, just deprecate the initialize and open
1717
methods on the format class. Do not deprecate the object, as the
1718
object will be created every time regardless.
1721
_default_format = None
1722
"""The default format used for new trees."""
1725
"""The known formats."""
1728
def find_format(klass, a_bzrdir):
1729
"""Return the format for the working tree object in a_bzrdir."""
1731
transport = a_bzrdir.get_workingtree_transport(None)
1732
format_string = transport.get("format").read()
1733
return klass._formats[format_string]
1735
raise errors.NoWorkingTree(base=transport.base)
1737
raise errors.UnknownFormatError(format=format_string)
1740
def get_default_format(klass):
1741
"""Return the current default format."""
1742
return klass._default_format
1744
def get_format_string(self):
1745
"""Return the ASCII format string that identifies this format."""
1746
raise NotImplementedError(self.get_format_string)
1748
def get_format_description(self):
1749
"""Return the short description for this format."""
1750
raise NotImplementedError(self.get_format_description)
1752
def is_supported(self):
1753
"""Is this format supported?
1755
Supported formats can be initialized and opened.
1756
Unsupported formats may not support initialization or committing or
1757
some other features depending on the reason for not being supported.
1762
def register_format(klass, format):
1763
klass._formats[format.get_format_string()] = format
1766
def set_default_format(klass, format):
1767
klass._default_format = format
1770
def unregister_format(klass, format):
1771
assert klass._formats[format.get_format_string()] is format
1772
del klass._formats[format.get_format_string()]
1776
class WorkingTreeFormat2(WorkingTreeFormat):
1777
"""The second working tree format.
1779
This format modified the hash cache from the format 1 hash cache.
1782
def get_format_description(self):
1783
"""See WorkingTreeFormat.get_format_description()."""
1784
return "Working tree format 2"
1786
def stub_initialize_remote(self, control_files):
1787
"""As a special workaround create critical control files for a remote working tree
1789
This ensures that it can later be updated and dealt with locally,
1790
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1791
no working tree. (See bug #43064).
1795
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1797
control_files.put('inventory', sio)
1799
control_files.put_utf8('pending-merges', '')
1802
def initialize(self, a_bzrdir, revision_id=None):
1803
"""See WorkingTreeFormat.initialize()."""
1804
if not isinstance(a_bzrdir.transport, LocalTransport):
1805
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1806
branch = a_bzrdir.open_branch()
1807
if revision_id is not None:
1810
revision_history = branch.revision_history()
1812
position = revision_history.index(revision_id)
1814
raise errors.NoSuchRevision(branch, revision_id)
1815
branch.set_revision_history(revision_history[:position + 1])
1818
revision = branch.last_revision()
1820
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1826
wt._write_inventory(inv)
1827
wt.set_root_id(inv.root.file_id)
1828
wt.set_last_revision(revision)
1829
wt.set_pending_merges([])
1830
build_tree(wt.basis_tree(), wt)
1834
super(WorkingTreeFormat2, self).__init__()
1835
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1837
def open(self, a_bzrdir, _found=False):
1838
"""Return the WorkingTree object for a_bzrdir
1840
_found is a private parameter, do not use it. It is used to indicate
1841
if format probing has already been done.
1844
# we are being called directly and must probe.
1845
raise NotImplementedError
1846
if not isinstance(a_bzrdir.transport, LocalTransport):
1847
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1848
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1854
class WorkingTreeFormat3(WorkingTreeFormat):
1855
"""The second working tree format updated to record a format marker.
1858
- exists within a metadir controlling .bzr
1859
- includes an explicit version marker for the workingtree control
1860
files, separate from the BzrDir format
1861
- modifies the hash cache format
1863
- uses a LockDir to guard access for writes.
1866
def get_format_string(self):
1867
"""See WorkingTreeFormat.get_format_string()."""
1868
return "Bazaar-NG Working Tree format 3"
1870
def get_format_description(self):
1871
"""See WorkingTreeFormat.get_format_description()."""
1872
return "Working tree format 3"
1874
_lock_file_name = 'lock'
1875
_lock_class = LockDir
1877
def _open_control_files(self, a_bzrdir):
1878
transport = a_bzrdir.get_workingtree_transport(None)
1879
return LockableFiles(transport, self._lock_file_name,
1882
def initialize(self, a_bzrdir, revision_id=None):
1883
"""See WorkingTreeFormat.initialize().
1885
revision_id allows creating a working tree at a different
1886
revision than the branch is at.
1888
if not isinstance(a_bzrdir.transport, LocalTransport):
1889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1890
transport = a_bzrdir.get_workingtree_transport(self)
1891
control_files = self._open_control_files(a_bzrdir)
1892
control_files.create_lock()
1893
control_files.lock_write()
1894
control_files.put_utf8('format', self.get_format_string())
1895
branch = a_bzrdir.open_branch()
1896
if revision_id is None:
1897
revision_id = branch.last_revision()
1899
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1905
_control_files=control_files)
1908
wt._write_inventory(inv)
1909
wt.set_root_id(inv.root.file_id)
1910
wt.set_last_revision(revision_id)
1911
wt.set_pending_merges([])
1912
build_tree(wt.basis_tree(), wt)
1915
control_files.unlock()
1919
super(WorkingTreeFormat3, self).__init__()
1920
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1922
def open(self, a_bzrdir, _found=False):
1923
"""Return the WorkingTree object for a_bzrdir
1925
_found is a private parameter, do not use it. It is used to indicate
1926
if format probing has already been done.
1929
# we are being called directly and must probe.
1930
raise NotImplementedError
1931
if not isinstance(a_bzrdir.transport, LocalTransport):
1932
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1933
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1935
def _open(self, a_bzrdir, control_files):
1936
"""Open the tree itself.
1938
:param a_bzrdir: the dir for the tree.
1939
:param control_files: the control files for the tree.
1941
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1945
_control_files=control_files)
1948
return self.get_format_string()
1951
# formats which have no format string are not discoverable
1952
# and not independently creatable, so are not registered.
1953
__default_format = WorkingTreeFormat3()
1954
WorkingTreeFormat.register_format(__default_format)
1955
WorkingTreeFormat.set_default_format(__default_format)
1956
_legacy_formats = [WorkingTreeFormat2(),
1960
class WorkingTreeTestProviderAdapter(object):
1961
"""A tool to generate a suite testing multiple workingtree formats at once.
1963
This is done by copying the test once for each transport and injecting
1964
the transport_server, transport_readonly_server, and workingtree_format
1965
classes into each copy. Each copy is also given a new id() to make it
1969
def __init__(self, transport_server, transport_readonly_server, formats):
1970
self._transport_server = transport_server
1971
self._transport_readonly_server = transport_readonly_server
1972
self._formats = formats
1974
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1975
"""Clone test for adaption."""
1976
new_test = deepcopy(test)
1977
new_test.transport_server = self._transport_server
1978
new_test.transport_readonly_server = self._transport_readonly_server
1979
new_test.bzrdir_format = bzrdir_format
1980
new_test.workingtree_format = workingtree_format
1981
def make_new_test_id():
1982
new_id = "%s(%s)" % (test.id(), variation)
1983
return lambda: new_id
1984
new_test.id = make_new_test_id()
1987
def adapt(self, test):
1988
from bzrlib.tests import TestSuite
1989
result = TestSuite()
1990
for workingtree_format, bzrdir_format in self._formats:
1991
new_test = self._clone_test(
1994
workingtree_format, workingtree_format.__class__.__name__)
1995
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
