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 (to preserve
532
# user local changes)
533
transform_tree(tree, self)
534
tree.set_parent_ids([revision_id])
537
def commit(self, message=None, revprops=None, *args, **kwargs):
538
# avoid circular imports
539
from bzrlib.commit import Commit
542
if not 'branch-nick' in revprops:
543
revprops['branch-nick'] = self.branch.nick
544
# args for wt.commit start at message from the Commit.commit method,
545
# but with branch a kwarg now, passing in args as is results in the
546
#message being used for the branch
547
args = (DEPRECATED_PARAMETER, message, ) + args
548
committed_id = Commit().commit( working_tree=self, revprops=revprops,
550
self._set_inventory(self.read_working_inventory())
553
def id2abspath(self, file_id):
554
return self.abspath(self.id2path(file_id))
556
def has_id(self, file_id):
557
# files that have been deleted are excluded
558
inv = self._inventory
559
if not inv.has_id(file_id):
561
path = inv.id2path(file_id)
562
return osutils.lexists(self.abspath(path))
564
def has_or_had_id(self, file_id):
565
if file_id == self.inventory.root.file_id:
567
return self.inventory.has_id(file_id)
569
__contains__ = has_id
571
def get_file_size(self, file_id):
572
return os.path.getsize(self.id2abspath(file_id))
575
def get_file_sha1(self, file_id, path=None):
577
path = self._inventory.id2path(file_id)
578
return self._hashcache.get_sha1(path)
580
def get_file_mtime(self, file_id, path=None):
582
path = self._inventory.id2path(file_id)
583
return os.lstat(self.abspath(path)).st_mtime
585
if not supports_executable():
586
def is_executable(self, file_id, path=None):
587
return self._inventory[file_id].executable
589
def is_executable(self, file_id, path=None):
591
path = self._inventory.id2path(file_id)
592
mode = os.lstat(self.abspath(path)).st_mode
593
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
596
def add(self, files, ids=None):
597
"""Make files versioned.
599
Note that the command line normally calls smart_add instead,
600
which can automatically recurse.
602
This adds the files to the inventory, so that they will be
603
recorded by the next commit.
606
List of paths to add, relative to the base of the tree.
609
If set, use these instead of automatically generated ids.
610
Must be the same length as the list of files, but may
611
contain None for ids that are to be autogenerated.
613
TODO: Perhaps have an option to add the ids even if the files do
616
TODO: Perhaps callback with the ids and paths as they're added.
618
# TODO: Re-adding a file that is removed in the working copy
619
# should probably put it back with the previous ID.
620
if isinstance(files, basestring):
621
assert(ids is None or isinstance(ids, basestring))
627
ids = [None] * len(files)
629
assert(len(ids) == len(files))
631
inv = self.read_working_inventory()
632
for f,file_id in zip(files, ids):
633
if self.is_control_filename(f):
634
raise errors.ForbiddenControlFileError(filename=f)
639
raise BzrError("cannot add top-level %r" % f)
641
fullpath = normpath(self.abspath(f))
643
kind = file_kind(fullpath)
645
if e.errno == errno.ENOENT:
646
raise NoSuchFile(fullpath)
647
if not InventoryEntry.versionable_kind(kind):
648
raise errors.BadFileKindError(filename=f, kind=kind)
650
inv.add_path(f, kind=kind)
652
inv.add_path(f, kind=kind, file_id=file_id)
654
self._write_inventory(inv)
657
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
658
"""Add revision_id as a parent.
660
This is equivalent to retrieving the current list of parent ids
661
and setting the list to its value plus revision_id.
663
:param revision_id: The revision id to add to the parent list. It may
666
self.set_parent_ids(self.get_parent_ids() + [revision_id],
667
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
670
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
671
"""Add revision_id, tree tuple as a parent.
673
This is equivalent to retrieving the current list of parent trees
674
and setting the list to its value plus parent_tuple. See also
675
add_parent_tree_id - if you only have a parent id available it will be
676
simpler to use that api. If you have the parent already available, using
677
this api is preferred.
679
: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.
681
self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
682
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
685
def add_pending_merge(self, *revision_ids):
686
# TODO: Perhaps should check at this point that the
687
# history of the revision is actually present?
688
p = self.pending_merges()
689
existing_parents = self.get_parent_ids()
691
for rev_id in revision_ids:
694
if rev_id in existing_parents:
699
self.set_pending_merges(p)
702
def pending_merges(self):
703
"""Return a list of pending merges.
705
These are revisions that have been merged into the working
706
directory but not yet committed.
709
merges_file = self._control_files.get_utf8('pending-merges')
713
for l in merges_file.readlines():
714
p.append(l.rstrip('\n'))
718
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
"""Set the parent ids to revision_ids.
721
See also set_parent_trees. This api will try to retrieve the tree data
722
for each element of revision_ids from the trees repository. If you have
723
tree data already available, it is more efficient to use
724
set_parent_trees rather than set_parent_ids. set_parent_ids is however
725
an easier API to use.
727
:param revision_ids: The revision_ids to set as the parent ids of this
728
working tree. Any of these may be ghosts.
731
for rev_id in revision_ids:
734
(rev_id, self.branch.repository.revision_tree(rev_id)))
735
except errors.RevisionNotPresent:
736
trees.append((rev_id, None))
738
self.set_parent_trees(trees,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
743
"""Set the parents of the working tree.
745
:param parents_list: A list of (revision_id, tree) tuples.
746
If tree is None, then that element is treated as an unreachable
747
parent tree - i.e. a ghost.
749
parent = parents_list[:1]
751
if (not allow_leftmost_as_ghost and not
752
self.branch.repository.has_revision(parent[0][0])):
753
raise errors.GhostRevision(parent[0][0])
754
self.set_last_revision(parent[0][0])
756
self.set_last_revision(None)
757
merges = parents_list[1:]
758
self.set_pending_merges([revid for revid, tree in merges])
761
def set_pending_merges(self, rev_list):
762
if self.last_revision() is None:
763
new_last_list = rev_list[:1]
764
rev_list = rev_list[1:]
766
self.set_last_revision(new_last_list[0])
767
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
770
def set_merge_modified(self, modified_hashes):
772
for file_id, hash in modified_hashes.iteritems():
773
yield Stanza(file_id=file_id, hash=hash)
774
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
777
def _put_rio(self, filename, stanzas, header):
778
my_file = rio_file(stanzas, header)
779
self._control_files.put(filename, my_file)
782
def merge_modified(self):
784
hashfile = self._control_files.get('merge-hashes')
789
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
790
raise MergeModifiedFormatError()
791
except StopIteration:
792
raise MergeModifiedFormatError()
793
for s in RioReader(hashfile):
794
file_id = s.get("file_id")
795
if file_id not in self.inventory:
798
if hash == self.get_file_sha1(file_id):
799
merge_hashes[file_id] = hash
802
def get_symlink_target(self, file_id):
803
return os.readlink(self.id2abspath(file_id))
805
def file_class(self, filename):
806
if self.path2id(filename):
808
elif self.is_ignored(filename):
813
def list_files(self):
814
"""Recursively list all files as (path, class, kind, id, entry).
816
Lists, but does not descend into unversioned directories.
818
This does not include files that have been deleted in this
821
Skips the control directory.
823
inv = self._inventory
824
# Convert these into local objects to save lookup times
825
pathjoin = osutils.pathjoin
826
file_kind = osutils.file_kind
828
# transport.base ends in a slash, we want the piece
829
# between the last two slashes
830
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
832
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
834
# directory file_id, relative path, absolute path, reverse sorted children
835
children = os.listdir(self.basedir)
837
# jam 20060527 The kernel sized tree seems equivalent whether we
838
# use a deque and popleft to keep them sorted, or if we use a plain
839
# list and just reverse() them.
840
children = collections.deque(children)
841
stack = [(inv.root.file_id, u'', self.basedir, children)]
843
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
846
f = children.popleft()
847
## TODO: If we find a subdirectory with its own .bzr
848
## directory, then that is a separate tree and we
849
## should exclude it.
851
# the bzrdir for this tree
852
if transport_base_dir == f:
855
# we know that from_dir_relpath and from_dir_abspath never end in a slash
856
# and 'f' doesn't begin with one, we can do a string op, rather
857
# than the checks of pathjoin(), all relative paths will have an extra slash
859
fp = from_dir_relpath + '/' + f
862
fap = from_dir_abspath + '/' + f
864
f_ie = inv.get_child(from_dir_id, f)
867
elif self.is_ignored(fp[1:]):
870
# we may not have found this file, because of a unicode issue
871
f_norm, can_access = osutils.normalized_filename(f)
872
if f == f_norm or not can_access:
873
# No change, so treat this file normally
876
# this file can be accessed by a normalized path
877
# check again if it is versioned
878
# these lines are repeated here for performance
880
fp = from_dir_relpath + '/' + f
881
fap = from_dir_abspath + '/' + f
882
f_ie = inv.get_child(from_dir_id, f)
885
elif self.is_ignored(fp[1:]):
894
raise BzrCheckError("file %r entered as kind %r id %r, "
896
% (fap, f_ie.kind, f_ie.file_id, fk))
898
# make a last minute entry
900
yield fp[1:], c, fk, f_ie.file_id, f_ie
903
yield fp[1:], c, fk, None, fk_entries[fk]()
905
yield fp[1:], c, fk, None, TreeEntry()
908
if fk != 'directory':
911
# But do this child first
912
new_children = os.listdir(fap)
914
new_children = collections.deque(new_children)
915
stack.append((f_ie.file_id, fp, fap, new_children))
916
# Break out of inner loop, so that we start outer loop with child
919
# if we finished all children, pop it off the stack
924
def move(self, from_paths, to_name):
927
to_name must exist in the inventory.
929
If to_name exists and is a directory, the files are moved into
930
it, keeping their old names.
932
Note that to_name is only the last component of the new name;
933
this doesn't change the directory.
935
This returns a list of (from_path, to_path) pairs for each
939
## TODO: Option to move IDs only
940
assert not isinstance(from_paths, basestring)
942
to_abs = self.abspath(to_name)
943
if not isdir(to_abs):
944
raise BzrError("destination %r is not a directory" % to_abs)
945
if not self.has_filename(to_name):
946
raise BzrError("destination %r not in working directory" % to_abs)
947
to_dir_id = inv.path2id(to_name)
948
if to_dir_id == None and to_name != '':
949
raise BzrError("destination %r is not a versioned directory" % to_name)
950
to_dir_ie = inv[to_dir_id]
951
if to_dir_ie.kind != 'directory':
952
raise BzrError("destination %r is not a directory" % to_abs)
954
to_idpath = inv.get_idpath(to_dir_id)
957
if not self.has_filename(f):
958
raise BzrError("%r does not exist in working tree" % f)
959
f_id = inv.path2id(f)
961
raise BzrError("%r is not versioned" % f)
962
name_tail = splitpath(f)[-1]
963
dest_path = pathjoin(to_name, name_tail)
964
if self.has_filename(dest_path):
965
raise BzrError("destination %r already exists" % dest_path)
966
if f_id in to_idpath:
967
raise BzrError("can't move %r to a subdirectory of itself" % f)
969
# OK, so there's a race here, it's possible that someone will
970
# create a file in this interval and then the rename might be
971
# left half-done. But we should have caught most problems.
972
orig_inv = deepcopy(self.inventory)
975
name_tail = splitpath(f)[-1]
976
dest_path = pathjoin(to_name, name_tail)
977
result.append((f, dest_path))
978
inv.rename(inv.path2id(f), to_dir_id, name_tail)
980
rename(self.abspath(f), self.abspath(dest_path))
982
raise BzrError("failed to rename %r to %r: %s" %
983
(f, dest_path, e[1]),
984
["rename rolled back"])
986
# restore the inventory on error
987
self._set_inventory(orig_inv)
989
self._write_inventory(inv)
993
def rename_one(self, from_rel, to_rel):
996
This can change the directory or the filename or both.
999
if not self.has_filename(from_rel):
1000
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1001
if self.has_filename(to_rel):
1002
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1004
file_id = inv.path2id(from_rel)
1006
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1008
entry = inv[file_id]
1009
from_parent = entry.parent_id
1010
from_name = entry.name
1012
if inv.path2id(to_rel):
1013
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1015
to_dir, to_tail = os.path.split(to_rel)
1016
to_dir_id = inv.path2id(to_dir)
1017
if to_dir_id == None and to_dir != '':
1018
raise BzrError("can't determine destination directory id for %r" % to_dir)
1020
mutter("rename_one:")
1021
mutter(" file_id {%s}" % file_id)
1022
mutter(" from_rel %r" % from_rel)
1023
mutter(" to_rel %r" % to_rel)
1024
mutter(" to_dir %r" % to_dir)
1025
mutter(" to_dir_id {%s}" % to_dir_id)
1027
inv.rename(file_id, to_dir_id, to_tail)
1029
from_abs = self.abspath(from_rel)
1030
to_abs = self.abspath(to_rel)
1032
rename(from_abs, to_abs)
1034
inv.rename(file_id, from_parent, from_name)
1035
raise BzrError("failed to rename %r to %r: %s"
1036
% (from_abs, to_abs, e[1]),
1037
["rename rolled back"])
1038
self._write_inventory(inv)
1042
"""Return all unknown files.
1044
These are files in the working directory that are not versioned or
1045
control files or ignored.
1047
for subp in self.extras():
1048
if not self.is_ignored(subp):
1051
@deprecated_method(zero_eight)
1052
def iter_conflicts(self):
1053
"""List all files in the tree that have text or content conflicts.
1054
DEPRECATED. Use conflicts instead."""
1055
return self._iter_conflicts()
1057
def _iter_conflicts(self):
1059
for info in self.list_files():
1061
stem = get_conflicted_stem(path)
1064
if stem not in conflicted:
1065
conflicted.add(stem)
1069
def pull(self, source, overwrite=False, stop_revision=None):
1070
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1073
pp = ProgressPhase("Pull phase", 2, top_pb)
1075
old_revision_history = self.branch.revision_history()
1076
basis_tree = self.basis_tree()
1077
count = self.branch.pull(source, overwrite, stop_revision)
1078
new_revision_history = self.branch.revision_history()
1079
if new_revision_history != old_revision_history:
1081
if len(old_revision_history):
1082
other_revision = old_revision_history[-1]
1084
other_revision = None
1085
repository = self.branch.repository
1086
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1088
new_basis_tree = self.branch.basis_tree()
1089
merge_inner(self.branch,
1096
# TODO - dedup parents list with things merged by pull ?
1097
# reuse the revisiontree we merged against to set the new
1099
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1100
# we have to pull the merge trees out again, because
1101
# merge_inner has set the ids. - this corner is not yet
1102
# layered well enough to prevent double handling.
1103
merges = self.get_parent_ids()[1:]
1104
parent_trees.extend([
1105
(parent, repository.revision_tree(parent)) for
1107
self.set_parent_trees(parent_trees)
1114
"""Yield all unknown files in this WorkingTree.
1116
If there are any unknown directories then only the directory is
1117
returned, not all its children. But if there are unknown files
1118
under a versioned subdirectory, they are returned.
1120
Currently returned depth-first, sorted by name within directories.
1122
## TODO: Work from given directory downwards
1123
for path, dir_entry in self.inventory.directories():
1124
# mutter("search for unknowns in %r", path)
1125
dirabs = self.abspath(path)
1126
if not isdir(dirabs):
1127
# e.g. directory deleted
1131
for subf in os.listdir(dirabs):
1134
if subf not in dir_entry.children:
1135
subf_norm, can_access = osutils.normalized_filename(subf)
1136
if subf_norm != subf and can_access:
1137
if subf_norm not in dir_entry.children:
1138
fl.append(subf_norm)
1144
subp = pathjoin(path, subf)
1147
def _translate_ignore_rule(self, rule):
1148
"""Translate a single ignore rule to a regex.
1150
There are two types of ignore rules. Those that do not contain a / are
1151
matched against the tail of the filename (that is, they do not care
1152
what directory the file is in.) Rules which do contain a slash must
1153
match the entire path. As a special case, './' at the start of the
1154
string counts as a slash in the string but is removed before matching
1155
(e.g. ./foo.c, ./src/foo.c)
1157
:return: The translated regex.
1159
if rule[:2] in ('./', '.\\'):
1161
result = fnmatch.translate(rule[2:])
1162
elif '/' in rule or '\\' in rule:
1164
result = fnmatch.translate(rule)
1166
# default rule style.
1167
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1168
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1169
return "(" + result + ")"
1171
def _combine_ignore_rules(self, rules):
1172
"""Combine a list of ignore rules into a single regex object.
1174
Each individual rule is combined with | to form a big regex, which then
1175
has $ added to it to form something like ()|()|()$. The group index for
1176
each subregex's outermost group is placed in a dictionary mapping back
1177
to the rule. This allows quick identification of the matching rule that
1179
:return: a list of the compiled regex and the matching-group index
1180
dictionaries. We return a list because python complains if you try to
1181
combine more than 100 regexes.
1186
translated_rules = []
1188
translated_rule = self._translate_ignore_rule(rule)
1189
compiled_rule = re.compile(translated_rule)
1190
groups[next_group] = rule
1191
next_group += compiled_rule.groups
1192
translated_rules.append(translated_rule)
1193
if next_group == 99:
1194
result.append((re.compile("|".join(translated_rules)), groups))
1197
translated_rules = []
1198
if len(translated_rules):
1199
result.append((re.compile("|".join(translated_rules)), groups))
1202
def ignored_files(self):
1203
"""Yield list of PATH, IGNORE_PATTERN"""
1204
for subp in self.extras():
1205
pat = self.is_ignored(subp)
1209
def get_ignore_list(self):
1210
"""Return list of ignore patterns.
1212
Cached in the Tree object after the first call.
1214
ignoreset = getattr(self, '_ignoreset', None)
1215
if ignoreset is not None:
1218
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1219
ignore_globs.update(ignores.get_runtime_ignores())
1221
ignore_globs.update(ignores.get_user_ignores())
1223
if self.has_filename(bzrlib.IGNORE_FILENAME):
1224
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1226
ignore_globs.update(ignores.parse_ignore_file(f))
1230
self._ignoreset = ignore_globs
1231
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1234
def _get_ignore_rules_as_regex(self):
1235
"""Return a regex of the ignore rules and a mapping dict.
1237
:return: (ignore rules compiled regex, dictionary mapping rule group
1238
indices to original rule.)
1240
if getattr(self, '_ignoreset', None) is None:
1241
self.get_ignore_list()
1242
return self._ignore_regex
1244
def is_ignored(self, filename):
1245
r"""Check whether the filename matches an ignore pattern.
1247
Patterns containing '/' or '\' need to match the whole path;
1248
others match against only the last component.
1250
If the file is ignored, returns the pattern which caused it to
1251
be ignored, otherwise None. So this can simply be used as a
1252
boolean if desired."""
1254
# TODO: Use '**' to match directories, and other extended
1255
# globbing stuff from cvs/rsync.
1257
# XXX: fnmatch is actually not quite what we want: it's only
1258
# approximately the same as real Unix fnmatch, and doesn't
1259
# treat dotfiles correctly and allows * to match /.
1260
# Eventually it should be replaced with something more
1263
rules = self._get_ignore_rules_as_regex()
1264
for regex, mapping in rules:
1265
match = regex.match(filename)
1266
if match is not None:
1267
# one or more of the groups in mapping will have a non-None
1269
groups = match.groups()
1270
rules = [mapping[group] for group in
1271
mapping if groups[group] is not None]
1275
def kind(self, file_id):
1276
return file_kind(self.id2abspath(file_id))
1279
def last_revision(self):
1280
"""Return the last revision id of this working tree.
1282
In early branch formats this was == the branch last_revision,
1283
but that cannot be relied upon - for working tree operations,
1284
always use tree.last_revision().
1286
return self.branch.last_revision()
1288
def is_locked(self):
1289
return self._control_files.is_locked()
1291
def lock_read(self):
1292
"""See Branch.lock_read, and WorkingTree.unlock."""
1293
self.branch.lock_read()
1295
return self._control_files.lock_read()
1297
self.branch.unlock()
1300
def lock_write(self):
1301
"""See Branch.lock_write, and WorkingTree.unlock."""
1302
self.branch.lock_write()
1304
return self._control_files.lock_write()
1306
self.branch.unlock()
1309
def get_physical_lock_status(self):
1310
return self._control_files.get_physical_lock_status()
1312
def _basis_inventory_name(self):
1313
return 'basis-inventory'
1316
def set_last_revision(self, new_revision):
1317
"""Change the last revision in the working tree."""
1318
if self._change_last_revision(new_revision):
1319
self._cache_basis_inventory(new_revision)
1321
def _change_last_revision(self, new_revision):
1322
"""Template method part of set_last_revision to perform the change.
1324
This is used to allow WorkingTree3 instances to not affect branch
1325
when their last revision is set.
1327
if new_revision is None:
1328
self.branch.set_revision_history([])
1331
self.branch.generate_revision_history(new_revision)
1332
except errors.NoSuchRevision:
1333
# not present in the repo - dont try to set it deeper than the tip
1334
self.branch.set_revision_history([new_revision])
1337
def _cache_basis_inventory(self, new_revision):
1338
"""Cache new_revision as the basis inventory."""
1339
# TODO: this should allow the ready-to-use inventory to be passed in,
1340
# as commit already has that ready-to-use [while the format is the
1343
# this double handles the inventory - unpack and repack -
1344
# but is easier to understand. We can/should put a conditional
1345
# in here based on whether the inventory is in the latest format
1346
# - perhaps we should repack all inventories on a repository
1348
# the fast path is to copy the raw xml from the repository. If the
1349
# xml contains 'revision_id="', then we assume the right
1350
# revision_id is set. We must check for this full string, because a
1351
# root node id can legitimately look like 'revision_id' but cannot
1353
xml = self.branch.repository.get_inventory_xml(new_revision)
1354
if not 'revision_id="' in xml.split('\n', 1)[0]:
1355
inv = self.branch.repository.deserialise_inventory(
1357
inv.revision_id = new_revision
1358
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1359
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1360
path = self._basis_inventory_name()
1362
self._control_files.put(path, sio)
1363
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1366
def read_basis_inventory(self):
1367
"""Read the cached basis inventory."""
1368
path = self._basis_inventory_name()
1369
return self._control_files.get(path).read()
1372
def read_working_inventory(self):
1373
"""Read the working inventory."""
1374
# ElementTree does its own conversion from UTF-8, so open in
1376
result = bzrlib.xml5.serializer_v5.read_inventory(
1377
self._control_files.get('inventory'))
1378
self._set_inventory(result)
1382
def remove(self, files, verbose=False, to_file=None):
1383
"""Remove nominated files from the working inventory..
1385
This does not remove their text. This does not run on XXX on what? RBC
1387
TODO: Refuse to remove modified files unless --force is given?
1389
TODO: Do something useful with directories.
1391
TODO: Should this remove the text or not? Tough call; not
1392
removing may be useful and the user can just use use rm, and
1393
is the opposite of add. Removing it is consistent with most
1394
other tools. Maybe an option.
1396
## TODO: Normalize names
1397
## TODO: Remove nested loops; better scalability
1398
if isinstance(files, basestring):
1401
inv = self.inventory
1403
# do this before any modifications
1405
fid = inv.path2id(f)
1407
# TODO: Perhaps make this just a warning, and continue?
1408
# This tends to happen when
1409
raise NotVersionedError(path=f)
1411
# having remove it, it must be either ignored or unknown
1412
if self.is_ignored(f):
1416
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1419
self._write_inventory(inv)
1422
def revert(self, filenames, old_tree=None, backups=True,
1423
pb=DummyProgress()):
1424
from transform import revert
1425
from conflicts import resolve
1426
if old_tree is None:
1427
old_tree = self.basis_tree()
1428
conflicts = revert(self, old_tree, filenames, backups, pb)
1429
if not len(filenames):
1430
self.set_pending_merges([])
1433
resolve(self, filenames, ignore_misses=True)
1436
# XXX: This method should be deprecated in favour of taking in a proper
1437
# new Inventory object.
1439
def set_inventory(self, new_inventory_list):
1440
from bzrlib.inventory import (Inventory,
1445
inv = Inventory(self.get_root_id())
1446
for path, file_id, parent, kind in new_inventory_list:
1447
name = os.path.basename(path)
1450
# fixme, there should be a factory function inv,add_??
1451
if kind == 'directory':
1452
inv.add(InventoryDirectory(file_id, name, parent))
1453
elif kind == 'file':
1454
inv.add(InventoryFile(file_id, name, parent))
1455
elif kind == 'symlink':
1456
inv.add(InventoryLink(file_id, name, parent))
1458
raise BzrError("unknown kind %r" % kind)
1459
self._write_inventory(inv)
1462
def set_root_id(self, file_id):
1463
"""Set the root id for this tree."""
1464
inv = self.read_working_inventory()
1465
orig_root_id = inv.root.file_id
1466
del inv._byid[inv.root.file_id]
1467
inv.root.file_id = file_id
1468
inv._byid[inv.root.file_id] = inv.root
1471
if entry.parent_id == orig_root_id:
1472
entry.parent_id = inv.root.file_id
1473
self._write_inventory(inv)
1476
"""See Branch.unlock.
1478
WorkingTree locking just uses the Branch locking facilities.
1479
This is current because all working trees have an embedded branch
1480
within them. IF in the future, we were to make branch data shareable
1481
between multiple working trees, i.e. via shared storage, then we
1482
would probably want to lock both the local tree, and the branch.
1484
raise NotImplementedError(self.unlock)
1488
"""Update a working tree along its branch.
1490
This will update the branch if its bound too, which means we have multiple trees involved:
1491
The new basis tree of the master.
1492
The old basis tree of the branch.
1493
The old basis tree of the working tree.
1494
The current working tree state.
1495
pathologically all three may be different, and non ancestors of each other.
1496
Conceptually we want to:
1497
Preserve the wt.basis->wt.state changes
1498
Transform the wt.basis to the new master basis.
1499
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1500
Restore the wt.basis->wt.state changes.
1502
There isn't a single operation at the moment to do that, so we:
1503
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1504
Do a 'normal' merge of the old branch basis if it is relevant.
1506
old_tip = self.branch.update()
1509
if self.last_revision() != self.branch.last_revision():
1510
# merge tree state up to new branch tip.
1511
basis = self.basis_tree()
1512
to_tree = self.branch.basis_tree()
1513
result += merge_inner(self.branch,
1517
self.set_last_revision(self.branch.last_revision())
1518
# TODO - dedup parents list with things merged by pull ?
1519
# reuse the tree we've updated to to set the basis:
1520
parent_trees = [(self.branch.last_revision(), to_tree)]
1521
merges = self.get_parent_ids()[1:]
1522
# pull the other trees out of the repository. This could be
1523
# better expressed - for instance by inserting a parent, and
1524
# that would remove duplication.
1525
parent_trees.extend([
1526
(parent, self.branch.repository.revision_tree(parent)) for
1528
self.set_parent_trees(parent_trees)
1529
if old_tip and old_tip != self.last_revision():
1530
# our last revision was not the prior branch last revision
1531
# and we have converted that last revision to a pending merge.
1532
# base is somewhere between the branch tip now
1533
# and the now pending merge
1534
from bzrlib.revision import common_ancestor
1536
base_rev_id = common_ancestor(self.branch.last_revision(),
1538
self.branch.repository)
1539
except errors.NoCommonAncestor:
1541
base_tree = self.branch.repository.revision_tree(base_rev_id)
1542
other_tree = self.branch.repository.revision_tree(old_tip)
1543
result += merge_inner(self.branch,
1549
if old_tip is not None:
1550
self.add_pending_merge(old_tip)
1553
def _write_inventory(self, inv):
1554
"""Write inventory as the current inventory."""
1556
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1558
self._control_files.put('inventory', sio)
1559
self._set_inventory(inv)
1560
mutter('wrote working inventory')
1562
def set_conflicts(self, arg):
1563
raise UnsupportedOperation(self.set_conflicts, self)
1565
def add_conflicts(self, arg):
1566
raise UnsupportedOperation(self.add_conflicts, self)
1569
def conflicts(self):
1570
conflicts = ConflictList()
1571
for conflicted in self._iter_conflicts():
1574
if file_kind(self.abspath(conflicted)) != "file":
1576
except errors.NoSuchFile:
1579
for suffix in ('.THIS', '.OTHER'):
1581
kind = file_kind(self.abspath(conflicted+suffix))
1584
except errors.NoSuchFile:
1588
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1589
conflicts.append(Conflict.factory(ctype, path=conflicted,
1590
file_id=self.path2id(conflicted)))
1594
class WorkingTree2(WorkingTree):
1595
"""This is the Format 2 working tree.
1597
This was the first weave based working tree.
1598
- uses os locks for locking.
1599
- uses the branch last-revision.
1603
# we share control files:
1604
if self._hashcache.needs_write and self._control_files._lock_count==3:
1605
self._hashcache.write()
1606
# reverse order of locking.
1608
return self._control_files.unlock()
1610
self.branch.unlock()
1613
class WorkingTree3(WorkingTree):
1614
"""This is the Format 3 working tree.
1616
This differs from the base WorkingTree by:
1617
- having its own file lock
1618
- having its own last-revision property.
1620
This is new in bzr 0.8
1624
def last_revision(self):
1625
"""See WorkingTree.last_revision."""
1627
return self._control_files.get_utf8('last-revision').read()
1631
def _change_last_revision(self, revision_id):
1632
"""See WorkingTree._change_last_revision."""
1633
if revision_id is None or revision_id == NULL_REVISION:
1635
self._control_files._transport.delete('last-revision')
1636
except errors.NoSuchFile:
1640
self._control_files.put_utf8('last-revision', revision_id)
1644
def set_conflicts(self, conflicts):
1645
self._put_rio('conflicts', conflicts.to_stanzas(),
1649
def add_conflicts(self, new_conflicts):
1650
conflict_set = set(self.conflicts())
1651
conflict_set.update(set(list(new_conflicts)))
1652
self.set_conflicts(ConflictList(sorted(conflict_set,
1653
key=Conflict.sort_key)))
1656
def conflicts(self):
1658
confile = self._control_files.get('conflicts')
1660
return ConflictList()
1662
if confile.next() != CONFLICT_HEADER_1 + '\n':
1663
raise ConflictFormatError()
1664
except StopIteration:
1665
raise ConflictFormatError()
1666
return ConflictList.from_stanzas(RioReader(confile))
1669
if self._hashcache.needs_write and self._control_files._lock_count==1:
1670
self._hashcache.write()
1671
# reverse order of locking.
1673
return self._control_files.unlock()
1675
self.branch.unlock()
1678
def get_conflicted_stem(path):
1679
for suffix in CONFLICT_SUFFIXES:
1680
if path.endswith(suffix):
1681
return path[:-len(suffix)]
1683
@deprecated_function(zero_eight)
1684
def is_control_file(filename):
1685
"""See WorkingTree.is_control_filename(filename)."""
1686
## FIXME: better check
1687
filename = normpath(filename)
1688
while filename != '':
1689
head, tail = os.path.split(filename)
1690
## mutter('check %r for control file' % ((head, tail),))
1693
if filename == head:
1699
class WorkingTreeFormat(object):
1700
"""An encapsulation of the initialization and open routines for a format.
1702
Formats provide three things:
1703
* An initialization routine,
1707
Formats are placed in an dict by their format string for reference
1708
during workingtree opening. Its not required that these be instances, they
1709
can be classes themselves with class methods - it simply depends on
1710
whether state is needed for a given format or not.
1712
Once a format is deprecated, just deprecate the initialize and open
1713
methods on the format class. Do not deprecate the object, as the
1714
object will be created every time regardless.
1717
_default_format = None
1718
"""The default format used for new trees."""
1721
"""The known formats."""
1724
def find_format(klass, a_bzrdir):
1725
"""Return the format for the working tree object in a_bzrdir."""
1727
transport = a_bzrdir.get_workingtree_transport(None)
1728
format_string = transport.get("format").read()
1729
return klass._formats[format_string]
1731
raise errors.NoWorkingTree(base=transport.base)
1733
raise errors.UnknownFormatError(format=format_string)
1736
def get_default_format(klass):
1737
"""Return the current default format."""
1738
return klass._default_format
1740
def get_format_string(self):
1741
"""Return the ASCII format string that identifies this format."""
1742
raise NotImplementedError(self.get_format_string)
1744
def get_format_description(self):
1745
"""Return the short description for this format."""
1746
raise NotImplementedError(self.get_format_description)
1748
def is_supported(self):
1749
"""Is this format supported?
1751
Supported formats can be initialized and opened.
1752
Unsupported formats may not support initialization or committing or
1753
some other features depending on the reason for not being supported.
1758
def register_format(klass, format):
1759
klass._formats[format.get_format_string()] = format
1762
def set_default_format(klass, format):
1763
klass._default_format = format
1766
def unregister_format(klass, format):
1767
assert klass._formats[format.get_format_string()] is format
1768
del klass._formats[format.get_format_string()]
1772
class WorkingTreeFormat2(WorkingTreeFormat):
1773
"""The second working tree format.
1775
This format modified the hash cache from the format 1 hash cache.
1778
def get_format_description(self):
1779
"""See WorkingTreeFormat.get_format_description()."""
1780
return "Working tree format 2"
1782
def stub_initialize_remote(self, control_files):
1783
"""As a special workaround create critical control files for a remote working tree
1785
This ensures that it can later be updated and dealt with locally,
1786
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1787
no working tree. (See bug #43064).
1791
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1793
control_files.put('inventory', sio)
1795
control_files.put_utf8('pending-merges', '')
1798
def initialize(self, a_bzrdir, revision_id=None):
1799
"""See WorkingTreeFormat.initialize()."""
1800
if not isinstance(a_bzrdir.transport, LocalTransport):
1801
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1802
branch = a_bzrdir.open_branch()
1803
if revision_id is not None:
1806
revision_history = branch.revision_history()
1808
position = revision_history.index(revision_id)
1810
raise errors.NoSuchRevision(branch, revision_id)
1811
branch.set_revision_history(revision_history[:position + 1])
1814
revision = branch.last_revision()
1816
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1822
wt._write_inventory(inv)
1823
wt.set_root_id(inv.root.file_id)
1824
basis_tree = branch.repository.revision_tree(revision)
1825
wt.set_parent_trees([(revision, basis_tree)])
1826
build_tree(basis_tree, wt)
1830
super(WorkingTreeFormat2, self).__init__()
1831
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1833
def open(self, a_bzrdir, _found=False):
1834
"""Return the WorkingTree object for a_bzrdir
1836
_found is a private parameter, do not use it. It is used to indicate
1837
if format probing has already been done.
1840
# we are being called directly and must probe.
1841
raise NotImplementedError
1842
if not isinstance(a_bzrdir.transport, LocalTransport):
1843
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1844
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1850
class WorkingTreeFormat3(WorkingTreeFormat):
1851
"""The second working tree format updated to record a format marker.
1854
- exists within a metadir controlling .bzr
1855
- includes an explicit version marker for the workingtree control
1856
files, separate from the BzrDir format
1857
- modifies the hash cache format
1859
- uses a LockDir to guard access for writes.
1862
def get_format_string(self):
1863
"""See WorkingTreeFormat.get_format_string()."""
1864
return "Bazaar-NG Working Tree format 3"
1866
def get_format_description(self):
1867
"""See WorkingTreeFormat.get_format_description()."""
1868
return "Working tree format 3"
1870
_lock_file_name = 'lock'
1871
_lock_class = LockDir
1873
def _open_control_files(self, a_bzrdir):
1874
transport = a_bzrdir.get_workingtree_transport(None)
1875
return LockableFiles(transport, self._lock_file_name,
1878
def initialize(self, a_bzrdir, revision_id=None):
1879
"""See WorkingTreeFormat.initialize().
1881
revision_id allows creating a working tree at a different
1882
revision than the branch is at.
1884
if not isinstance(a_bzrdir.transport, LocalTransport):
1885
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1886
transport = a_bzrdir.get_workingtree_transport(self)
1887
control_files = self._open_control_files(a_bzrdir)
1888
control_files.create_lock()
1889
control_files.lock_write()
1890
control_files.put_utf8('format', self.get_format_string())
1891
branch = a_bzrdir.open_branch()
1892
if revision_id is None:
1893
revision_id = branch.last_revision()
1895
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1901
_control_files=control_files)
1904
wt._write_inventory(inv)
1905
wt.set_root_id(inv.root.file_id)
1906
basis_tree = branch.repository.revision_tree(revision_id)
1907
wt.set_parent_trees([(revision_id, basis_tree)])
1908
build_tree(basis_tree, wt)
1911
control_files.unlock()
1915
super(WorkingTreeFormat3, self).__init__()
1916
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1918
def open(self, a_bzrdir, _found=False):
1919
"""Return the WorkingTree object for a_bzrdir
1921
_found is a private parameter, do not use it. It is used to indicate
1922
if format probing has already been done.
1925
# we are being called directly and must probe.
1926
raise NotImplementedError
1927
if not isinstance(a_bzrdir.transport, LocalTransport):
1928
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1929
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1931
def _open(self, a_bzrdir, control_files):
1932
"""Open the tree itself.
1934
:param a_bzrdir: the dir for the tree.
1935
:param control_files: the control files for the tree.
1937
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1941
_control_files=control_files)
1944
return self.get_format_string()
1947
# formats which have no format string are not discoverable
1948
# and not independently creatable, so are not registered.
1949
__default_format = WorkingTreeFormat3()
1950
WorkingTreeFormat.register_format(__default_format)
1951
WorkingTreeFormat.set_default_format(__default_format)
1952
_legacy_formats = [WorkingTreeFormat2(),
1956
class WorkingTreeTestProviderAdapter(object):
1957
"""A tool to generate a suite testing multiple workingtree formats at once.
1959
This is done by copying the test once for each transport and injecting
1960
the transport_server, transport_readonly_server, and workingtree_format
1961
classes into each copy. Each copy is also given a new id() to make it
1965
def __init__(self, transport_server, transport_readonly_server, formats):
1966
self._transport_server = transport_server
1967
self._transport_readonly_server = transport_readonly_server
1968
self._formats = formats
1970
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1971
"""Clone test for adaption."""
1972
new_test = deepcopy(test)
1973
new_test.transport_server = self._transport_server
1974
new_test.transport_readonly_server = self._transport_readonly_server
1975
new_test.bzrdir_format = bzrdir_format
1976
new_test.workingtree_format = workingtree_format
1977
def make_new_test_id():
1978
new_id = "%s(%s)" % (test.id(), variation)
1979
return lambda: new_id
1980
new_test.id = make_new_test_id()
1983
def adapt(self, test):
1984
from bzrlib.tests import TestSuite
1985
result = TestSuite()
1986
for workingtree_format, bzrdir_format in self._formats:
1987
new_test = self._clone_test(
1990
workingtree_format, workingtree_format.__class__.__name__)
1991
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
