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."""
398
revision_id = self.last_revision()
399
if revision_id is not None:
401
xml = self.read_basis_inventory()
402
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
403
inv.root.revision = revision_id
406
if inv is not None and inv.revision_id == revision_id:
407
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
409
# FIXME? RBC 20060403 should we cache the inventory here ?
411
return self.branch.repository.revision_tree(revision_id)
412
except errors.RevisionNotPresent:
413
# the basis tree *may* be a ghost or a low level error may have
414
# occured. If the revision is present, its a problem, if its not
416
if self.branch.repository.has_revision(revision_id):
418
# the basis tree is a ghost
419
return self.branch.repository.revision_tree(None)
422
@deprecated_method(zero_eight)
423
def create(branch, directory):
424
"""Create a workingtree for branch at directory.
426
If existing_directory already exists it must have a .bzr directory.
427
If it does not exist, it will be created.
429
This returns a new WorkingTree object for the new checkout.
431
TODO FIXME RBC 20060124 when we have checkout formats in place this
432
should accept an optional revisionid to checkout [and reject this if
433
checking out into the same dir as a pre-checkout-aware branch format.]
435
XXX: When BzrDir is present, these should be created through that
438
warnings.warn('delete WorkingTree.create', stacklevel=3)
439
transport = get_transport(directory)
440
if branch.bzrdir.root_transport.base == transport.base:
442
return branch.bzrdir.create_workingtree()
443
# different directory,
444
# create a branch reference
445
# and now a working tree.
446
raise NotImplementedError
449
@deprecated_method(zero_eight)
450
def create_standalone(directory):
451
"""Create a checkout and a branch and a repo at directory.
453
Directory must exist and be empty.
455
please use BzrDir.create_standalone_workingtree
457
return bzrdir.BzrDir.create_standalone_workingtree(directory)
459
def relpath(self, path):
460
"""Return the local path portion from a given path.
462
The path may be absolute or relative. If its a relative path it is
463
interpreted relative to the python current working directory.
465
return relpath(self.basedir, path)
467
def has_filename(self, filename):
468
return osutils.lexists(self.abspath(filename))
470
def get_file(self, file_id):
471
return self.get_file_byname(self.id2path(file_id))
473
def get_file_text(self, file_id):
474
return self.get_file(file_id).read()
476
def get_file_byname(self, filename):
477
return file(self.abspath(filename), 'rb')
479
def get_parent_ids(self):
480
"""See Tree.get_parent_ids.
482
This implementation reads the pending merges list and last_revision
483
value and uses that to decide what the parents list should be.
485
last_rev = self.last_revision()
490
other_parents = self.pending_merges()
491
return parents + other_parents
493
def get_root_id(self):
494
"""Return the id of this trees root"""
495
inv = self.read_working_inventory()
496
return inv.root.file_id
498
def _get_store_filename(self, file_id):
499
## XXX: badly named; this is not in the store at all
500
return self.abspath(self.id2path(file_id))
503
def clone(self, to_bzrdir, revision_id=None, basis=None):
504
"""Duplicate this working tree into to_bzr, including all state.
506
Specifically modified files are kept as modified, but
507
ignored and unknown files are discarded.
509
If you want to make a new line of development, see bzrdir.sprout()
512
If not None, the cloned tree will have its last revision set to
513
revision, and and difference between the source trees last revision
514
and this one merged in.
517
If not None, a closer copy of a tree which may have some files in
518
common, and which file content should be preferentially copied from.
520
# assumes the target bzr dir format is compatible.
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id)
526
def copy_content_into(self, tree, revision_id=None):
527
"""Copy the current content and user files of this tree into tree."""
528
if revision_id is None:
529
transform_tree(tree, self)
531
# TODO now merge from tree.last_revision to revision
532
transform_tree(tree, self)
533
tree.set_last_revision(revision_id)
536
def commit(self, message=None, revprops=None, *args, **kwargs):
537
# avoid circular imports
538
from bzrlib.commit import Commit
541
if not 'branch-nick' in revprops:
542
revprops['branch-nick'] = self.branch.nick
543
# args for wt.commit start at message from the Commit.commit method,
544
# but with branch a kwarg now, passing in args as is results in the
545
#message being used for the branch
546
args = (DEPRECATED_PARAMETER, message, ) + args
547
committed_id = Commit().commit( working_tree=self, revprops=revprops,
549
self._set_inventory(self.read_working_inventory())
552
def id2abspath(self, file_id):
553
return self.abspath(self.id2path(file_id))
555
def has_id(self, file_id):
556
# files that have been deleted are excluded
557
inv = self._inventory
558
if not inv.has_id(file_id):
560
path = inv.id2path(file_id)
561
return osutils.lexists(self.abspath(path))
563
def has_or_had_id(self, file_id):
564
if file_id == self.inventory.root.file_id:
566
return self.inventory.has_id(file_id)
568
__contains__ = has_id
570
def get_file_size(self, file_id):
571
return os.path.getsize(self.id2abspath(file_id))
574
def get_file_sha1(self, file_id, path=None):
576
path = self._inventory.id2path(file_id)
577
return self._hashcache.get_sha1(path)
579
def get_file_mtime(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
return os.lstat(self.abspath(path)).st_mtime
584
if not supports_executable():
585
def is_executable(self, file_id, path=None):
586
return self._inventory[file_id].executable
588
def is_executable(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
mode = os.lstat(self.abspath(path)).st_mode
592
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
595
def add(self, files, ids=None):
596
"""Make files versioned.
598
Note that the command line normally calls smart_add instead,
599
which can automatically recurse.
601
This adds the files to the inventory, so that they will be
602
recorded by the next commit.
605
List of paths to add, relative to the base of the tree.
608
If set, use these instead of automatically generated ids.
609
Must be the same length as the list of files, but may
610
contain None for ids that are to be autogenerated.
612
TODO: Perhaps have an option to add the ids even if the files do
615
TODO: Perhaps callback with the ids and paths as they're added.
617
# TODO: Re-adding a file that is removed in the working copy
618
# should probably put it back with the previous ID.
619
if isinstance(files, basestring):
620
assert(ids is None or isinstance(ids, basestring))
626
ids = [None] * len(files)
628
assert(len(ids) == len(files))
630
inv = self.read_working_inventory()
631
for f,file_id in zip(files, ids):
632
if self.is_control_filename(f):
633
raise errors.ForbiddenControlFileError(filename=f)
638
raise BzrError("cannot add top-level %r" % f)
640
fullpath = normpath(self.abspath(f))
642
kind = file_kind(fullpath)
644
if e.errno == errno.ENOENT:
645
raise NoSuchFile(fullpath)
646
if not InventoryEntry.versionable_kind(kind):
647
raise errors.BadFileKindError(filename=f, kind=kind)
649
inv.add_path(f, kind=kind)
651
inv.add_path(f, kind=kind, file_id=file_id)
653
self._write_inventory(inv)
656
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
657
"""Add revision_id as a parent.
659
This is equivalent to retrieving the current list of parent ids
660
and setting the list to its value plus revision_id.
662
:param revision_id: The revision id to add to the parent list. It may
665
self.set_parent_ids(self.get_parent_ids() + [revision_id],
666
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
669
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
670
"""Add revision_id, tree tuple as a parent.
672
This is equivalent to retrieving the current list of parent trees
673
and setting the list to its value plus parent_tuple. See also
674
add_parent_tree_id - if you only have a parent id available it will be
675
simpler to use that api. If you have the parent already available, using
676
this api is preferred.
678
:param parent_tuple: The (revision id, tree) to add to the parent list. If the revision_id is a ghost, pass None for the tree.
680
self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
681
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
684
def add_pending_merge(self, *revision_ids):
685
# TODO: Perhaps should check at this point that the
686
# history of the revision is actually present?
687
p = self.pending_merges()
688
existing_parents = self.get_parent_ids()
690
for rev_id in revision_ids:
693
if rev_id in existing_parents:
698
self.set_pending_merges(p)
701
def pending_merges(self):
702
"""Return a list of pending merges.
704
These are revisions that have been merged into the working
705
directory but not yet committed.
708
merges_file = self._control_files.get_utf8('pending-merges')
712
for l in merges_file.readlines():
713
p.append(l.rstrip('\n'))
717
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
718
"""Set the parent ids to revision_ids.
720
See also set_parent_trees. This api will try to retrieve the tree data
721
for each element of revision_ids from the trees repository. If you have
722
tree data already available, it is more efficient to use
723
set_parent_trees rather than set_parent_ids. set_parent_ids is however
724
an easier API to use.
726
:param revision_ids: The revision_ids to set as the parent ids of this
727
working tree. Any of these may be ghosts.
730
for rev_id in revision_ids:
733
(rev_id, self.branch.repository.revision_tree(rev_id)))
734
except errors.RevisionNotPresent:
735
trees.append((rev_id, None))
737
self.set_parent_trees(trees,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
742
"""Set the parents of the working tree.
744
:param parents_list: A list of (revision_id, tree) tuples.
745
If tree is None, then that element is treated as an unreachable
746
parent tree - i.e. a ghost.
748
parent = parents_list[:1]
750
if (not allow_leftmost_as_ghost and not
751
self.branch.repository.has_revision(parent[0][0])):
752
raise errors.GhostRevision(parent[0][0])
753
self.set_last_revision(parent[0][0])
755
self.set_last_revision(None)
756
merges = parents_list[1:]
757
self.set_pending_merges([revid for revid, tree in merges])
760
def set_pending_merges(self, rev_list):
761
if self.last_revision() is None:
762
new_last_list = rev_list[:1]
763
rev_list = rev_list[1:]
765
self.set_last_revision(new_last_list[0])
766
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
769
def set_merge_modified(self, modified_hashes):
771
for file_id, hash in modified_hashes.iteritems():
772
yield Stanza(file_id=file_id, hash=hash)
773
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
776
def _put_rio(self, filename, stanzas, header):
777
my_file = rio_file(stanzas, header)
778
self._control_files.put(filename, my_file)
781
def merge_modified(self):
783
hashfile = self._control_files.get('merge-hashes')
788
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
789
raise MergeModifiedFormatError()
790
except StopIteration:
791
raise MergeModifiedFormatError()
792
for s in RioReader(hashfile):
793
file_id = s.get("file_id")
794
if file_id not in self.inventory:
797
if hash == self.get_file_sha1(file_id):
798
merge_hashes[file_id] = hash
801
def get_symlink_target(self, file_id):
802
return os.readlink(self.id2abspath(file_id))
804
def file_class(self, filename):
805
if self.path2id(filename):
807
elif self.is_ignored(filename):
812
def list_files(self):
813
"""Recursively list all files as (path, class, kind, id, entry).
815
Lists, but does not descend into unversioned directories.
817
This does not include files that have been deleted in this
820
Skips the control directory.
822
inv = self._inventory
823
# Convert these into local objects to save lookup times
824
pathjoin = osutils.pathjoin
825
file_kind = osutils.file_kind
827
# transport.base ends in a slash, we want the piece
828
# between the last two slashes
829
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
831
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
833
# directory file_id, relative path, absolute path, reverse sorted children
834
children = os.listdir(self.basedir)
836
# jam 20060527 The kernel sized tree seems equivalent whether we
837
# use a deque and popleft to keep them sorted, or if we use a plain
838
# list and just reverse() them.
839
children = collections.deque(children)
840
stack = [(inv.root.file_id, u'', self.basedir, children)]
842
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
845
f = children.popleft()
846
## TODO: If we find a subdirectory with its own .bzr
847
## directory, then that is a separate tree and we
848
## should exclude it.
850
# the bzrdir for this tree
851
if transport_base_dir == f:
854
# we know that from_dir_relpath and from_dir_abspath never end in a slash
855
# and 'f' doesn't begin with one, we can do a string op, rather
856
# than the checks of pathjoin(), all relative paths will have an extra slash
858
fp = from_dir_relpath + '/' + f
861
fap = from_dir_abspath + '/' + f
863
f_ie = inv.get_child(from_dir_id, f)
866
elif self.is_ignored(fp[1:]):
869
# we may not have found this file, because of a unicode issue
870
f_norm, can_access = osutils.normalized_filename(f)
871
if f == f_norm or not can_access:
872
# No change, so treat this file normally
875
# this file can be accessed by a normalized path
876
# check again if it is versioned
877
# these lines are repeated here for performance
879
fp = from_dir_relpath + '/' + f
880
fap = from_dir_abspath + '/' + f
881
f_ie = inv.get_child(from_dir_id, f)
884
elif self.is_ignored(fp[1:]):
893
raise BzrCheckError("file %r entered as kind %r id %r, "
895
% (fap, f_ie.kind, f_ie.file_id, fk))
897
# make a last minute entry
899
yield fp[1:], c, fk, f_ie.file_id, f_ie
902
yield fp[1:], c, fk, None, fk_entries[fk]()
904
yield fp[1:], c, fk, None, TreeEntry()
907
if fk != 'directory':
910
# But do this child first
911
new_children = os.listdir(fap)
913
new_children = collections.deque(new_children)
914
stack.append((f_ie.file_id, fp, fap, new_children))
915
# Break out of inner loop, so that we start outer loop with child
918
# if we finished all children, pop it off the stack
923
def move(self, from_paths, to_name):
926
to_name must exist in the inventory.
928
If to_name exists and is a directory, the files are moved into
929
it, keeping their old names.
931
Note that to_name is only the last component of the new name;
932
this doesn't change the directory.
934
This returns a list of (from_path, to_path) pairs for each
938
## TODO: Option to move IDs only
939
assert not isinstance(from_paths, basestring)
941
to_abs = self.abspath(to_name)
942
if not isdir(to_abs):
943
raise BzrError("destination %r is not a directory" % to_abs)
944
if not self.has_filename(to_name):
945
raise BzrError("destination %r not in working directory" % to_abs)
946
to_dir_id = inv.path2id(to_name)
947
if to_dir_id == None and to_name != '':
948
raise BzrError("destination %r is not a versioned directory" % to_name)
949
to_dir_ie = inv[to_dir_id]
950
if to_dir_ie.kind != 'directory':
951
raise BzrError("destination %r is not a directory" % to_abs)
953
to_idpath = inv.get_idpath(to_dir_id)
956
if not self.has_filename(f):
957
raise BzrError("%r does not exist in working tree" % f)
958
f_id = inv.path2id(f)
960
raise BzrError("%r is not versioned" % f)
961
name_tail = splitpath(f)[-1]
962
dest_path = pathjoin(to_name, name_tail)
963
if self.has_filename(dest_path):
964
raise BzrError("destination %r already exists" % dest_path)
965
if f_id in to_idpath:
966
raise BzrError("can't move %r to a subdirectory of itself" % f)
968
# OK, so there's a race here, it's possible that someone will
969
# create a file in this interval and then the rename might be
970
# left half-done. But we should have caught most problems.
971
orig_inv = deepcopy(self.inventory)
974
name_tail = splitpath(f)[-1]
975
dest_path = pathjoin(to_name, name_tail)
976
result.append((f, dest_path))
977
inv.rename(inv.path2id(f), to_dir_id, name_tail)
979
rename(self.abspath(f), self.abspath(dest_path))
981
raise BzrError("failed to rename %r to %r: %s" %
982
(f, dest_path, e[1]),
983
["rename rolled back"])
985
# restore the inventory on error
986
self._set_inventory(orig_inv)
988
self._write_inventory(inv)
992
def rename_one(self, from_rel, to_rel):
995
This can change the directory or the filename or both.
998
if not self.has_filename(from_rel):
999
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1000
if self.has_filename(to_rel):
1001
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1003
file_id = inv.path2id(from_rel)
1005
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1007
entry = inv[file_id]
1008
from_parent = entry.parent_id
1009
from_name = entry.name
1011
if inv.path2id(to_rel):
1012
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1014
to_dir, to_tail = os.path.split(to_rel)
1015
to_dir_id = inv.path2id(to_dir)
1016
if to_dir_id == None and to_dir != '':
1017
raise BzrError("can't determine destination directory id for %r" % to_dir)
1019
mutter("rename_one:")
1020
mutter(" file_id {%s}" % file_id)
1021
mutter(" from_rel %r" % from_rel)
1022
mutter(" to_rel %r" % to_rel)
1023
mutter(" to_dir %r" % to_dir)
1024
mutter(" to_dir_id {%s}" % to_dir_id)
1026
inv.rename(file_id, to_dir_id, to_tail)
1028
from_abs = self.abspath(from_rel)
1029
to_abs = self.abspath(to_rel)
1031
rename(from_abs, to_abs)
1033
inv.rename(file_id, from_parent, from_name)
1034
raise BzrError("failed to rename %r to %r: %s"
1035
% (from_abs, to_abs, e[1]),
1036
["rename rolled back"])
1037
self._write_inventory(inv)
1041
"""Return all unknown files.
1043
These are files in the working directory that are not versioned or
1044
control files or ignored.
1046
for subp in self.extras():
1047
if not self.is_ignored(subp):
1050
@deprecated_method(zero_eight)
1051
def iter_conflicts(self):
1052
"""List all files in the tree that have text or content conflicts.
1053
DEPRECATED. Use conflicts instead."""
1054
return self._iter_conflicts()
1056
def _iter_conflicts(self):
1058
for info in self.list_files():
1060
stem = get_conflicted_stem(path)
1063
if stem not in conflicted:
1064
conflicted.add(stem)
1068
def pull(self, source, overwrite=False, stop_revision=None):
1069
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1072
pp = ProgressPhase("Pull phase", 2, top_pb)
1074
old_revision_history = self.branch.revision_history()
1075
basis_tree = self.basis_tree()
1076
count = self.branch.pull(source, overwrite, stop_revision)
1077
new_revision_history = self.branch.revision_history()
1078
if new_revision_history != old_revision_history:
1080
if len(old_revision_history):
1081
other_revision = old_revision_history[-1]
1083
other_revision = None
1084
repository = self.branch.repository
1085
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1087
merge_inner(self.branch,
1088
self.branch.basis_tree(),
1094
self.set_last_revision(self.branch.last_revision())
1101
"""Yield all unknown files in this WorkingTree.
1103
If there are any unknown directories then only the directory is
1104
returned, not all its children. But if there are unknown files
1105
under a versioned subdirectory, they are returned.
1107
Currently returned depth-first, sorted by name within directories.
1109
## TODO: Work from given directory downwards
1110
for path, dir_entry in self.inventory.directories():
1111
# mutter("search for unknowns in %r", path)
1112
dirabs = self.abspath(path)
1113
if not isdir(dirabs):
1114
# e.g. directory deleted
1118
for subf in os.listdir(dirabs):
1121
if subf not in dir_entry.children:
1122
subf_norm, can_access = osutils.normalized_filename(subf)
1123
if subf_norm != subf and can_access:
1124
if subf_norm not in dir_entry.children:
1125
fl.append(subf_norm)
1131
subp = pathjoin(path, subf)
1134
def _translate_ignore_rule(self, rule):
1135
"""Translate a single ignore rule to a regex.
1137
There are two types of ignore rules. Those that do not contain a / are
1138
matched against the tail of the filename (that is, they do not care
1139
what directory the file is in.) Rules which do contain a slash must
1140
match the entire path. As a special case, './' at the start of the
1141
string counts as a slash in the string but is removed before matching
1142
(e.g. ./foo.c, ./src/foo.c)
1144
:return: The translated regex.
1146
if rule[:2] in ('./', '.\\'):
1148
result = fnmatch.translate(rule[2:])
1149
elif '/' in rule or '\\' in rule:
1151
result = fnmatch.translate(rule)
1153
# default rule style.
1154
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1155
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1156
return "(" + result + ")"
1158
def _combine_ignore_rules(self, rules):
1159
"""Combine a list of ignore rules into a single regex object.
1161
Each individual rule is combined with | to form a big regex, which then
1162
has $ added to it to form something like ()|()|()$. The group index for
1163
each subregex's outermost group is placed in a dictionary mapping back
1164
to the rule. This allows quick identification of the matching rule that
1166
:return: a list of the compiled regex and the matching-group index
1167
dictionaries. We return a list because python complains if you try to
1168
combine more than 100 regexes.
1173
translated_rules = []
1175
translated_rule = self._translate_ignore_rule(rule)
1176
compiled_rule = re.compile(translated_rule)
1177
groups[next_group] = rule
1178
next_group += compiled_rule.groups
1179
translated_rules.append(translated_rule)
1180
if next_group == 99:
1181
result.append((re.compile("|".join(translated_rules)), groups))
1184
translated_rules = []
1185
if len(translated_rules):
1186
result.append((re.compile("|".join(translated_rules)), groups))
1189
def ignored_files(self):
1190
"""Yield list of PATH, IGNORE_PATTERN"""
1191
for subp in self.extras():
1192
pat = self.is_ignored(subp)
1196
def get_ignore_list(self):
1197
"""Return list of ignore patterns.
1199
Cached in the Tree object after the first call.
1201
ignoreset = getattr(self, '_ignoreset', None)
1202
if ignoreset is not None:
1205
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1206
ignore_globs.update(ignores.get_runtime_ignores())
1208
ignore_globs.update(ignores.get_user_ignores())
1210
if self.has_filename(bzrlib.IGNORE_FILENAME):
1211
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1213
ignore_globs.update(ignores.parse_ignore_file(f))
1217
self._ignoreset = ignore_globs
1218
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1221
def _get_ignore_rules_as_regex(self):
1222
"""Return a regex of the ignore rules and a mapping dict.
1224
:return: (ignore rules compiled regex, dictionary mapping rule group
1225
indices to original rule.)
1227
if getattr(self, '_ignoreset', None) is None:
1228
self.get_ignore_list()
1229
return self._ignore_regex
1231
def is_ignored(self, filename):
1232
r"""Check whether the filename matches an ignore pattern.
1234
Patterns containing '/' or '\' need to match the whole path;
1235
others match against only the last component.
1237
If the file is ignored, returns the pattern which caused it to
1238
be ignored, otherwise None. So this can simply be used as a
1239
boolean if desired."""
1241
# TODO: Use '**' to match directories, and other extended
1242
# globbing stuff from cvs/rsync.
1244
# XXX: fnmatch is actually not quite what we want: it's only
1245
# approximately the same as real Unix fnmatch, and doesn't
1246
# treat dotfiles correctly and allows * to match /.
1247
# Eventually it should be replaced with something more
1250
rules = self._get_ignore_rules_as_regex()
1251
for regex, mapping in rules:
1252
match = regex.match(filename)
1253
if match is not None:
1254
# one or more of the groups in mapping will have a non-None
1256
groups = match.groups()
1257
rules = [mapping[group] for group in
1258
mapping if groups[group] is not None]
1262
def kind(self, file_id):
1263
return file_kind(self.id2abspath(file_id))
1266
def last_revision(self):
1267
"""Return the last revision id of this working tree.
1269
In early branch formats this was == the branch last_revision,
1270
but that cannot be relied upon - for working tree operations,
1271
always use tree.last_revision().
1273
return self.branch.last_revision()
1275
def is_locked(self):
1276
return self._control_files.is_locked()
1278
def lock_read(self):
1279
"""See Branch.lock_read, and WorkingTree.unlock."""
1280
self.branch.lock_read()
1282
return self._control_files.lock_read()
1284
self.branch.unlock()
1287
def lock_write(self):
1288
"""See Branch.lock_write, and WorkingTree.unlock."""
1289
self.branch.lock_write()
1291
return self._control_files.lock_write()
1293
self.branch.unlock()
1296
def get_physical_lock_status(self):
1297
return self._control_files.get_physical_lock_status()
1299
def _basis_inventory_name(self):
1300
return 'basis-inventory'
1303
def set_last_revision(self, new_revision):
1304
"""Change the last revision in the working tree."""
1305
if self._change_last_revision(new_revision):
1306
self._cache_basis_inventory(new_revision)
1308
def _change_last_revision(self, new_revision):
1309
"""Template method part of set_last_revision to perform the change.
1311
This is used to allow WorkingTree3 instances to not affect branch
1312
when their last revision is set.
1314
if new_revision is None:
1315
self.branch.set_revision_history([])
1318
self.branch.generate_revision_history(new_revision)
1319
except errors.NoSuchRevision:
1320
# not present in the repo - dont try to set it deeper than the tip
1321
self.branch.set_revision_history([new_revision])
1324
def _cache_basis_inventory(self, new_revision):
1325
"""Cache new_revision as the basis inventory."""
1326
# TODO: this should allow the ready-to-use inventory to be passed in,
1327
# as commit already has that ready-to-use [while the format is the
1330
# this double handles the inventory - unpack and repack -
1331
# but is easier to understand. We can/should put a conditional
1332
# in here based on whether the inventory is in the latest format
1333
# - perhaps we should repack all inventories on a repository
1335
# the fast path is to copy the raw xml from the repository. If the
1336
# xml contains 'revision_id="', then we assume the right
1337
# revision_id is set. We must check for this full string, because a
1338
# root node id can legitimately look like 'revision_id' but cannot
1340
xml = self.branch.repository.get_inventory_xml(new_revision)
1341
if not 'revision_id="' in xml.split('\n', 1)[0]:
1342
inv = self.branch.repository.deserialise_inventory(
1344
inv.revision_id = new_revision
1345
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1346
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1347
path = self._basis_inventory_name()
1349
self._control_files.put(path, sio)
1350
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1353
def read_basis_inventory(self):
1354
"""Read the cached basis inventory."""
1355
path = self._basis_inventory_name()
1356
return self._control_files.get(path).read()
1359
def read_working_inventory(self):
1360
"""Read the working inventory."""
1361
# ElementTree does its own conversion from UTF-8, so open in
1363
result = bzrlib.xml5.serializer_v5.read_inventory(
1364
self._control_files.get('inventory'))
1365
self._set_inventory(result)
1369
def remove(self, files, verbose=False, to_file=None):
1370
"""Remove nominated files from the working inventory..
1372
This does not remove their text. This does not run on XXX on what? RBC
1374
TODO: Refuse to remove modified files unless --force is given?
1376
TODO: Do something useful with directories.
1378
TODO: Should this remove the text or not? Tough call; not
1379
removing may be useful and the user can just use use rm, and
1380
is the opposite of add. Removing it is consistent with most
1381
other tools. Maybe an option.
1383
## TODO: Normalize names
1384
## TODO: Remove nested loops; better scalability
1385
if isinstance(files, basestring):
1388
inv = self.inventory
1390
# do this before any modifications
1392
fid = inv.path2id(f)
1394
# TODO: Perhaps make this just a warning, and continue?
1395
# This tends to happen when
1396
raise NotVersionedError(path=f)
1398
# having remove it, it must be either ignored or unknown
1399
if self.is_ignored(f):
1403
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1406
self._write_inventory(inv)
1409
def revert(self, filenames, old_tree=None, backups=True,
1410
pb=DummyProgress()):
1411
from transform import revert
1412
from conflicts import resolve
1413
if old_tree is None:
1414
old_tree = self.basis_tree()
1415
conflicts = revert(self, old_tree, filenames, backups, pb)
1416
if not len(filenames):
1417
self.set_pending_merges([])
1420
resolve(self, filenames, ignore_misses=True)
1423
# XXX: This method should be deprecated in favour of taking in a proper
1424
# new Inventory object.
1426
def set_inventory(self, new_inventory_list):
1427
from bzrlib.inventory import (Inventory,
1432
inv = Inventory(self.get_root_id())
1433
for path, file_id, parent, kind in new_inventory_list:
1434
name = os.path.basename(path)
1437
# fixme, there should be a factory function inv,add_??
1438
if kind == 'directory':
1439
inv.add(InventoryDirectory(file_id, name, parent))
1440
elif kind == 'file':
1441
inv.add(InventoryFile(file_id, name, parent))
1442
elif kind == 'symlink':
1443
inv.add(InventoryLink(file_id, name, parent))
1445
raise BzrError("unknown kind %r" % kind)
1446
self._write_inventory(inv)
1449
def set_root_id(self, file_id):
1450
"""Set the root id for this tree."""
1451
inv = self.read_working_inventory()
1452
orig_root_id = inv.root.file_id
1453
del inv._byid[inv.root.file_id]
1454
inv.root.file_id = file_id
1455
inv._byid[inv.root.file_id] = inv.root
1458
if entry.parent_id == orig_root_id:
1459
entry.parent_id = inv.root.file_id
1460
self._write_inventory(inv)
1463
"""See Branch.unlock.
1465
WorkingTree locking just uses the Branch locking facilities.
1466
This is current because all working trees have an embedded branch
1467
within them. IF in the future, we were to make branch data shareable
1468
between multiple working trees, i.e. via shared storage, then we
1469
would probably want to lock both the local tree, and the branch.
1471
raise NotImplementedError(self.unlock)
1475
"""Update a working tree along its branch.
1477
This will update the branch if its bound too, which means we have multiple trees involved:
1478
The new basis tree of the master.
1479
The old basis tree of the branch.
1480
The old basis tree of the working tree.
1481
The current working tree state.
1482
pathologically all three may be different, and non ancestors of each other.
1483
Conceptually we want to:
1484
Preserve the wt.basis->wt.state changes
1485
Transform the wt.basis to the new master basis.
1486
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1487
Restore the wt.basis->wt.state changes.
1489
There isn't a single operation at the moment to do that, so we:
1490
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1491
Do a 'normal' merge of the old branch basis if it is relevant.
1493
old_tip = self.branch.update()
1496
if self.last_revision() != self.branch.last_revision():
1497
# merge tree state up to new branch tip.
1498
basis = self.basis_tree()
1499
to_tree = self.branch.basis_tree()
1500
result += merge_inner(self.branch,
1504
self.set_last_revision(self.branch.last_revision())
1505
if old_tip and old_tip != self.last_revision():
1506
# our last revision was not the prior branch last revision
1507
# and we have converted that last revision to a pending merge.
1508
# base is somewhere between the branch tip now
1509
# and the now pending merge
1510
from bzrlib.revision import common_ancestor
1512
base_rev_id = common_ancestor(self.branch.last_revision(),
1514
self.branch.repository)
1515
except errors.NoCommonAncestor:
1517
base_tree = self.branch.repository.revision_tree(base_rev_id)
1518
other_tree = self.branch.repository.revision_tree(old_tip)
1519
result += merge_inner(self.branch,
1525
if old_tip is not None:
1526
self.add_pending_merge(old_tip)
1529
def _write_inventory(self, inv):
1530
"""Write inventory as the current inventory."""
1532
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1534
self._control_files.put('inventory', sio)
1535
self._set_inventory(inv)
1536
mutter('wrote working inventory')
1538
def set_conflicts(self, arg):
1539
raise UnsupportedOperation(self.set_conflicts, self)
1541
def add_conflicts(self, arg):
1542
raise UnsupportedOperation(self.add_conflicts, self)
1545
def conflicts(self):
1546
conflicts = ConflictList()
1547
for conflicted in self._iter_conflicts():
1550
if file_kind(self.abspath(conflicted)) != "file":
1552
except errors.NoSuchFile:
1555
for suffix in ('.THIS', '.OTHER'):
1557
kind = file_kind(self.abspath(conflicted+suffix))
1560
except errors.NoSuchFile:
1564
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1565
conflicts.append(Conflict.factory(ctype, path=conflicted,
1566
file_id=self.path2id(conflicted)))
1570
class WorkingTree2(WorkingTree):
1571
"""This is the Format 2 working tree.
1573
This was the first weave based working tree.
1574
- uses os locks for locking.
1575
- uses the branch last-revision.
1579
# we share control files:
1580
if self._hashcache.needs_write and self._control_files._lock_count==3:
1581
self._hashcache.write()
1582
# reverse order of locking.
1584
return self._control_files.unlock()
1586
self.branch.unlock()
1589
class WorkingTree3(WorkingTree):
1590
"""This is the Format 3 working tree.
1592
This differs from the base WorkingTree by:
1593
- having its own file lock
1594
- having its own last-revision property.
1596
This is new in bzr 0.8
1600
def last_revision(self):
1601
"""See WorkingTree.last_revision."""
1603
return self._control_files.get_utf8('last-revision').read()
1607
def _change_last_revision(self, revision_id):
1608
"""See WorkingTree._change_last_revision."""
1609
if revision_id is None or revision_id == NULL_REVISION:
1611
self._control_files._transport.delete('last-revision')
1612
except errors.NoSuchFile:
1616
self._control_files.put_utf8('last-revision', revision_id)
1620
def set_conflicts(self, conflicts):
1621
self._put_rio('conflicts', conflicts.to_stanzas(),
1625
def add_conflicts(self, new_conflicts):
1626
conflict_set = set(self.conflicts())
1627
conflict_set.update(set(list(new_conflicts)))
1628
self.set_conflicts(ConflictList(sorted(conflict_set,
1629
key=Conflict.sort_key)))
1632
def conflicts(self):
1634
confile = self._control_files.get('conflicts')
1636
return ConflictList()
1638
if confile.next() != CONFLICT_HEADER_1 + '\n':
1639
raise ConflictFormatError()
1640
except StopIteration:
1641
raise ConflictFormatError()
1642
return ConflictList.from_stanzas(RioReader(confile))
1645
if self._hashcache.needs_write and self._control_files._lock_count==1:
1646
self._hashcache.write()
1647
# reverse order of locking.
1649
return self._control_files.unlock()
1651
self.branch.unlock()
1654
def get_conflicted_stem(path):
1655
for suffix in CONFLICT_SUFFIXES:
1656
if path.endswith(suffix):
1657
return path[:-len(suffix)]
1659
@deprecated_function(zero_eight)
1660
def is_control_file(filename):
1661
"""See WorkingTree.is_control_filename(filename)."""
1662
## FIXME: better check
1663
filename = normpath(filename)
1664
while filename != '':
1665
head, tail = os.path.split(filename)
1666
## mutter('check %r for control file' % ((head, tail),))
1669
if filename == head:
1675
class WorkingTreeFormat(object):
1676
"""An encapsulation of the initialization and open routines for a format.
1678
Formats provide three things:
1679
* An initialization routine,
1683
Formats are placed in an dict by their format string for reference
1684
during workingtree opening. Its not required that these be instances, they
1685
can be classes themselves with class methods - it simply depends on
1686
whether state is needed for a given format or not.
1688
Once a format is deprecated, just deprecate the initialize and open
1689
methods on the format class. Do not deprecate the object, as the
1690
object will be created every time regardless.
1693
_default_format = None
1694
"""The default format used for new trees."""
1697
"""The known formats."""
1700
def find_format(klass, a_bzrdir):
1701
"""Return the format for the working tree object in a_bzrdir."""
1703
transport = a_bzrdir.get_workingtree_transport(None)
1704
format_string = transport.get("format").read()
1705
return klass._formats[format_string]
1707
raise errors.NoWorkingTree(base=transport.base)
1709
raise errors.UnknownFormatError(format=format_string)
1712
def get_default_format(klass):
1713
"""Return the current default format."""
1714
return klass._default_format
1716
def get_format_string(self):
1717
"""Return the ASCII format string that identifies this format."""
1718
raise NotImplementedError(self.get_format_string)
1720
def get_format_description(self):
1721
"""Return the short description for this format."""
1722
raise NotImplementedError(self.get_format_description)
1724
def is_supported(self):
1725
"""Is this format supported?
1727
Supported formats can be initialized and opened.
1728
Unsupported formats may not support initialization or committing or
1729
some other features depending on the reason for not being supported.
1734
def register_format(klass, format):
1735
klass._formats[format.get_format_string()] = format
1738
def set_default_format(klass, format):
1739
klass._default_format = format
1742
def unregister_format(klass, format):
1743
assert klass._formats[format.get_format_string()] is format
1744
del klass._formats[format.get_format_string()]
1748
class WorkingTreeFormat2(WorkingTreeFormat):
1749
"""The second working tree format.
1751
This format modified the hash cache from the format 1 hash cache.
1754
def get_format_description(self):
1755
"""See WorkingTreeFormat.get_format_description()."""
1756
return "Working tree format 2"
1758
def stub_initialize_remote(self, control_files):
1759
"""As a special workaround create critical control files for a remote working tree
1761
This ensures that it can later be updated and dealt with locally,
1762
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1763
no working tree. (See bug #43064).
1767
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1769
control_files.put('inventory', sio)
1771
control_files.put_utf8('pending-merges', '')
1774
def initialize(self, a_bzrdir, revision_id=None):
1775
"""See WorkingTreeFormat.initialize()."""
1776
if not isinstance(a_bzrdir.transport, LocalTransport):
1777
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1778
branch = a_bzrdir.open_branch()
1779
if revision_id is not None:
1782
revision_history = branch.revision_history()
1784
position = revision_history.index(revision_id)
1786
raise errors.NoSuchRevision(branch, revision_id)
1787
branch.set_revision_history(revision_history[:position + 1])
1790
revision = branch.last_revision()
1792
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1798
wt._write_inventory(inv)
1799
wt.set_root_id(inv.root.file_id)
1800
wt.set_last_revision(revision)
1801
wt.set_pending_merges([])
1802
build_tree(wt.basis_tree(), wt)
1806
super(WorkingTreeFormat2, self).__init__()
1807
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1809
def open(self, a_bzrdir, _found=False):
1810
"""Return the WorkingTree object for a_bzrdir
1812
_found is a private parameter, do not use it. It is used to indicate
1813
if format probing has already been done.
1816
# we are being called directly and must probe.
1817
raise NotImplementedError
1818
if not isinstance(a_bzrdir.transport, LocalTransport):
1819
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1820
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1826
class WorkingTreeFormat3(WorkingTreeFormat):
1827
"""The second working tree format updated to record a format marker.
1830
- exists within a metadir controlling .bzr
1831
- includes an explicit version marker for the workingtree control
1832
files, separate from the BzrDir format
1833
- modifies the hash cache format
1835
- uses a LockDir to guard access for writes.
1838
def get_format_string(self):
1839
"""See WorkingTreeFormat.get_format_string()."""
1840
return "Bazaar-NG Working Tree format 3"
1842
def get_format_description(self):
1843
"""See WorkingTreeFormat.get_format_description()."""
1844
return "Working tree format 3"
1846
_lock_file_name = 'lock'
1847
_lock_class = LockDir
1849
def _open_control_files(self, a_bzrdir):
1850
transport = a_bzrdir.get_workingtree_transport(None)
1851
return LockableFiles(transport, self._lock_file_name,
1854
def initialize(self, a_bzrdir, revision_id=None):
1855
"""See WorkingTreeFormat.initialize().
1857
revision_id allows creating a working tree at a different
1858
revision than the branch is at.
1860
if not isinstance(a_bzrdir.transport, LocalTransport):
1861
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1862
transport = a_bzrdir.get_workingtree_transport(self)
1863
control_files = self._open_control_files(a_bzrdir)
1864
control_files.create_lock()
1865
control_files.lock_write()
1866
control_files.put_utf8('format', self.get_format_string())
1867
branch = a_bzrdir.open_branch()
1868
if revision_id is None:
1869
revision_id = branch.last_revision()
1871
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1877
_control_files=control_files)
1880
wt._write_inventory(inv)
1881
wt.set_root_id(inv.root.file_id)
1882
wt.set_last_revision(revision_id)
1883
wt.set_pending_merges([])
1884
build_tree(wt.basis_tree(), wt)
1887
control_files.unlock()
1891
super(WorkingTreeFormat3, self).__init__()
1892
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1894
def open(self, a_bzrdir, _found=False):
1895
"""Return the WorkingTree object for a_bzrdir
1897
_found is a private parameter, do not use it. It is used to indicate
1898
if format probing has already been done.
1901
# we are being called directly and must probe.
1902
raise NotImplementedError
1903
if not isinstance(a_bzrdir.transport, LocalTransport):
1904
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1905
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1907
def _open(self, a_bzrdir, control_files):
1908
"""Open the tree itself.
1910
:param a_bzrdir: the dir for the tree.
1911
:param control_files: the control files for the tree.
1913
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1917
_control_files=control_files)
1920
return self.get_format_string()
1923
# formats which have no format string are not discoverable
1924
# and not independently creatable, so are not registered.
1925
__default_format = WorkingTreeFormat3()
1926
WorkingTreeFormat.register_format(__default_format)
1927
WorkingTreeFormat.set_default_format(__default_format)
1928
_legacy_formats = [WorkingTreeFormat2(),
1932
class WorkingTreeTestProviderAdapter(object):
1933
"""A tool to generate a suite testing multiple workingtree formats at once.
1935
This is done by copying the test once for each transport and injecting
1936
the transport_server, transport_readonly_server, and workingtree_format
1937
classes into each copy. Each copy is also given a new id() to make it
1941
def __init__(self, transport_server, transport_readonly_server, formats):
1942
self._transport_server = transport_server
1943
self._transport_readonly_server = transport_readonly_server
1944
self._formats = formats
1946
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1947
"""Clone test for adaption."""
1948
new_test = deepcopy(test)
1949
new_test.transport_server = self._transport_server
1950
new_test.transport_readonly_server = self._transport_readonly_server
1951
new_test.bzrdir_format = bzrdir_format
1952
new_test.workingtree_format = workingtree_format
1953
def make_new_test_id():
1954
new_id = "%s(%s)" % (test.id(), variation)
1955
return lambda: new_id
1956
new_test.id = make_new_test_id()
1959
def adapt(self, test):
1960
from bzrlib.tests import TestSuite
1961
result = TestSuite()
1962
for workingtree_format, bzrdir_format in self._formats:
1963
new_test = self._clone_test(
1966
workingtree_format, workingtree_format.__class__.__name__)
1967
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
