1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
216
class WorkingTree(bzrlib.tree.Tree):
217
"""Working copy tree.
219
The inventory is held in the `Branch` working-inventory, and the
220
files are in a directory on disk.
222
It is possible for a `WorkingTree` to have a filename which is
223
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
256
from bzrlib.hashcache import HashCache
257
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
284
# update the whole cache up front and write to disk if anything changed;
285
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
293
# is this scan needed ? it makes things kinda slow.
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
assert inv.root is not None
326
self._inventory = inv
327
self.path2id = self._inventory.path2id
329
def is_control_filename(self, filename):
330
"""True if filename is the name of a control file in this tree.
332
:param filename: A filename within the tree. This is a relative path
333
from the root of this tree.
335
This is true IF and ONLY IF the filename is part of the meta data
336
that bzr controls in this tree. I.E. a random .bzr directory placed
337
on disk will not be a control file for this tree.
339
return self.bzrdir.is_control_filename(filename)
342
def open(path=None, _unsupported=False):
343
"""Open an existing working tree at path.
347
path = os.path.getcwdu()
348
control = bzrdir.BzrDir.open(path, _unsupported)
349
return control.open_workingtree(_unsupported)
352
def open_containing(path=None):
353
"""Open an existing working tree which has its root about path.
355
This probes for a working tree at path and searches upwards from there.
357
Basically we keep looking up until we find the control directory or
358
run into /. If there isn't one, raises NotBranchError.
359
TODO: give this a new exception.
360
If there is one, it is returned, along with the unused portion of path.
362
:return: The WorkingTree that contains 'path', and the rest of path
365
path = osutils.getcwd()
366
control, relpath = bzrdir.BzrDir.open_containing(path)
368
return control.open_workingtree(), relpath
371
def open_downlevel(path=None):
372
"""Open an unsupported working tree.
374
Only intended for advanced situations like upgrading part of a bzrdir.
376
return WorkingTree.open(path, _unsupported=True)
379
"""Iterate through file_ids for this tree.
381
file_ids are in a WorkingTree if they are in the working inventory
382
and the working file exists.
384
inv = self._inventory
385
for path, ie in inv.iter_entries():
386
if osutils.lexists(self.abspath(path)):
390
return "<%s of %s>" % (self.__class__.__name__,
391
getattr(self, 'basedir', None))
393
def abspath(self, filename):
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling repository.revision_tree(None).
402
revision_id = self.last_revision()
403
if revision_id is not None:
405
xml = self.read_basis_inventory()
406
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
407
inv.root.revision = revision_id
410
if inv is not None and inv.revision_id == revision_id:
411
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
413
# FIXME? RBC 20060403 should we cache the inventory here ?
415
return self.branch.repository.revision_tree(revision_id)
416
except errors.RevisionNotPresent:
417
# the basis tree *may* be a ghost or a low level error may have
418
# occured. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(None)
426
@deprecated_method(zero_eight)
427
def create(branch, directory):
428
"""Create a workingtree for branch at directory.
430
If existing_directory already exists it must have a .bzr directory.
431
If it does not exist, it will be created.
433
This returns a new WorkingTree object for the new checkout.
435
TODO FIXME RBC 20060124 when we have checkout formats in place this
436
should accept an optional revisionid to checkout [and reject this if
437
checking out into the same dir as a pre-checkout-aware branch format.]
439
XXX: When BzrDir is present, these should be created through that
442
warnings.warn('delete WorkingTree.create', stacklevel=3)
443
transport = get_transport(directory)
444
if branch.bzrdir.root_transport.base == transport.base:
446
return branch.bzrdir.create_workingtree()
447
# different directory,
448
# create a branch reference
449
# and now a working tree.
450
raise NotImplementedError
453
@deprecated_method(zero_eight)
454
def create_standalone(directory):
455
"""Create a checkout and a branch and a repo at directory.
457
Directory must exist and be empty.
459
please use BzrDir.create_standalone_workingtree
461
return bzrdir.BzrDir.create_standalone_workingtree(directory)
463
def relpath(self, path):
464
"""Return the local path portion from a given path.
466
The path may be absolute or relative. If its a relative path it is
467
interpreted relative to the python current working directory.
469
return relpath(self.basedir, path)
471
def has_filename(self, filename):
472
return osutils.lexists(self.abspath(filename))
474
def get_file(self, file_id):
475
return self.get_file_byname(self.id2path(file_id))
477
def get_file_text(self, file_id):
478
return self.get_file(file_id).read()
480
def get_file_byname(self, filename):
481
return file(self.abspath(filename), 'rb')
483
def get_parent_ids(self):
484
"""See Tree.get_parent_ids.
486
This implementation reads the pending merges list and last_revision
487
value and uses that to decide what the parents list should be.
489
last_rev = self.last_revision()
494
other_parents = self.pending_merges()
495
return parents + other_parents
497
def get_root_id(self):
498
"""Return the id of this trees root"""
499
inv = self.read_working_inventory()
500
return inv.root.file_id
502
def _get_store_filename(self, file_id):
503
## XXX: badly named; this is not in the store at all
504
return self.abspath(self.id2path(file_id))
507
def clone(self, to_bzrdir, revision_id=None, basis=None):
508
"""Duplicate this working tree into to_bzr, including all state.
510
Specifically modified files are kept as modified, but
511
ignored and unknown files are discarded.
513
If you want to make a new line of development, see bzrdir.sprout()
516
If not None, the cloned tree will have its last revision set to
517
revision, and and difference between the source trees last revision
518
and this one merged in.
521
If not None, a closer copy of a tree which may have some files in
522
common, and which file content should be preferentially copied from.
524
# assumes the target bzr dir format is compatible.
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id)
530
def copy_content_into(self, tree, revision_id=None):
531
"""Copy the current content and user files of this tree into tree."""
532
if revision_id is None:
533
transform_tree(tree, self)
535
# TODO now merge from tree.last_revision to revision (to preserve
536
# user local changes)
537
transform_tree(tree, self)
538
tree.set_parent_ids([revision_id])
541
def commit(self, message=None, revprops=None, *args, **kwargs):
542
# avoid circular imports
543
from bzrlib.commit import Commit
546
if not 'branch-nick' in revprops:
547
revprops['branch-nick'] = self.branch.nick
548
# args for wt.commit start at message from the Commit.commit method,
549
# but with branch a kwarg now, passing in args as is results in the
550
#message being used for the branch
551
args = (DEPRECATED_PARAMETER, message, ) + args
552
committed_id = Commit().commit( working_tree=self, revprops=revprops,
554
self._set_inventory(self.read_working_inventory())
557
def id2abspath(self, file_id):
558
return self.abspath(self.id2path(file_id))
560
def has_id(self, file_id):
561
# files that have been deleted are excluded
562
inv = self._inventory
563
if not inv.has_id(file_id):
565
path = inv.id2path(file_id)
566
return osutils.lexists(self.abspath(path))
568
def has_or_had_id(self, file_id):
569
if file_id == self.inventory.root.file_id:
571
return self.inventory.has_id(file_id)
573
__contains__ = has_id
575
def get_file_size(self, file_id):
576
return os.path.getsize(self.id2abspath(file_id))
579
def get_file_sha1(self, file_id, path=None):
581
path = self._inventory.id2path(file_id)
582
return self._hashcache.get_sha1(path)
584
def get_file_mtime(self, file_id, path=None):
586
path = self._inventory.id2path(file_id)
587
return os.lstat(self.abspath(path)).st_mtime
589
if not supports_executable():
590
def is_executable(self, file_id, path=None):
591
return self._inventory[file_id].executable
593
def is_executable(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
mode = os.lstat(self.abspath(path)).st_mode
597
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
600
def add(self, files, ids=None):
601
"""Make files versioned.
603
Note that the command line normally calls smart_add instead,
604
which can automatically recurse.
606
This adds the files to the inventory, so that they will be
607
recorded by the next commit.
610
List of paths to add, relative to the base of the tree.
613
If set, use these instead of automatically generated ids.
614
Must be the same length as the list of files, but may
615
contain None for ids that are to be autogenerated.
617
TODO: Perhaps have an option to add the ids even if the files do
620
TODO: Perhaps callback with the ids and paths as they're added.
622
# TODO: Re-adding a file that is removed in the working copy
623
# should probably put it back with the previous ID.
624
if isinstance(files, basestring):
625
assert(ids is None or isinstance(ids, basestring))
631
ids = [None] * len(files)
633
assert(len(ids) == len(files))
635
inv = self.read_working_inventory()
636
for f,file_id in zip(files, ids):
637
if self.is_control_filename(f):
638
raise errors.ForbiddenControlFileError(filename=f)
643
raise BzrError("cannot add top-level %r" % f)
645
fullpath = normpath(self.abspath(f))
647
kind = file_kind(fullpath)
649
if e.errno == errno.ENOENT:
650
raise NoSuchFile(fullpath)
651
if not InventoryEntry.versionable_kind(kind):
652
raise errors.BadFileKindError(filename=f, kind=kind)
654
inv.add_path(f, kind=kind)
656
inv.add_path(f, kind=kind, file_id=file_id)
658
self._write_inventory(inv)
661
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
662
"""Add revision_id as a parent.
664
This is equivalent to retrieving the current list of parent ids
665
and setting the list to its value plus revision_id.
667
:param revision_id: The revision id to add to the parent list. It may
668
be a ghost revision as long as its not the first parent to be added,
669
or the allow_leftmost_as_ghost parameter is set True.
670
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
672
self.set_parent_ids(self.get_parent_ids() + [revision_id],
673
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
676
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
677
"""Add revision_id, tree tuple as a parent.
679
This is equivalent to retrieving the current list of parent trees
680
and setting the list to its value plus parent_tuple. See also
681
add_parent_tree_id - if you only have a parent id available it will be
682
simpler to use that api. If you have the parent already available, using
683
this api is preferred.
685
:param parent_tuple: The (revision id, tree) to add to the parent list.
686
If the revision_id is a ghost, pass None for the tree.
687
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
689
self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
690
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
693
def add_pending_merge(self, *revision_ids):
694
# TODO: Perhaps should check at this point that the
695
# history of the revision is actually present?
696
p = self.pending_merges()
697
existing_parents = self.get_parent_ids()
699
for rev_id in revision_ids:
702
if rev_id in existing_parents:
707
self.set_pending_merges(p)
710
def pending_merges(self):
711
"""Return a list of pending merges.
713
These are revisions that have been merged into the working
714
directory but not yet committed.
717
merges_file = self._control_files.get_utf8('pending-merges')
721
for l in merges_file.readlines():
722
p.append(l.rstrip('\n'))
726
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
727
"""Set the parent ids to revision_ids.
729
See also set_parent_trees. This api will try to retrieve the tree data
730
for each element of revision_ids from the trees repository. If you have
731
tree data already available, it is more efficient to use
732
set_parent_trees rather than set_parent_ids. set_parent_ids is however
733
an easier API to use.
735
:param revision_ids: The revision_ids to set as the parent ids of this
736
working tree. Any of these may be ghosts.
739
for rev_id in revision_ids:
742
(rev_id, self.branch.repository.revision_tree(rev_id)))
743
except errors.RevisionNotPresent:
744
trees.append((rev_id, None))
745
self.set_parent_trees(trees,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
749
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
"""Set the parents of the working tree.
752
:param parents_list: A list of (revision_id, tree) tuples.
753
If tree is None, then that element is treated as an unreachable
754
parent tree - i.e. a ghost.
756
if len(parents_list) > 0:
757
leftmost_id = parents_list[0][0]
758
if (not allow_leftmost_as_ghost and not
759
self.branch.repository.has_revision(leftmost_id)):
760
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
self.set_last_revision(leftmost_id)
763
self.set_last_revision(None)
764
merges = parents_list[1:]
765
self.set_pending_merges([revid for revid, tree in merges])
768
def set_pending_merges(self, rev_list):
769
if self.last_revision() is None:
770
new_last_list = rev_list[:1]
771
rev_list = rev_list[1:]
773
self.set_last_revision(new_last_list[0])
774
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
777
def set_merge_modified(self, modified_hashes):
779
for file_id, hash in modified_hashes.iteritems():
780
yield Stanza(file_id=file_id, hash=hash)
781
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
784
def _put_rio(self, filename, stanzas, header):
785
my_file = rio_file(stanzas, header)
786
self._control_files.put(filename, my_file)
789
def merge_modified(self):
791
hashfile = self._control_files.get('merge-hashes')
796
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
797
raise MergeModifiedFormatError()
798
except StopIteration:
799
raise MergeModifiedFormatError()
800
for s in RioReader(hashfile):
801
file_id = s.get("file_id")
802
if file_id not in self.inventory:
805
if hash == self.get_file_sha1(file_id):
806
merge_hashes[file_id] = hash
809
def get_symlink_target(self, file_id):
810
return os.readlink(self.id2abspath(file_id))
812
def file_class(self, filename):
813
if self.path2id(filename):
815
elif self.is_ignored(filename):
820
def list_files(self):
821
"""Recursively list all files as (path, class, kind, id, entry).
823
Lists, but does not descend into unversioned directories.
825
This does not include files that have been deleted in this
828
Skips the control directory.
830
inv = self._inventory
831
# Convert these into local objects to save lookup times
832
pathjoin = osutils.pathjoin
833
file_kind = osutils.file_kind
835
# transport.base ends in a slash, we want the piece
836
# between the last two slashes
837
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
839
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
841
# directory file_id, relative path, absolute path, reverse sorted children
842
children = os.listdir(self.basedir)
844
# jam 20060527 The kernel sized tree seems equivalent whether we
845
# use a deque and popleft to keep them sorted, or if we use a plain
846
# list and just reverse() them.
847
children = collections.deque(children)
848
stack = [(inv.root.file_id, u'', self.basedir, children)]
850
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
853
f = children.popleft()
854
## TODO: If we find a subdirectory with its own .bzr
855
## directory, then that is a separate tree and we
856
## should exclude it.
858
# the bzrdir for this tree
859
if transport_base_dir == f:
862
# we know that from_dir_relpath and from_dir_abspath never end in a slash
863
# and 'f' doesn't begin with one, we can do a string op, rather
864
# than the checks of pathjoin(), all relative paths will have an extra slash
866
fp = from_dir_relpath + '/' + f
869
fap = from_dir_abspath + '/' + f
871
f_ie = inv.get_child(from_dir_id, f)
874
elif self.is_ignored(fp[1:]):
877
# we may not have found this file, because of a unicode issue
878
f_norm, can_access = osutils.normalized_filename(f)
879
if f == f_norm or not can_access:
880
# No change, so treat this file normally
883
# this file can be accessed by a normalized path
884
# check again if it is versioned
885
# these lines are repeated here for performance
887
fp = from_dir_relpath + '/' + f
888
fap = from_dir_abspath + '/' + f
889
f_ie = inv.get_child(from_dir_id, f)
892
elif self.is_ignored(fp[1:]):
901
raise BzrCheckError("file %r entered as kind %r id %r, "
903
% (fap, f_ie.kind, f_ie.file_id, fk))
905
# make a last minute entry
907
yield fp[1:], c, fk, f_ie.file_id, f_ie
910
yield fp[1:], c, fk, None, fk_entries[fk]()
912
yield fp[1:], c, fk, None, TreeEntry()
915
if fk != 'directory':
918
# But do this child first
919
new_children = os.listdir(fap)
921
new_children = collections.deque(new_children)
922
stack.append((f_ie.file_id, fp, fap, new_children))
923
# Break out of inner loop, so that we start outer loop with child
926
# if we finished all children, pop it off the stack
931
def move(self, from_paths, to_name):
934
to_name must exist in the inventory.
936
If to_name exists and is a directory, the files are moved into
937
it, keeping their old names.
939
Note that to_name is only the last component of the new name;
940
this doesn't change the directory.
942
This returns a list of (from_path, to_path) pairs for each
946
## TODO: Option to move IDs only
947
assert not isinstance(from_paths, basestring)
949
to_abs = self.abspath(to_name)
950
if not isdir(to_abs):
951
raise BzrError("destination %r is not a directory" % to_abs)
952
if not self.has_filename(to_name):
953
raise BzrError("destination %r not in working directory" % to_abs)
954
to_dir_id = inv.path2id(to_name)
955
if to_dir_id == None and to_name != '':
956
raise BzrError("destination %r is not a versioned directory" % to_name)
957
to_dir_ie = inv[to_dir_id]
958
if to_dir_ie.kind != 'directory':
959
raise BzrError("destination %r is not a directory" % to_abs)
961
to_idpath = inv.get_idpath(to_dir_id)
964
if not self.has_filename(f):
965
raise BzrError("%r does not exist in working tree" % f)
966
f_id = inv.path2id(f)
968
raise BzrError("%r is not versioned" % f)
969
name_tail = splitpath(f)[-1]
970
dest_path = pathjoin(to_name, name_tail)
971
if self.has_filename(dest_path):
972
raise BzrError("destination %r already exists" % dest_path)
973
if f_id in to_idpath:
974
raise BzrError("can't move %r to a subdirectory of itself" % f)
976
# OK, so there's a race here, it's possible that someone will
977
# create a file in this interval and then the rename might be
978
# left half-done. But we should have caught most problems.
979
orig_inv = deepcopy(self.inventory)
982
name_tail = splitpath(f)[-1]
983
dest_path = pathjoin(to_name, name_tail)
984
result.append((f, dest_path))
985
inv.rename(inv.path2id(f), to_dir_id, name_tail)
987
rename(self.abspath(f), self.abspath(dest_path))
989
raise BzrError("failed to rename %r to %r: %s" %
990
(f, dest_path, e[1]),
991
["rename rolled back"])
993
# restore the inventory on error
994
self._set_inventory(orig_inv)
996
self._write_inventory(inv)
1000
def rename_one(self, from_rel, to_rel):
1003
This can change the directory or the filename or both.
1005
inv = self.inventory
1006
if not self.has_filename(from_rel):
1007
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1008
if self.has_filename(to_rel):
1009
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1011
file_id = inv.path2id(from_rel)
1013
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1015
entry = inv[file_id]
1016
from_parent = entry.parent_id
1017
from_name = entry.name
1019
if inv.path2id(to_rel):
1020
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1022
to_dir, to_tail = os.path.split(to_rel)
1023
to_dir_id = inv.path2id(to_dir)
1024
if to_dir_id == None and to_dir != '':
1025
raise BzrError("can't determine destination directory id for %r" % to_dir)
1027
mutter("rename_one:")
1028
mutter(" file_id {%s}" % file_id)
1029
mutter(" from_rel %r" % from_rel)
1030
mutter(" to_rel %r" % to_rel)
1031
mutter(" to_dir %r" % to_dir)
1032
mutter(" to_dir_id {%s}" % to_dir_id)
1034
inv.rename(file_id, to_dir_id, to_tail)
1036
from_abs = self.abspath(from_rel)
1037
to_abs = self.abspath(to_rel)
1039
rename(from_abs, to_abs)
1041
inv.rename(file_id, from_parent, from_name)
1042
raise BzrError("failed to rename %r to %r: %s"
1043
% (from_abs, to_abs, e[1]),
1044
["rename rolled back"])
1045
self._write_inventory(inv)
1049
"""Return all unknown files.
1051
These are files in the working directory that are not versioned or
1052
control files or ignored.
1054
for subp in self.extras():
1055
if not self.is_ignored(subp):
1058
@deprecated_method(zero_eight)
1059
def iter_conflicts(self):
1060
"""List all files in the tree that have text or content conflicts.
1061
DEPRECATED. Use conflicts instead."""
1062
return self._iter_conflicts()
1064
def _iter_conflicts(self):
1066
for info in self.list_files():
1068
stem = get_conflicted_stem(path)
1071
if stem not in conflicted:
1072
conflicted.add(stem)
1076
def pull(self, source, overwrite=False, stop_revision=None):
1077
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1080
pp = ProgressPhase("Pull phase", 2, top_pb)
1082
old_revision_history = self.branch.revision_history()
1083
basis_tree = self.basis_tree()
1084
count = self.branch.pull(source, overwrite, stop_revision)
1085
new_revision_history = self.branch.revision_history()
1086
if new_revision_history != old_revision_history:
1088
if len(old_revision_history):
1089
other_revision = old_revision_history[-1]
1091
other_revision = None
1092
repository = self.branch.repository
1093
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1095
new_basis_tree = self.branch.basis_tree()
1096
merge_inner(self.branch,
1103
# TODO - dedup parents list with things merged by pull ?
1104
# reuse the revisiontree we merged against to set the new
1106
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1107
# we have to pull the merge trees out again, because
1108
# merge_inner has set the ids. - this corner is not yet
1109
# layered well enough to prevent double handling.
1110
merges = self.get_parent_ids()[1:]
1111
parent_trees.extend([
1112
(parent, repository.revision_tree(parent)) for
1114
self.set_parent_trees(parent_trees)
1121
"""Yield all unknown files in this WorkingTree.
1123
If there are any unknown directories then only the directory is
1124
returned, not all its children. But if there are unknown files
1125
under a versioned subdirectory, they are returned.
1127
Currently returned depth-first, sorted by name within directories.
1129
## TODO: Work from given directory downwards
1130
for path, dir_entry in self.inventory.directories():
1131
# mutter("search for unknowns in %r", path)
1132
dirabs = self.abspath(path)
1133
if not isdir(dirabs):
1134
# e.g. directory deleted
1138
for subf in os.listdir(dirabs):
1141
if subf not in dir_entry.children:
1142
subf_norm, can_access = osutils.normalized_filename(subf)
1143
if subf_norm != subf and can_access:
1144
if subf_norm not in dir_entry.children:
1145
fl.append(subf_norm)
1151
subp = pathjoin(path, subf)
1154
def _translate_ignore_rule(self, rule):
1155
"""Translate a single ignore rule to a regex.
1157
There are two types of ignore rules. Those that do not contain a / are
1158
matched against the tail of the filename (that is, they do not care
1159
what directory the file is in.) Rules which do contain a slash must
1160
match the entire path. As a special case, './' at the start of the
1161
string counts as a slash in the string but is removed before matching
1162
(e.g. ./foo.c, ./src/foo.c)
1164
:return: The translated regex.
1166
if rule[:2] in ('./', '.\\'):
1168
result = fnmatch.translate(rule[2:])
1169
elif '/' in rule or '\\' in rule:
1171
result = fnmatch.translate(rule)
1173
# default rule style.
1174
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1175
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1176
return "(" + result + ")"
1178
def _combine_ignore_rules(self, rules):
1179
"""Combine a list of ignore rules into a single regex object.
1181
Each individual rule is combined with | to form a big regex, which then
1182
has $ added to it to form something like ()|()|()$. The group index for
1183
each subregex's outermost group is placed in a dictionary mapping back
1184
to the rule. This allows quick identification of the matching rule that
1186
:return: a list of the compiled regex and the matching-group index
1187
dictionaries. We return a list because python complains if you try to
1188
combine more than 100 regexes.
1193
translated_rules = []
1195
translated_rule = self._translate_ignore_rule(rule)
1196
compiled_rule = re.compile(translated_rule)
1197
groups[next_group] = rule
1198
next_group += compiled_rule.groups
1199
translated_rules.append(translated_rule)
1200
if next_group == 99:
1201
result.append((re.compile("|".join(translated_rules)), groups))
1204
translated_rules = []
1205
if len(translated_rules):
1206
result.append((re.compile("|".join(translated_rules)), groups))
1209
def ignored_files(self):
1210
"""Yield list of PATH, IGNORE_PATTERN"""
1211
for subp in self.extras():
1212
pat = self.is_ignored(subp)
1216
def get_ignore_list(self):
1217
"""Return list of ignore patterns.
1219
Cached in the Tree object after the first call.
1221
ignoreset = getattr(self, '_ignoreset', None)
1222
if ignoreset is not None:
1225
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1226
ignore_globs.update(ignores.get_runtime_ignores())
1228
ignore_globs.update(ignores.get_user_ignores())
1230
if self.has_filename(bzrlib.IGNORE_FILENAME):
1231
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1233
ignore_globs.update(ignores.parse_ignore_file(f))
1237
self._ignoreset = ignore_globs
1238
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1241
def _get_ignore_rules_as_regex(self):
1242
"""Return a regex of the ignore rules and a mapping dict.
1244
:return: (ignore rules compiled regex, dictionary mapping rule group
1245
indices to original rule.)
1247
if getattr(self, '_ignoreset', None) is None:
1248
self.get_ignore_list()
1249
return self._ignore_regex
1251
def is_ignored(self, filename):
1252
r"""Check whether the filename matches an ignore pattern.
1254
Patterns containing '/' or '\' need to match the whole path;
1255
others match against only the last component.
1257
If the file is ignored, returns the pattern which caused it to
1258
be ignored, otherwise None. So this can simply be used as a
1259
boolean if desired."""
1261
# TODO: Use '**' to match directories, and other extended
1262
# globbing stuff from cvs/rsync.
1264
# XXX: fnmatch is actually not quite what we want: it's only
1265
# approximately the same as real Unix fnmatch, and doesn't
1266
# treat dotfiles correctly and allows * to match /.
1267
# Eventually it should be replaced with something more
1270
rules = self._get_ignore_rules_as_regex()
1271
for regex, mapping in rules:
1272
match = regex.match(filename)
1273
if match is not None:
1274
# one or more of the groups in mapping will have a non-None
1276
groups = match.groups()
1277
rules = [mapping[group] for group in
1278
mapping if groups[group] is not None]
1282
def kind(self, file_id):
1283
return file_kind(self.id2abspath(file_id))
1286
def last_revision(self):
1287
"""Return the last revision id of this working tree.
1289
In early branch formats this was == the branch last_revision,
1290
but that cannot be relied upon - for working tree operations,
1291
always use tree.last_revision().
1293
return self.branch.last_revision()
1295
def is_locked(self):
1296
return self._control_files.is_locked()
1298
def lock_read(self):
1299
"""See Branch.lock_read, and WorkingTree.unlock."""
1300
self.branch.lock_read()
1302
return self._control_files.lock_read()
1304
self.branch.unlock()
1307
def lock_write(self):
1308
"""See Branch.lock_write, and WorkingTree.unlock."""
1309
self.branch.lock_write()
1311
return self._control_files.lock_write()
1313
self.branch.unlock()
1316
def get_physical_lock_status(self):
1317
return self._control_files.get_physical_lock_status()
1319
def _basis_inventory_name(self):
1320
return 'basis-inventory'
1323
def set_last_revision(self, new_revision):
1324
"""Change the last revision in the working tree."""
1325
if self._change_last_revision(new_revision):
1326
self._cache_basis_inventory(new_revision)
1328
def _change_last_revision(self, new_revision):
1329
"""Template method part of set_last_revision to perform the change.
1331
This is used to allow WorkingTree3 instances to not affect branch
1332
when their last revision is set.
1334
if new_revision is None:
1335
self.branch.set_revision_history([])
1338
self.branch.generate_revision_history(new_revision)
1339
except errors.NoSuchRevision:
1340
# not present in the repo - dont try to set it deeper than the tip
1341
self.branch.set_revision_history([new_revision])
1344
def _cache_basis_inventory(self, new_revision):
1345
"""Cache new_revision as the basis inventory."""
1346
# TODO: this should allow the ready-to-use inventory to be passed in,
1347
# as commit already has that ready-to-use [while the format is the
1350
# this double handles the inventory - unpack and repack -
1351
# but is easier to understand. We can/should put a conditional
1352
# in here based on whether the inventory is in the latest format
1353
# - perhaps we should repack all inventories on a repository
1355
# the fast path is to copy the raw xml from the repository. If the
1356
# xml contains 'revision_id="', then we assume the right
1357
# revision_id is set. We must check for this full string, because a
1358
# root node id can legitimately look like 'revision_id' but cannot
1360
xml = self.branch.repository.get_inventory_xml(new_revision)
1361
if not 'revision_id="' in xml.split('\n', 1)[0]:
1362
inv = self.branch.repository.deserialise_inventory(
1364
inv.revision_id = new_revision
1365
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1366
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1367
path = self._basis_inventory_name()
1369
self._control_files.put(path, sio)
1370
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1373
def read_basis_inventory(self):
1374
"""Read the cached basis inventory."""
1375
path = self._basis_inventory_name()
1376
return self._control_files.get(path).read()
1379
def read_working_inventory(self):
1380
"""Read the working inventory."""
1381
# ElementTree does its own conversion from UTF-8, so open in
1383
result = bzrlib.xml5.serializer_v5.read_inventory(
1384
self._control_files.get('inventory'))
1385
self._set_inventory(result)
1389
def remove(self, files, verbose=False, to_file=None):
1390
"""Remove nominated files from the working inventory..
1392
This does not remove their text. This does not run on XXX on what? RBC
1394
TODO: Refuse to remove modified files unless --force is given?
1396
TODO: Do something useful with directories.
1398
TODO: Should this remove the text or not? Tough call; not
1399
removing may be useful and the user can just use use rm, and
1400
is the opposite of add. Removing it is consistent with most
1401
other tools. Maybe an option.
1403
## TODO: Normalize names
1404
## TODO: Remove nested loops; better scalability
1405
if isinstance(files, basestring):
1408
inv = self.inventory
1410
# do this before any modifications
1412
fid = inv.path2id(f)
1414
# TODO: Perhaps make this just a warning, and continue?
1415
# This tends to happen when
1416
raise NotVersionedError(path=f)
1418
# having remove it, it must be either ignored or unknown
1419
if self.is_ignored(f):
1423
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1426
self._write_inventory(inv)
1429
def revert(self, filenames, old_tree=None, backups=True,
1430
pb=DummyProgress()):
1431
from transform import revert
1432
from conflicts import resolve
1433
if old_tree is None:
1434
old_tree = self.basis_tree()
1435
conflicts = revert(self, old_tree, filenames, backups, pb)
1436
if not len(filenames):
1437
self.set_pending_merges([])
1440
resolve(self, filenames, ignore_misses=True)
1443
# XXX: This method should be deprecated in favour of taking in a proper
1444
# new Inventory object.
1446
def set_inventory(self, new_inventory_list):
1447
from bzrlib.inventory import (Inventory,
1452
inv = Inventory(self.get_root_id())
1453
for path, file_id, parent, kind in new_inventory_list:
1454
name = os.path.basename(path)
1457
# fixme, there should be a factory function inv,add_??
1458
if kind == 'directory':
1459
inv.add(InventoryDirectory(file_id, name, parent))
1460
elif kind == 'file':
1461
inv.add(InventoryFile(file_id, name, parent))
1462
elif kind == 'symlink':
1463
inv.add(InventoryLink(file_id, name, parent))
1465
raise BzrError("unknown kind %r" % kind)
1466
self._write_inventory(inv)
1469
def set_root_id(self, file_id):
1470
"""Set the root id for this tree."""
1471
inv = self.read_working_inventory()
1472
orig_root_id = inv.root.file_id
1473
del inv._byid[inv.root.file_id]
1474
inv.root.file_id = file_id
1475
inv._byid[inv.root.file_id] = inv.root
1478
if entry.parent_id == orig_root_id:
1479
entry.parent_id = inv.root.file_id
1480
self._write_inventory(inv)
1483
"""See Branch.unlock.
1485
WorkingTree locking just uses the Branch locking facilities.
1486
This is current because all working trees have an embedded branch
1487
within them. IF in the future, we were to make branch data shareable
1488
between multiple working trees, i.e. via shared storage, then we
1489
would probably want to lock both the local tree, and the branch.
1491
raise NotImplementedError(self.unlock)
1495
"""Update a working tree along its branch.
1497
This will update the branch if its bound too, which means we have multiple trees involved:
1498
The new basis tree of the master.
1499
The old basis tree of the branch.
1500
The old basis tree of the working tree.
1501
The current working tree state.
1502
pathologically all three may be different, and non ancestors of each other.
1503
Conceptually we want to:
1504
Preserve the wt.basis->wt.state changes
1505
Transform the wt.basis to the new master basis.
1506
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1507
Restore the wt.basis->wt.state changes.
1509
There isn't a single operation at the moment to do that, so we:
1510
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1511
Do a 'normal' merge of the old branch basis if it is relevant.
1513
old_tip = self.branch.update()
1514
# here if old_tip is not None, it is the old tip of the branch before
1515
# it was updated from the master branch. This should become a pending
1516
# merge in the working tree to preserve the user existing work. we
1517
# cant set that until we update the working trees last revision to be
1518
# one from the new branch, because it will just get absorbed by the
1519
# parent de-duplication logic.
1521
# We MUST save it even if an error occurs, because otherwise the users
1522
# local work is unreferenced and will appear to have been lost.
1525
if self.last_revision() != self.branch.last_revision():
1526
# merge tree state up to new branch tip.
1527
basis = self.basis_tree()
1528
to_tree = self.branch.basis_tree()
1529
result += merge_inner(self.branch,
1533
# TODO - dedup parents list with things merged by pull ?
1534
# reuse the tree we've updated to to set the basis:
1535
parent_trees = [(self.branch.last_revision(), to_tree)]
1536
merges = self.get_parent_ids()[1:]
1537
# Ideally we ask the tree for the trees here, that way the working
1538
# tree can decide whether to give us teh entire tree or give us a
1539
# lazy initialised tree. dirstate for instance will have the trees
1540
# in ram already, whereas a last-revision + basis-inventory tree
1541
# will not, but also does not need them when setting parents.
1542
for parent in merges:
1543
parent_trees.append(
1544
(parent, self.branch.repository.revision_tree(parent)))
1545
if old_tip is not None:
1546
parent_trees.append(
1547
(old_tip, self.branch.repository.revision_tree(old_tip)))
1548
self.set_parent_trees(parent_trees)
1550
# the working tree had the same last-revision as the master
1551
# branch did. We may still have pivot local work from the local
1552
# branch into old_tip:
1553
if old_tip is not None:
1554
self.add_pending_merge(old_tip)
1555
if old_tip and old_tip != self.last_revision():
1556
# our last revision was not the prior branch last revision
1557
# and we have converted that last revision to a pending merge.
1558
# base is somewhere between the branch tip now
1559
# and the now pending merge
1560
from bzrlib.revision import common_ancestor
1562
base_rev_id = common_ancestor(self.branch.last_revision(),
1564
self.branch.repository)
1565
except errors.NoCommonAncestor:
1567
base_tree = self.branch.repository.revision_tree(base_rev_id)
1568
other_tree = self.branch.repository.revision_tree(old_tip)
1569
result += merge_inner(self.branch,
1576
def _write_inventory(self, inv):
1577
"""Write inventory as the current inventory."""
1579
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1581
self._control_files.put('inventory', sio)
1582
self._set_inventory(inv)
1583
mutter('wrote working inventory')
1585
def set_conflicts(self, arg):
1586
raise UnsupportedOperation(self.set_conflicts, self)
1588
def add_conflicts(self, arg):
1589
raise UnsupportedOperation(self.add_conflicts, self)
1592
def conflicts(self):
1593
conflicts = ConflictList()
1594
for conflicted in self._iter_conflicts():
1597
if file_kind(self.abspath(conflicted)) != "file":
1599
except errors.NoSuchFile:
1602
for suffix in ('.THIS', '.OTHER'):
1604
kind = file_kind(self.abspath(conflicted+suffix))
1607
except errors.NoSuchFile:
1611
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1612
conflicts.append(Conflict.factory(ctype, path=conflicted,
1613
file_id=self.path2id(conflicted)))
1617
class WorkingTree2(WorkingTree):
1618
"""This is the Format 2 working tree.
1620
This was the first weave based working tree.
1621
- uses os locks for locking.
1622
- uses the branch last-revision.
1626
# we share control files:
1627
if self._hashcache.needs_write and self._control_files._lock_count==3:
1628
self._hashcache.write()
1629
# reverse order of locking.
1631
return self._control_files.unlock()
1633
self.branch.unlock()
1636
class WorkingTree3(WorkingTree):
1637
"""This is the Format 3 working tree.
1639
This differs from the base WorkingTree by:
1640
- having its own file lock
1641
- having its own last-revision property.
1643
This is new in bzr 0.8
1647
def last_revision(self):
1648
"""See WorkingTree.last_revision."""
1650
return self._control_files.get_utf8('last-revision').read()
1654
def _change_last_revision(self, revision_id):
1655
"""See WorkingTree._change_last_revision."""
1656
if revision_id is None or revision_id == NULL_REVISION:
1658
self._control_files._transport.delete('last-revision')
1659
except errors.NoSuchFile:
1663
self._control_files.put_utf8('last-revision', revision_id)
1667
def set_conflicts(self, conflicts):
1668
self._put_rio('conflicts', conflicts.to_stanzas(),
1672
def add_conflicts(self, new_conflicts):
1673
conflict_set = set(self.conflicts())
1674
conflict_set.update(set(list(new_conflicts)))
1675
self.set_conflicts(ConflictList(sorted(conflict_set,
1676
key=Conflict.sort_key)))
1679
def conflicts(self):
1681
confile = self._control_files.get('conflicts')
1683
return ConflictList()
1685
if confile.next() != CONFLICT_HEADER_1 + '\n':
1686
raise ConflictFormatError()
1687
except StopIteration:
1688
raise ConflictFormatError()
1689
return ConflictList.from_stanzas(RioReader(confile))
1692
if self._hashcache.needs_write and self._control_files._lock_count==1:
1693
self._hashcache.write()
1694
# reverse order of locking.
1696
return self._control_files.unlock()
1698
self.branch.unlock()
1701
def get_conflicted_stem(path):
1702
for suffix in CONFLICT_SUFFIXES:
1703
if path.endswith(suffix):
1704
return path[:-len(suffix)]
1706
@deprecated_function(zero_eight)
1707
def is_control_file(filename):
1708
"""See WorkingTree.is_control_filename(filename)."""
1709
## FIXME: better check
1710
filename = normpath(filename)
1711
while filename != '':
1712
head, tail = os.path.split(filename)
1713
## mutter('check %r for control file' % ((head, tail),))
1716
if filename == head:
1722
class WorkingTreeFormat(object):
1723
"""An encapsulation of the initialization and open routines for a format.
1725
Formats provide three things:
1726
* An initialization routine,
1730
Formats are placed in an dict by their format string for reference
1731
during workingtree opening. Its not required that these be instances, they
1732
can be classes themselves with class methods - it simply depends on
1733
whether state is needed for a given format or not.
1735
Once a format is deprecated, just deprecate the initialize and open
1736
methods on the format class. Do not deprecate the object, as the
1737
object will be created every time regardless.
1740
_default_format = None
1741
"""The default format used for new trees."""
1744
"""The known formats."""
1747
def find_format(klass, a_bzrdir):
1748
"""Return the format for the working tree object in a_bzrdir."""
1750
transport = a_bzrdir.get_workingtree_transport(None)
1751
format_string = transport.get("format").read()
1752
return klass._formats[format_string]
1754
raise errors.NoWorkingTree(base=transport.base)
1756
raise errors.UnknownFormatError(format=format_string)
1759
def get_default_format(klass):
1760
"""Return the current default format."""
1761
return klass._default_format
1763
def get_format_string(self):
1764
"""Return the ASCII format string that identifies this format."""
1765
raise NotImplementedError(self.get_format_string)
1767
def get_format_description(self):
1768
"""Return the short description for this format."""
1769
raise NotImplementedError(self.get_format_description)
1771
def is_supported(self):
1772
"""Is this format supported?
1774
Supported formats can be initialized and opened.
1775
Unsupported formats may not support initialization or committing or
1776
some other features depending on the reason for not being supported.
1781
def register_format(klass, format):
1782
klass._formats[format.get_format_string()] = format
1785
def set_default_format(klass, format):
1786
klass._default_format = format
1789
def unregister_format(klass, format):
1790
assert klass._formats[format.get_format_string()] is format
1791
del klass._formats[format.get_format_string()]
1795
class WorkingTreeFormat2(WorkingTreeFormat):
1796
"""The second working tree format.
1798
This format modified the hash cache from the format 1 hash cache.
1801
def get_format_description(self):
1802
"""See WorkingTreeFormat.get_format_description()."""
1803
return "Working tree format 2"
1805
def stub_initialize_remote(self, control_files):
1806
"""As a special workaround create critical control files for a remote working tree
1808
This ensures that it can later be updated and dealt with locally,
1809
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1810
no working tree. (See bug #43064).
1814
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1816
control_files.put('inventory', sio)
1818
control_files.put_utf8('pending-merges', '')
1821
def initialize(self, a_bzrdir, revision_id=None):
1822
"""See WorkingTreeFormat.initialize()."""
1823
if not isinstance(a_bzrdir.transport, LocalTransport):
1824
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1825
branch = a_bzrdir.open_branch()
1826
if revision_id is not None:
1829
revision_history = branch.revision_history()
1831
position = revision_history.index(revision_id)
1833
raise errors.NoSuchRevision(branch, revision_id)
1834
branch.set_revision_history(revision_history[:position + 1])
1837
revision = branch.last_revision()
1839
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1845
wt._write_inventory(inv)
1846
wt.set_root_id(inv.root.file_id)
1847
basis_tree = branch.repository.revision_tree(revision)
1848
wt.set_parent_trees([(revision, basis_tree)])
1849
build_tree(basis_tree, wt)
1853
super(WorkingTreeFormat2, self).__init__()
1854
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1856
def open(self, a_bzrdir, _found=False):
1857
"""Return the WorkingTree object for a_bzrdir
1859
_found is a private parameter, do not use it. It is used to indicate
1860
if format probing has already been done.
1863
# we are being called directly and must probe.
1864
raise NotImplementedError
1865
if not isinstance(a_bzrdir.transport, LocalTransport):
1866
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1867
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1873
class WorkingTreeFormat3(WorkingTreeFormat):
1874
"""The second working tree format updated to record a format marker.
1877
- exists within a metadir controlling .bzr
1878
- includes an explicit version marker for the workingtree control
1879
files, separate from the BzrDir format
1880
- modifies the hash cache format
1882
- uses a LockDir to guard access for writes.
1885
def get_format_string(self):
1886
"""See WorkingTreeFormat.get_format_string()."""
1887
return "Bazaar-NG Working Tree format 3"
1889
def get_format_description(self):
1890
"""See WorkingTreeFormat.get_format_description()."""
1891
return "Working tree format 3"
1893
_lock_file_name = 'lock'
1894
_lock_class = LockDir
1896
def _open_control_files(self, a_bzrdir):
1897
transport = a_bzrdir.get_workingtree_transport(None)
1898
return LockableFiles(transport, self._lock_file_name,
1901
def initialize(self, a_bzrdir, revision_id=None):
1902
"""See WorkingTreeFormat.initialize().
1904
revision_id allows creating a working tree at a different
1905
revision than the branch is at.
1907
if not isinstance(a_bzrdir.transport, LocalTransport):
1908
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1909
transport = a_bzrdir.get_workingtree_transport(self)
1910
control_files = self._open_control_files(a_bzrdir)
1911
control_files.create_lock()
1912
control_files.lock_write()
1913
control_files.put_utf8('format', self.get_format_string())
1914
branch = a_bzrdir.open_branch()
1915
if revision_id is None:
1916
revision_id = branch.last_revision()
1918
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1924
_control_files=control_files)
1927
wt._write_inventory(inv)
1928
wt.set_root_id(inv.root.file_id)
1929
basis_tree = branch.repository.revision_tree(revision_id)
1930
wt.set_parent_trees([(revision_id, basis_tree)])
1931
build_tree(basis_tree, wt)
1934
control_files.unlock()
1938
super(WorkingTreeFormat3, self).__init__()
1939
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1941
def open(self, a_bzrdir, _found=False):
1942
"""Return the WorkingTree object for a_bzrdir
1944
_found is a private parameter, do not use it. It is used to indicate
1945
if format probing has already been done.
1948
# we are being called directly and must probe.
1949
raise NotImplementedError
1950
if not isinstance(a_bzrdir.transport, LocalTransport):
1951
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1952
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1954
def _open(self, a_bzrdir, control_files):
1955
"""Open the tree itself.
1957
:param a_bzrdir: the dir for the tree.
1958
:param control_files: the control files for the tree.
1960
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1964
_control_files=control_files)
1967
return self.get_format_string()
1970
# formats which have no format string are not discoverable
1971
# and not independently creatable, so are not registered.
1972
__default_format = WorkingTreeFormat3()
1973
WorkingTreeFormat.register_format(__default_format)
1974
WorkingTreeFormat.set_default_format(__default_format)
1975
_legacy_formats = [WorkingTreeFormat2(),
1979
class WorkingTreeTestProviderAdapter(object):
1980
"""A tool to generate a suite testing multiple workingtree formats at once.
1982
This is done by copying the test once for each transport and injecting
1983
the transport_server, transport_readonly_server, and workingtree_format
1984
classes into each copy. Each copy is also given a new id() to make it
1988
def __init__(self, transport_server, transport_readonly_server, formats):
1989
self._transport_server = transport_server
1990
self._transport_readonly_server = transport_readonly_server
1991
self._formats = formats
1993
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1994
"""Clone test for adaption."""
1995
new_test = deepcopy(test)
1996
new_test.transport_server = self._transport_server
1997
new_test.transport_readonly_server = self._transport_readonly_server
1998
new_test.bzrdir_format = bzrdir_format
1999
new_test.workingtree_format = workingtree_format
2000
def make_new_test_id():
2001
new_id = "%s(%s)" % (test.id(), variation)
2002
return lambda: new_id
2003
new_test.id = make_new_test_id()
2006
def adapt(self, test):
2007
from bzrlib.tests import TestSuite
2008
result = TestSuite()
2009
for workingtree_format, bzrdir_format in self._formats:
2010
new_test = self._clone_test(
2013
workingtree_format, workingtree_format.__class__.__name__)
2014
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
