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()
495
merges_file = self._control_files.get_utf8('pending-merges')
499
for l in merges_file.readlines():
500
parents.append(l.rstrip('\n'))
503
def get_root_id(self):
504
"""Return the id of this trees root"""
505
inv = self.read_working_inventory()
506
return inv.root.file_id
508
def _get_store_filename(self, file_id):
509
## XXX: badly named; this is not in the store at all
510
return self.abspath(self.id2path(file_id))
513
def clone(self, to_bzrdir, revision_id=None, basis=None):
514
"""Duplicate this working tree into to_bzr, including all state.
516
Specifically modified files are kept as modified, but
517
ignored and unknown files are discarded.
519
If you want to make a new line of development, see bzrdir.sprout()
522
If not None, the cloned tree will have its last revision set to
523
revision, and and difference between the source trees last revision
524
and this one merged in.
527
If not None, a closer copy of a tree which may have some files in
528
common, and which file content should be preferentially copied from.
530
# assumes the target bzr dir format is compatible.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id)
536
def copy_content_into(self, tree, revision_id=None):
537
"""Copy the current content and user files of this tree into tree."""
538
if revision_id is None:
539
transform_tree(tree, self)
541
# TODO now merge from tree.last_revision to revision (to preserve
542
# user local changes)
543
transform_tree(tree, self)
544
tree.set_parent_ids([revision_id])
547
def commit(self, message=None, revprops=None, *args, **kwargs):
548
# avoid circular imports
549
from bzrlib.commit import Commit
552
if not 'branch-nick' in revprops:
553
revprops['branch-nick'] = self.branch.nick
554
# args for wt.commit start at message from the Commit.commit method,
555
# but with branch a kwarg now, passing in args as is results in the
556
#message being used for the branch
557
args = (DEPRECATED_PARAMETER, message, ) + args
558
committed_id = Commit().commit( working_tree=self, revprops=revprops,
560
self._set_inventory(self.read_working_inventory())
563
def id2abspath(self, file_id):
564
return self.abspath(self.id2path(file_id))
566
def has_id(self, file_id):
567
# files that have been deleted are excluded
568
inv = self._inventory
569
if not inv.has_id(file_id):
571
path = inv.id2path(file_id)
572
return osutils.lexists(self.abspath(path))
574
def has_or_had_id(self, file_id):
575
if file_id == self.inventory.root.file_id:
577
return self.inventory.has_id(file_id)
579
__contains__ = has_id
581
def get_file_size(self, file_id):
582
return os.path.getsize(self.id2abspath(file_id))
585
def get_file_sha1(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
return self._hashcache.get_sha1(path)
590
def get_file_mtime(self, file_id, path=None):
592
path = self._inventory.id2path(file_id)
593
return os.lstat(self.abspath(path)).st_mtime
595
if not supports_executable():
596
def is_executable(self, file_id, path=None):
597
return self._inventory[file_id].executable
599
def is_executable(self, file_id, path=None):
601
path = self._inventory.id2path(file_id)
602
mode = os.lstat(self.abspath(path)).st_mode
603
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
606
def add(self, files, ids=None):
607
"""Make files versioned.
609
Note that the command line normally calls smart_add instead,
610
which can automatically recurse.
612
This adds the files to the inventory, so that they will be
613
recorded by the next commit.
616
List of paths to add, relative to the base of the tree.
619
If set, use these instead of automatically generated ids.
620
Must be the same length as the list of files, but may
621
contain None for ids that are to be autogenerated.
623
TODO: Perhaps have an option to add the ids even if the files do
626
TODO: Perhaps callback with the ids and paths as they're added.
628
# TODO: Re-adding a file that is removed in the working copy
629
# should probably put it back with the previous ID.
630
if isinstance(files, basestring):
631
assert(ids is None or isinstance(ids, basestring))
637
ids = [None] * len(files)
639
assert(len(ids) == len(files))
641
inv = self.read_working_inventory()
642
for f,file_id in zip(files, ids):
643
if self.is_control_filename(f):
644
raise errors.ForbiddenControlFileError(filename=f)
649
raise BzrError("cannot add top-level %r" % f)
651
fullpath = normpath(self.abspath(f))
653
kind = file_kind(fullpath)
655
if e.errno == errno.ENOENT:
656
raise NoSuchFile(fullpath)
657
if not InventoryEntry.versionable_kind(kind):
658
raise errors.BadFileKindError(filename=f, kind=kind)
660
inv.add_path(f, kind=kind)
662
inv.add_path(f, kind=kind, file_id=file_id)
664
self._write_inventory(inv)
667
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
668
"""Add revision_id as a parent.
670
This is equivalent to retrieving the current list of parent ids
671
and setting the list to its value plus revision_id.
673
:param revision_id: The revision id to add to the parent list. It may
674
be a ghost revision as long as its not the first parent to be added,
675
or the allow_leftmost_as_ghost parameter is set True.
676
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
678
parents = self.get_parent_ids() + [revision_id]
679
self.set_parent_ids(parents,
680
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
683
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
684
"""Add revision_id, tree tuple as a parent.
686
This is equivalent to retrieving the current list of parent trees
687
and setting the list to its value plus parent_tuple. See also
688
add_parent_tree_id - if you only have a parent id available it will be
689
simpler to use that api. If you have the parent already available, using
690
this api is preferred.
692
:param parent_tuple: The (revision id, tree) to add to the parent list.
693
If the revision_id is a ghost, pass None for the tree.
694
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
696
self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
697
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
700
def add_pending_merge(self, *revision_ids):
701
# TODO: Perhaps should check at this point that the
702
# history of the revision is actually present?
703
parents = self.get_parent_ids()
705
for rev_id in revision_ids:
706
if rev_id in parents:
708
parents.append(rev_id)
711
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
714
def pending_merges(self):
715
"""Return a list of pending merges.
717
These are revisions that have been merged into the working
718
directory but not yet committed.
720
return self.get_parent_ids()[1:]
723
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
724
"""Set the parent ids to revision_ids.
726
See also set_parent_trees. This api will try to retrieve the tree data
727
for each element of revision_ids from the trees repository. If you have
728
tree data already available, it is more efficient to use
729
set_parent_trees rather than set_parent_ids. set_parent_ids is however
730
an easier API to use.
732
:param revision_ids: The revision_ids to set as the parent ids of this
733
working tree. Any of these may be ghosts.
735
if len(revision_ids) > 0:
736
leftmost_id = revision_ids[0]
737
if (not allow_leftmost_as_ghost and not
738
self.branch.repository.has_revision(leftmost_id)):
739
raise errors.GhostRevisionUnusableHere(leftmost_id)
740
self.set_last_revision(leftmost_id)
742
self.set_last_revision(None)
743
merges = revision_ids[1:]
744
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
747
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
748
"""Set the parents of the working tree.
750
:param parents_list: A list of (revision_id, tree) tuples.
751
If tree is None, then that element is treated as an unreachable
752
parent tree - i.e. a ghost.
754
# parent trees are not used in current format trees, delegate to
756
self.set_parent_ids([rev for (rev, tree) in parents_list],
757
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
760
def set_pending_merges(self, rev_list):
761
parents = self.get_parent_ids()
762
leftmost = parents[:1]
763
new_parents = leftmost + rev_list
764
self.set_parent_ids(new_parents)
767
def set_merge_modified(self, modified_hashes):
769
for file_id, hash in modified_hashes.iteritems():
770
yield Stanza(file_id=file_id, hash=hash)
771
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
774
def _put_rio(self, filename, stanzas, header):
775
my_file = rio_file(stanzas, header)
776
self._control_files.put(filename, my_file)
779
def merge_modified(self):
781
hashfile = self._control_files.get('merge-hashes')
786
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
787
raise MergeModifiedFormatError()
788
except StopIteration:
789
raise MergeModifiedFormatError()
790
for s in RioReader(hashfile):
791
file_id = s.get("file_id")
792
if file_id not in self.inventory:
795
if hash == self.get_file_sha1(file_id):
796
merge_hashes[file_id] = hash
799
def get_symlink_target(self, file_id):
800
return os.readlink(self.id2abspath(file_id))
802
def file_class(self, filename):
803
if self.path2id(filename):
805
elif self.is_ignored(filename):
810
def list_files(self):
811
"""Recursively list all files as (path, class, kind, id, entry).
813
Lists, but does not descend into unversioned directories.
815
This does not include files that have been deleted in this
818
Skips the control directory.
820
inv = self._inventory
821
# Convert these into local objects to save lookup times
822
pathjoin = osutils.pathjoin
823
file_kind = osutils.file_kind
825
# transport.base ends in a slash, we want the piece
826
# between the last two slashes
827
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
829
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
831
# directory file_id, relative path, absolute path, reverse sorted children
832
children = os.listdir(self.basedir)
834
# jam 20060527 The kernel sized tree seems equivalent whether we
835
# use a deque and popleft to keep them sorted, or if we use a plain
836
# list and just reverse() them.
837
children = collections.deque(children)
838
stack = [(inv.root.file_id, u'', self.basedir, children)]
840
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
843
f = children.popleft()
844
## TODO: If we find a subdirectory with its own .bzr
845
## directory, then that is a separate tree and we
846
## should exclude it.
848
# the bzrdir for this tree
849
if transport_base_dir == f:
852
# we know that from_dir_relpath and from_dir_abspath never end in a slash
853
# and 'f' doesn't begin with one, we can do a string op, rather
854
# than the checks of pathjoin(), all relative paths will have an extra slash
856
fp = from_dir_relpath + '/' + f
859
fap = from_dir_abspath + '/' + f
861
f_ie = inv.get_child(from_dir_id, f)
864
elif self.is_ignored(fp[1:]):
867
# we may not have found this file, because of a unicode issue
868
f_norm, can_access = osutils.normalized_filename(f)
869
if f == f_norm or not can_access:
870
# No change, so treat this file normally
873
# this file can be accessed by a normalized path
874
# check again if it is versioned
875
# these lines are repeated here for performance
877
fp = from_dir_relpath + '/' + f
878
fap = from_dir_abspath + '/' + f
879
f_ie = inv.get_child(from_dir_id, f)
882
elif self.is_ignored(fp[1:]):
891
raise BzrCheckError("file %r entered as kind %r id %r, "
893
% (fap, f_ie.kind, f_ie.file_id, fk))
895
# make a last minute entry
897
yield fp[1:], c, fk, f_ie.file_id, f_ie
900
yield fp[1:], c, fk, None, fk_entries[fk]()
902
yield fp[1:], c, fk, None, TreeEntry()
905
if fk != 'directory':
908
# But do this child first
909
new_children = os.listdir(fap)
911
new_children = collections.deque(new_children)
912
stack.append((f_ie.file_id, fp, fap, new_children))
913
# Break out of inner loop, so that we start outer loop with child
916
# if we finished all children, pop it off the stack
921
def move(self, from_paths, to_name):
924
to_name must exist in the inventory.
926
If to_name exists and is a directory, the files are moved into
927
it, keeping their old names.
929
Note that to_name is only the last component of the new name;
930
this doesn't change the directory.
932
This returns a list of (from_path, to_path) pairs for each
936
## TODO: Option to move IDs only
937
assert not isinstance(from_paths, basestring)
939
to_abs = self.abspath(to_name)
940
if not isdir(to_abs):
941
raise BzrError("destination %r is not a directory" % to_abs)
942
if not self.has_filename(to_name):
943
raise BzrError("destination %r not in working directory" % to_abs)
944
to_dir_id = inv.path2id(to_name)
945
if to_dir_id == None and to_name != '':
946
raise BzrError("destination %r is not a versioned directory" % to_name)
947
to_dir_ie = inv[to_dir_id]
948
if to_dir_ie.kind != 'directory':
949
raise BzrError("destination %r is not a directory" % to_abs)
951
to_idpath = inv.get_idpath(to_dir_id)
954
if not self.has_filename(f):
955
raise BzrError("%r does not exist in working tree" % f)
956
f_id = inv.path2id(f)
958
raise BzrError("%r is not versioned" % f)
959
name_tail = splitpath(f)[-1]
960
dest_path = pathjoin(to_name, name_tail)
961
if self.has_filename(dest_path):
962
raise BzrError("destination %r already exists" % dest_path)
963
if f_id in to_idpath:
964
raise BzrError("can't move %r to a subdirectory of itself" % f)
966
# OK, so there's a race here, it's possible that someone will
967
# create a file in this interval and then the rename might be
968
# left half-done. But we should have caught most problems.
969
orig_inv = deepcopy(self.inventory)
972
name_tail = splitpath(f)[-1]
973
dest_path = pathjoin(to_name, name_tail)
974
result.append((f, dest_path))
975
inv.rename(inv.path2id(f), to_dir_id, name_tail)
977
rename(self.abspath(f), self.abspath(dest_path))
979
raise BzrError("failed to rename %r to %r: %s" %
980
(f, dest_path, e[1]),
981
["rename rolled back"])
983
# restore the inventory on error
984
self._set_inventory(orig_inv)
986
self._write_inventory(inv)
990
def rename_one(self, from_rel, to_rel):
993
This can change the directory or the filename or both.
996
if not self.has_filename(from_rel):
997
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
998
if self.has_filename(to_rel):
999
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1001
file_id = inv.path2id(from_rel)
1003
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1005
entry = inv[file_id]
1006
from_parent = entry.parent_id
1007
from_name = entry.name
1009
if inv.path2id(to_rel):
1010
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1012
to_dir, to_tail = os.path.split(to_rel)
1013
to_dir_id = inv.path2id(to_dir)
1014
if to_dir_id == None and to_dir != '':
1015
raise BzrError("can't determine destination directory id for %r" % to_dir)
1017
mutter("rename_one:")
1018
mutter(" file_id {%s}" % file_id)
1019
mutter(" from_rel %r" % from_rel)
1020
mutter(" to_rel %r" % to_rel)
1021
mutter(" to_dir %r" % to_dir)
1022
mutter(" to_dir_id {%s}" % to_dir_id)
1024
inv.rename(file_id, to_dir_id, to_tail)
1026
from_abs = self.abspath(from_rel)
1027
to_abs = self.abspath(to_rel)
1029
rename(from_abs, to_abs)
1031
inv.rename(file_id, from_parent, from_name)
1032
raise BzrError("failed to rename %r to %r: %s"
1033
% (from_abs, to_abs, e[1]),
1034
["rename rolled back"])
1035
self._write_inventory(inv)
1039
"""Return all unknown files.
1041
These are files in the working directory that are not versioned or
1042
control files or ignored.
1044
for subp in self.extras():
1045
if not self.is_ignored(subp):
1048
@deprecated_method(zero_eight)
1049
def iter_conflicts(self):
1050
"""List all files in the tree that have text or content conflicts.
1051
DEPRECATED. Use conflicts instead."""
1052
return self._iter_conflicts()
1054
def _iter_conflicts(self):
1056
for info in self.list_files():
1058
stem = get_conflicted_stem(path)
1061
if stem not in conflicted:
1062
conflicted.add(stem)
1066
def pull(self, source, overwrite=False, stop_revision=None):
1067
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1070
pp = ProgressPhase("Pull phase", 2, top_pb)
1072
old_revision_history = self.branch.revision_history()
1073
basis_tree = self.basis_tree()
1074
count = self.branch.pull(source, overwrite, stop_revision)
1075
new_revision_history = self.branch.revision_history()
1076
if new_revision_history != old_revision_history:
1078
if len(old_revision_history):
1079
other_revision = old_revision_history[-1]
1081
other_revision = None
1082
repository = self.branch.repository
1083
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1085
new_basis_tree = self.branch.basis_tree()
1086
merge_inner(self.branch,
1093
# TODO - dedup parents list with things merged by pull ?
1094
# reuse the revisiontree we merged against to set the new
1096
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1097
# we have to pull the merge trees out again, because
1098
# merge_inner has set the ids. - this corner is not yet
1099
# layered well enough to prevent double handling.
1100
merges = self.get_parent_ids()[1:]
1101
parent_trees.extend([
1102
(parent, repository.revision_tree(parent)) for
1104
self.set_parent_trees(parent_trees)
1111
"""Yield all unknown files in this WorkingTree.
1113
If there are any unknown directories then only the directory is
1114
returned, not all its children. But if there are unknown files
1115
under a versioned subdirectory, they are returned.
1117
Currently returned depth-first, sorted by name within directories.
1119
## TODO: Work from given directory downwards
1120
for path, dir_entry in self.inventory.directories():
1121
# mutter("search for unknowns in %r", path)
1122
dirabs = self.abspath(path)
1123
if not isdir(dirabs):
1124
# e.g. directory deleted
1128
for subf in os.listdir(dirabs):
1131
if subf not in dir_entry.children:
1132
subf_norm, can_access = osutils.normalized_filename(subf)
1133
if subf_norm != subf and can_access:
1134
if subf_norm not in dir_entry.children:
1135
fl.append(subf_norm)
1141
subp = pathjoin(path, subf)
1144
def _translate_ignore_rule(self, rule):
1145
"""Translate a single ignore rule to a regex.
1147
There are two types of ignore rules. Those that do not contain a / are
1148
matched against the tail of the filename (that is, they do not care
1149
what directory the file is in.) Rules which do contain a slash must
1150
match the entire path. As a special case, './' at the start of the
1151
string counts as a slash in the string but is removed before matching
1152
(e.g. ./foo.c, ./src/foo.c)
1154
:return: The translated regex.
1156
if rule[:2] in ('./', '.\\'):
1158
result = fnmatch.translate(rule[2:])
1159
elif '/' in rule or '\\' in rule:
1161
result = fnmatch.translate(rule)
1163
# default rule style.
1164
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1165
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1166
return "(" + result + ")"
1168
def _combine_ignore_rules(self, rules):
1169
"""Combine a list of ignore rules into a single regex object.
1171
Each individual rule is combined with | to form a big regex, which then
1172
has $ added to it to form something like ()|()|()$. The group index for
1173
each subregex's outermost group is placed in a dictionary mapping back
1174
to the rule. This allows quick identification of the matching rule that
1176
:return: a list of the compiled regex and the matching-group index
1177
dictionaries. We return a list because python complains if you try to
1178
combine more than 100 regexes.
1183
translated_rules = []
1185
translated_rule = self._translate_ignore_rule(rule)
1186
compiled_rule = re.compile(translated_rule)
1187
groups[next_group] = rule
1188
next_group += compiled_rule.groups
1189
translated_rules.append(translated_rule)
1190
if next_group == 99:
1191
result.append((re.compile("|".join(translated_rules)), groups))
1194
translated_rules = []
1195
if len(translated_rules):
1196
result.append((re.compile("|".join(translated_rules)), groups))
1199
def ignored_files(self):
1200
"""Yield list of PATH, IGNORE_PATTERN"""
1201
for subp in self.extras():
1202
pat = self.is_ignored(subp)
1206
def get_ignore_list(self):
1207
"""Return list of ignore patterns.
1209
Cached in the Tree object after the first call.
1211
ignoreset = getattr(self, '_ignoreset', None)
1212
if ignoreset is not None:
1215
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1216
ignore_globs.update(ignores.get_runtime_ignores())
1218
ignore_globs.update(ignores.get_user_ignores())
1220
if self.has_filename(bzrlib.IGNORE_FILENAME):
1221
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1223
ignore_globs.update(ignores.parse_ignore_file(f))
1227
self._ignoreset = ignore_globs
1228
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1231
def _get_ignore_rules_as_regex(self):
1232
"""Return a regex of the ignore rules and a mapping dict.
1234
:return: (ignore rules compiled regex, dictionary mapping rule group
1235
indices to original rule.)
1237
if getattr(self, '_ignoreset', None) is None:
1238
self.get_ignore_list()
1239
return self._ignore_regex
1241
def is_ignored(self, filename):
1242
r"""Check whether the filename matches an ignore pattern.
1244
Patterns containing '/' or '\' need to match the whole path;
1245
others match against only the last component.
1247
If the file is ignored, returns the pattern which caused it to
1248
be ignored, otherwise None. So this can simply be used as a
1249
boolean if desired."""
1251
# TODO: Use '**' to match directories, and other extended
1252
# globbing stuff from cvs/rsync.
1254
# XXX: fnmatch is actually not quite what we want: it's only
1255
# approximately the same as real Unix fnmatch, and doesn't
1256
# treat dotfiles correctly and allows * to match /.
1257
# Eventually it should be replaced with something more
1260
rules = self._get_ignore_rules_as_regex()
1261
for regex, mapping in rules:
1262
match = regex.match(filename)
1263
if match is not None:
1264
# one or more of the groups in mapping will have a non-None
1266
groups = match.groups()
1267
rules = [mapping[group] for group in
1268
mapping if groups[group] is not None]
1272
def kind(self, file_id):
1273
return file_kind(self.id2abspath(file_id))
1276
def last_revision(self):
1277
"""Return the last revision id of this working tree.
1279
In early branch formats this was == the branch last_revision,
1280
but that cannot be relied upon - for working tree operations,
1281
always use tree.last_revision().
1283
return self.branch.last_revision()
1285
def is_locked(self):
1286
return self._control_files.is_locked()
1288
def lock_read(self):
1289
"""See Branch.lock_read, and WorkingTree.unlock."""
1290
self.branch.lock_read()
1292
return self._control_files.lock_read()
1294
self.branch.unlock()
1297
def lock_write(self):
1298
"""See Branch.lock_write, and WorkingTree.unlock."""
1299
self.branch.lock_write()
1301
return self._control_files.lock_write()
1303
self.branch.unlock()
1306
def get_physical_lock_status(self):
1307
return self._control_files.get_physical_lock_status()
1309
def _basis_inventory_name(self):
1310
return 'basis-inventory'
1313
def set_last_revision(self, new_revision):
1314
"""Change the last revision in the working tree."""
1315
if self._change_last_revision(new_revision):
1316
self._cache_basis_inventory(new_revision)
1318
def _change_last_revision(self, new_revision):
1319
"""Template method part of set_last_revision to perform the change.
1321
This is used to allow WorkingTree3 instances to not affect branch
1322
when their last revision is set.
1324
if new_revision is None:
1325
self.branch.set_revision_history([])
1328
self.branch.generate_revision_history(new_revision)
1329
except errors.NoSuchRevision:
1330
# not present in the repo - dont try to set it deeper than the tip
1331
self.branch.set_revision_history([new_revision])
1334
def _cache_basis_inventory(self, new_revision):
1335
"""Cache new_revision as the basis inventory."""
1336
# TODO: this should allow the ready-to-use inventory to be passed in,
1337
# as commit already has that ready-to-use [while the format is the
1340
# this double handles the inventory - unpack and repack -
1341
# but is easier to understand. We can/should put a conditional
1342
# in here based on whether the inventory is in the latest format
1343
# - perhaps we should repack all inventories on a repository
1345
# the fast path is to copy the raw xml from the repository. If the
1346
# xml contains 'revision_id="', then we assume the right
1347
# revision_id is set. We must check for this full string, because a
1348
# root node id can legitimately look like 'revision_id' but cannot
1350
xml = self.branch.repository.get_inventory_xml(new_revision)
1351
if not 'revision_id="' in xml.split('\n', 1)[0]:
1352
inv = self.branch.repository.deserialise_inventory(
1354
inv.revision_id = new_revision
1355
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1356
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1357
path = self._basis_inventory_name()
1359
self._control_files.put(path, sio)
1360
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1363
def read_basis_inventory(self):
1364
"""Read the cached basis inventory."""
1365
path = self._basis_inventory_name()
1366
return self._control_files.get(path).read()
1369
def read_working_inventory(self):
1370
"""Read the working inventory."""
1371
# ElementTree does its own conversion from UTF-8, so open in
1373
result = bzrlib.xml5.serializer_v5.read_inventory(
1374
self._control_files.get('inventory'))
1375
self._set_inventory(result)
1379
def remove(self, files, verbose=False, to_file=None):
1380
"""Remove nominated files from the working inventory..
1382
This does not remove their text. This does not run on XXX on what? RBC
1384
TODO: Refuse to remove modified files unless --force is given?
1386
TODO: Do something useful with directories.
1388
TODO: Should this remove the text or not? Tough call; not
1389
removing may be useful and the user can just use use rm, and
1390
is the opposite of add. Removing it is consistent with most
1391
other tools. Maybe an option.
1393
## TODO: Normalize names
1394
## TODO: Remove nested loops; better scalability
1395
if isinstance(files, basestring):
1398
inv = self.inventory
1400
# do this before any modifications
1402
fid = inv.path2id(f)
1404
# TODO: Perhaps make this just a warning, and continue?
1405
# This tends to happen when
1406
raise NotVersionedError(path=f)
1408
# having remove it, it must be either ignored or unknown
1409
if self.is_ignored(f):
1413
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1416
self._write_inventory(inv)
1419
def revert(self, filenames, old_tree=None, backups=True,
1420
pb=DummyProgress()):
1421
from transform import revert
1422
from conflicts import resolve
1423
if old_tree is None:
1424
old_tree = self.basis_tree()
1425
conflicts = revert(self, old_tree, filenames, backups, pb)
1426
if not len(filenames):
1427
self.set_parent_ids(self.get_parent_ids()[:1])
1430
resolve(self, filenames, ignore_misses=True)
1433
# XXX: This method should be deprecated in favour of taking in a proper
1434
# new Inventory object.
1436
def set_inventory(self, new_inventory_list):
1437
from bzrlib.inventory import (Inventory,
1442
inv = Inventory(self.get_root_id())
1443
for path, file_id, parent, kind in new_inventory_list:
1444
name = os.path.basename(path)
1447
# fixme, there should be a factory function inv,add_??
1448
if kind == 'directory':
1449
inv.add(InventoryDirectory(file_id, name, parent))
1450
elif kind == 'file':
1451
inv.add(InventoryFile(file_id, name, parent))
1452
elif kind == 'symlink':
1453
inv.add(InventoryLink(file_id, name, parent))
1455
raise BzrError("unknown kind %r" % kind)
1456
self._write_inventory(inv)
1459
def set_root_id(self, file_id):
1460
"""Set the root id for this tree."""
1461
inv = self.read_working_inventory()
1462
orig_root_id = inv.root.file_id
1463
del inv._byid[inv.root.file_id]
1464
inv.root.file_id = file_id
1465
inv._byid[inv.root.file_id] = inv.root
1468
if entry.parent_id == orig_root_id:
1469
entry.parent_id = inv.root.file_id
1470
self._write_inventory(inv)
1473
"""See Branch.unlock.
1475
WorkingTree locking just uses the Branch locking facilities.
1476
This is current because all working trees have an embedded branch
1477
within them. IF in the future, we were to make branch data shareable
1478
between multiple working trees, i.e. via shared storage, then we
1479
would probably want to lock both the local tree, and the branch.
1481
raise NotImplementedError(self.unlock)
1485
"""Update a working tree along its branch.
1487
This will update the branch if its bound too, which means we have multiple trees involved:
1488
The new basis tree of the master.
1489
The old basis tree of the branch.
1490
The old basis tree of the working tree.
1491
The current working tree state.
1492
pathologically all three may be different, and non ancestors of each other.
1493
Conceptually we want to:
1494
Preserve the wt.basis->wt.state changes
1495
Transform the wt.basis to the new master basis.
1496
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1497
Restore the wt.basis->wt.state changes.
1499
There isn't a single operation at the moment to do that, so we:
1500
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1501
Do a 'normal' merge of the old branch basis if it is relevant.
1503
old_tip = self.branch.update()
1504
# here if old_tip is not None, it is the old tip of the branch before
1505
# it was updated from the master branch. This should become a pending
1506
# merge in the working tree to preserve the user existing work. we
1507
# cant set that until we update the working trees last revision to be
1508
# one from the new branch, because it will just get absorbed by the
1509
# parent de-duplication logic.
1511
# We MUST save it even if an error occurs, because otherwise the users
1512
# local work is unreferenced and will appear to have been lost.
1515
if self.last_revision() != self.branch.last_revision():
1516
# merge tree state up to new branch tip.
1517
basis = self.basis_tree()
1518
to_tree = self.branch.basis_tree()
1519
result += merge_inner(self.branch,
1523
# TODO - dedup parents list with things merged by pull ?
1524
# reuse the tree we've updated to to set the basis:
1525
parent_trees = [(self.branch.last_revision(), to_tree)]
1526
merges = self.get_parent_ids()[1:]
1527
# Ideally we ask the tree for the trees here, that way the working
1528
# tree can decide whether to give us teh entire tree or give us a
1529
# lazy initialised tree. dirstate for instance will have the trees
1530
# in ram already, whereas a last-revision + basis-inventory tree
1531
# will not, but also does not need them when setting parents.
1532
for parent in merges:
1533
parent_trees.append(
1534
(parent, self.branch.repository.revision_tree(parent)))
1535
if old_tip is not None:
1536
parent_trees.append(
1537
(old_tip, self.branch.repository.revision_tree(old_tip)))
1538
self.set_parent_trees(parent_trees)
1540
# the working tree had the same last-revision as the master
1541
# branch did. We may still have pivot local work from the local
1542
# branch into old_tip:
1543
if old_tip is not None:
1544
self.add_parent_tree_id(old_tip)
1545
if old_tip and old_tip != self.last_revision():
1546
# our last revision was not the prior branch last revision
1547
# and we have converted that last revision to a pending merge.
1548
# base is somewhere between the branch tip now
1549
# and the now pending merge
1550
from bzrlib.revision import common_ancestor
1552
base_rev_id = common_ancestor(self.branch.last_revision(),
1554
self.branch.repository)
1555
except errors.NoCommonAncestor:
1557
base_tree = self.branch.repository.revision_tree(base_rev_id)
1558
other_tree = self.branch.repository.revision_tree(old_tip)
1559
result += merge_inner(self.branch,
1566
def _write_inventory(self, inv):
1567
"""Write inventory as the current inventory."""
1569
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1571
self._control_files.put('inventory', sio)
1572
self._set_inventory(inv)
1573
mutter('wrote working inventory')
1575
def set_conflicts(self, arg):
1576
raise UnsupportedOperation(self.set_conflicts, self)
1578
def add_conflicts(self, arg):
1579
raise UnsupportedOperation(self.add_conflicts, self)
1582
def conflicts(self):
1583
conflicts = ConflictList()
1584
for conflicted in self._iter_conflicts():
1587
if file_kind(self.abspath(conflicted)) != "file":
1589
except errors.NoSuchFile:
1592
for suffix in ('.THIS', '.OTHER'):
1594
kind = file_kind(self.abspath(conflicted+suffix))
1597
except errors.NoSuchFile:
1601
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1602
conflicts.append(Conflict.factory(ctype, path=conflicted,
1603
file_id=self.path2id(conflicted)))
1607
class WorkingTree2(WorkingTree):
1608
"""This is the Format 2 working tree.
1610
This was the first weave based working tree.
1611
- uses os locks for locking.
1612
- uses the branch last-revision.
1616
# we share control files:
1617
if self._hashcache.needs_write and self._control_files._lock_count==3:
1618
self._hashcache.write()
1619
# reverse order of locking.
1621
return self._control_files.unlock()
1623
self.branch.unlock()
1626
class WorkingTree3(WorkingTree):
1627
"""This is the Format 3 working tree.
1629
This differs from the base WorkingTree by:
1630
- having its own file lock
1631
- having its own last-revision property.
1633
This is new in bzr 0.8
1637
def last_revision(self):
1638
"""See WorkingTree.last_revision."""
1640
return self._control_files.get_utf8('last-revision').read()
1644
def _change_last_revision(self, revision_id):
1645
"""See WorkingTree._change_last_revision."""
1646
if revision_id is None or revision_id == NULL_REVISION:
1648
self._control_files._transport.delete('last-revision')
1649
except errors.NoSuchFile:
1653
self._control_files.put_utf8('last-revision', revision_id)
1657
def set_conflicts(self, conflicts):
1658
self._put_rio('conflicts', conflicts.to_stanzas(),
1662
def add_conflicts(self, new_conflicts):
1663
conflict_set = set(self.conflicts())
1664
conflict_set.update(set(list(new_conflicts)))
1665
self.set_conflicts(ConflictList(sorted(conflict_set,
1666
key=Conflict.sort_key)))
1669
def conflicts(self):
1671
confile = self._control_files.get('conflicts')
1673
return ConflictList()
1675
if confile.next() != CONFLICT_HEADER_1 + '\n':
1676
raise ConflictFormatError()
1677
except StopIteration:
1678
raise ConflictFormatError()
1679
return ConflictList.from_stanzas(RioReader(confile))
1682
if self._hashcache.needs_write and self._control_files._lock_count==1:
1683
self._hashcache.write()
1684
# reverse order of locking.
1686
return self._control_files.unlock()
1688
self.branch.unlock()
1691
def get_conflicted_stem(path):
1692
for suffix in CONFLICT_SUFFIXES:
1693
if path.endswith(suffix):
1694
return path[:-len(suffix)]
1696
@deprecated_function(zero_eight)
1697
def is_control_file(filename):
1698
"""See WorkingTree.is_control_filename(filename)."""
1699
## FIXME: better check
1700
filename = normpath(filename)
1701
while filename != '':
1702
head, tail = os.path.split(filename)
1703
## mutter('check %r for control file' % ((head, tail),))
1706
if filename == head:
1712
class WorkingTreeFormat(object):
1713
"""An encapsulation of the initialization and open routines for a format.
1715
Formats provide three things:
1716
* An initialization routine,
1720
Formats are placed in an dict by their format string for reference
1721
during workingtree opening. Its not required that these be instances, they
1722
can be classes themselves with class methods - it simply depends on
1723
whether state is needed for a given format or not.
1725
Once a format is deprecated, just deprecate the initialize and open
1726
methods on the format class. Do not deprecate the object, as the
1727
object will be created every time regardless.
1730
_default_format = None
1731
"""The default format used for new trees."""
1734
"""The known formats."""
1737
def find_format(klass, a_bzrdir):
1738
"""Return the format for the working tree object in a_bzrdir."""
1740
transport = a_bzrdir.get_workingtree_transport(None)
1741
format_string = transport.get("format").read()
1742
return klass._formats[format_string]
1744
raise errors.NoWorkingTree(base=transport.base)
1746
raise errors.UnknownFormatError(format=format_string)
1749
def get_default_format(klass):
1750
"""Return the current default format."""
1751
return klass._default_format
1753
def get_format_string(self):
1754
"""Return the ASCII format string that identifies this format."""
1755
raise NotImplementedError(self.get_format_string)
1757
def get_format_description(self):
1758
"""Return the short description for this format."""
1759
raise NotImplementedError(self.get_format_description)
1761
def is_supported(self):
1762
"""Is this format supported?
1764
Supported formats can be initialized and opened.
1765
Unsupported formats may not support initialization or committing or
1766
some other features depending on the reason for not being supported.
1771
def register_format(klass, format):
1772
klass._formats[format.get_format_string()] = format
1775
def set_default_format(klass, format):
1776
klass._default_format = format
1779
def unregister_format(klass, format):
1780
assert klass._formats[format.get_format_string()] is format
1781
del klass._formats[format.get_format_string()]
1785
class WorkingTreeFormat2(WorkingTreeFormat):
1786
"""The second working tree format.
1788
This format modified the hash cache from the format 1 hash cache.
1791
def get_format_description(self):
1792
"""See WorkingTreeFormat.get_format_description()."""
1793
return "Working tree format 2"
1795
def stub_initialize_remote(self, control_files):
1796
"""As a special workaround create critical control files for a remote working tree
1798
This ensures that it can later be updated and dealt with locally,
1799
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1800
no working tree. (See bug #43064).
1804
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1806
control_files.put('inventory', sio)
1808
control_files.put_utf8('pending-merges', '')
1811
def initialize(self, a_bzrdir, revision_id=None):
1812
"""See WorkingTreeFormat.initialize()."""
1813
if not isinstance(a_bzrdir.transport, LocalTransport):
1814
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1815
branch = a_bzrdir.open_branch()
1816
if revision_id is not None:
1819
revision_history = branch.revision_history()
1821
position = revision_history.index(revision_id)
1823
raise errors.NoSuchRevision(branch, revision_id)
1824
branch.set_revision_history(revision_history[:position + 1])
1827
revision = branch.last_revision()
1829
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1835
wt._write_inventory(inv)
1836
wt.set_root_id(inv.root.file_id)
1837
basis_tree = branch.repository.revision_tree(revision)
1838
wt.set_parent_trees([(revision, basis_tree)])
1839
build_tree(basis_tree, wt)
1843
super(WorkingTreeFormat2, self).__init__()
1844
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1846
def open(self, a_bzrdir, _found=False):
1847
"""Return the WorkingTree object for a_bzrdir
1849
_found is a private parameter, do not use it. It is used to indicate
1850
if format probing has already been done.
1853
# we are being called directly and must probe.
1854
raise NotImplementedError
1855
if not isinstance(a_bzrdir.transport, LocalTransport):
1856
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1857
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1863
class WorkingTreeFormat3(WorkingTreeFormat):
1864
"""The second working tree format updated to record a format marker.
1867
- exists within a metadir controlling .bzr
1868
- includes an explicit version marker for the workingtree control
1869
files, separate from the BzrDir format
1870
- modifies the hash cache format
1872
- uses a LockDir to guard access for writes.
1875
def get_format_string(self):
1876
"""See WorkingTreeFormat.get_format_string()."""
1877
return "Bazaar-NG Working Tree format 3"
1879
def get_format_description(self):
1880
"""See WorkingTreeFormat.get_format_description()."""
1881
return "Working tree format 3"
1883
_lock_file_name = 'lock'
1884
_lock_class = LockDir
1886
def _open_control_files(self, a_bzrdir):
1887
transport = a_bzrdir.get_workingtree_transport(None)
1888
return LockableFiles(transport, self._lock_file_name,
1891
def initialize(self, a_bzrdir, revision_id=None):
1892
"""See WorkingTreeFormat.initialize().
1894
revision_id allows creating a working tree at a different
1895
revision than the branch is at.
1897
if not isinstance(a_bzrdir.transport, LocalTransport):
1898
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1899
transport = a_bzrdir.get_workingtree_transport(self)
1900
control_files = self._open_control_files(a_bzrdir)
1901
control_files.create_lock()
1902
control_files.lock_write()
1903
control_files.put_utf8('format', self.get_format_string())
1904
branch = a_bzrdir.open_branch()
1905
if revision_id is None:
1906
revision_id = branch.last_revision()
1908
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1914
_control_files=control_files)
1917
wt._write_inventory(inv)
1918
wt.set_root_id(inv.root.file_id)
1919
basis_tree = branch.repository.revision_tree(revision_id)
1920
if revision_id == bzrlib.revision.NULL_REVISION:
1921
wt.set_parent_trees([])
1923
wt.set_parent_trees([(revision_id, basis_tree)])
1924
build_tree(basis_tree, wt)
1927
control_files.unlock()
1931
super(WorkingTreeFormat3, self).__init__()
1932
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1934
def open(self, a_bzrdir, _found=False):
1935
"""Return the WorkingTree object for a_bzrdir
1937
_found is a private parameter, do not use it. It is used to indicate
1938
if format probing has already been done.
1941
# we are being called directly and must probe.
1942
raise NotImplementedError
1943
if not isinstance(a_bzrdir.transport, LocalTransport):
1944
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1945
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1947
def _open(self, a_bzrdir, control_files):
1948
"""Open the tree itself.
1950
:param a_bzrdir: the dir for the tree.
1951
:param control_files: the control files for the tree.
1953
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1957
_control_files=control_files)
1960
return self.get_format_string()
1963
# formats which have no format string are not discoverable
1964
# and not independently creatable, so are not registered.
1965
__default_format = WorkingTreeFormat3()
1966
WorkingTreeFormat.register_format(__default_format)
1967
WorkingTreeFormat.set_default_format(__default_format)
1968
_legacy_formats = [WorkingTreeFormat2(),
1972
class WorkingTreeTestProviderAdapter(object):
1973
"""A tool to generate a suite testing multiple workingtree formats at once.
1975
This is done by copying the test once for each transport and injecting
1976
the transport_server, transport_readonly_server, and workingtree_format
1977
classes into each copy. Each copy is also given a new id() to make it
1981
def __init__(self, transport_server, transport_readonly_server, formats):
1982
self._transport_server = transport_server
1983
self._transport_readonly_server = transport_readonly_server
1984
self._formats = formats
1986
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1987
"""Clone test for adaption."""
1988
new_test = deepcopy(test)
1989
new_test.transport_server = self._transport_server
1990
new_test.transport_readonly_server = self._transport_readonly_server
1991
new_test.bzrdir_format = bzrdir_format
1992
new_test.workingtree_format = workingtree_format
1993
def make_new_test_id():
1994
new_id = "%s(%s)" % (test.id(), variation)
1995
return lambda: new_id
1996
new_test.id = make_new_test_id()
1999
def adapt(self, test):
2000
from bzrlib.tests import TestSuite
2001
result = TestSuite()
2002
for workingtree_format, bzrdir_format in self._formats:
2003
new_test = self._clone_test(
2006
workingtree_format, workingtree_format.__class__.__name__)
2007
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
