14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
19
# FIXME: I don't know if writing out the cache from the destructor is really a
20
# good idea, because destructors are considered poor taste in Python, and
21
# it's not predictable when it will be written out.
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 copy import deepcopy
43
from cStringIO import StringIO
51
from bzrlib.atomicfile import AtomicFile
52
from bzrlib.branch import (Branch,
54
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
55
import bzrlib.bzrdir as bzrdir
56
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
import bzrlib.errors as errors
58
from bzrlib.errors import (BzrCheckError,
62
WeaveRevisionNotPresent,
66
MergeModifiedFormatError,
69
from bzrlib.inventory import InventoryEntry, Inventory
70
from bzrlib.lockable_files import LockableFiles, TransportLock
71
from bzrlib.lockdir import LockDir
72
from bzrlib.merge import merge_inner, transform_tree
73
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 *
95
from bzrlib.textui import show_status
27
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
28
from bzrlib.errors import BzrCheckError
29
from bzrlib.trace import mutter
97
from bzrlib.transform import build_tree
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport import get_transport
100
from bzrlib.transport.local import LocalTransport
105
def _get_non_word_re():
106
"""Get the compiled regular expression for non-unicode words."""
108
if _non_word_re is None:
110
# TODO: jam 20060106 Currently the BZR codebase can't really handle
111
# unicode ids. There are a lot of code paths which don't
112
# expect them. And we need to do more serious testing
113
# before we enable unicode in ids.
114
#_non_word_re = re.compile(r'[^\w.]', re.UNICODE)
115
_non_word_re = re.compile(r'[^\w.]')
119
def gen_file_id(name):
120
"""Return new file id.
122
This should probably generate proper UUIDs, but for the moment we
123
cope with just randomness because running uuidgen every time is
126
from binascii import hexlify
127
from time import time
130
idx = name.rfind('/')
132
name = name[idx+1 : ]
133
idx = name.rfind('\\')
135
name = name[idx+1 : ]
137
# make it not a hidden file
138
name = name.lstrip('.')
140
# remove any wierd characters; we don't escape them but rather
142
non_word = _get_non_word_re()
143
name = non_word.sub('', name)
145
s = hexlify(rand_bytes(8))
146
return '-'.join((name, compact_date(time()), s))
150
"""Return a new tree-root file id."""
151
return gen_file_id('TREE_ROOT')
154
class TreeEntry(object):
155
"""An entry that implements the minium interface used by commands.
157
This needs further inspection, it may be better to have
158
InventoryEntries without ids - though that seems wrong. For now,
159
this is a parallel hierarchy to InventoryEntry, and needs to become
160
one of several things: decorates to that hierarchy, children of, or
162
Another note is that these objects are currently only used when there is
163
no InventoryEntry available - i.e. for unversioned objects.
164
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
167
def __eq__(self, other):
168
# yes, this us ugly, TODO: best practice __eq__ style.
169
return (isinstance(other, TreeEntry)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class TreeDirectory(TreeEntry):
177
"""See TreeEntry. This is a directory in a working tree."""
179
def __eq__(self, other):
180
return (isinstance(other, TreeDirectory)
181
and other.__class__ == self.__class__)
183
def kind_character(self):
187
class TreeFile(TreeEntry):
188
"""See TreeEntry. This is a regular file in a working tree."""
190
def __eq__(self, other):
191
return (isinstance(other, TreeFile)
192
and other.__class__ == self.__class__)
194
def kind_character(self):
198
class TreeLink(TreeEntry):
199
"""See TreeEntry. This is a symlink in a working tree."""
201
def __eq__(self, other):
202
return (isinstance(other, TreeLink)
203
and other.__class__ == self.__class__)
205
def kind_character(self):
31
209
class WorkingTree(bzrlib.tree.Tree):
32
210
"""Working copy tree.
37
215
It is possible for a `WorkingTree` to have a filename which is
38
216
not listed in the Inventory and vice versa.
40
def __init__(self, basedir, inv):
219
def __init__(self, basedir='.',
220
branch=DEPRECATED_PARAMETER,
226
"""Construct a WorkingTree for basedir.
228
If the branch is not supplied, it is opened automatically.
229
If the branch is supplied, it must be the branch for this basedir.
230
(branch.base is not cross checked, because for remote branches that
231
would be meaningless).
233
self._format = _format
234
self.bzrdir = _bzrdir
236
# not created via open etc.
237
warn("WorkingTree() is deprecated as of bzr version 0.8. "
238
"Please use bzrdir.open_workingtree or WorkingTree.open().",
241
wt = WorkingTree.open(basedir)
242
self._branch = wt.branch
243
self.basedir = wt.basedir
244
self._control_files = wt._control_files
245
self._hashcache = wt._hashcache
246
self._set_inventory(wt._inventory)
247
self._format = wt._format
248
self.bzrdir = wt.bzrdir
41
249
from bzrlib.hashcache import HashCache
42
250
from bzrlib.trace import note, mutter
45
self.basedir = basedir
46
self.path2id = inv.path2id
251
assert isinstance(basedir, basestring), \
252
"base directory %r is not a string" % basedir
253
basedir = safe_unicode(basedir)
254
mutter("opening working tree %r", basedir)
255
if deprecated_passed(branch):
257
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
258
" Please use bzrdir.open_workingtree() or"
259
" WorkingTree.open().",
263
self._branch = branch
265
self._branch = self.bzrdir.open_branch()
266
assert isinstance(self.branch, Branch), \
267
"branch %r is not a Branch" % self.branch
268
self.basedir = realpath(basedir)
269
# if branch is at our basedir and is a format 6 or less
270
if isinstance(self._format, WorkingTreeFormat2):
271
# share control object
272
self._control_files = self.branch.control_files
274
# only ready for format 3
275
assert isinstance(self._format, WorkingTreeFormat3)
276
assert isinstance(_control_files, LockableFiles), \
277
"_control_files must be a LockableFiles, not %r" \
279
self._control_files = _control_files
48
280
# update the whole cache up front and write to disk if anything changed;
49
281
# in the future we might want to do this more selectively
50
hc = self._hashcache = HashCache(basedir)
282
# two possible ways offer themselves : in self._unlock, write the cache
283
# if needed, or, when the cache sees a change, append it to the hash
284
# cache file, and have the parser take the most recent entry for a
286
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
287
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
289
# is this scan needed ? it makes things kinda slow.
54
292
if hc.needs_write:
55
293
mutter("write hc")
60
if self._hashcache.needs_write:
61
self._hashcache.write()
296
if _inventory is None:
297
self._set_inventory(self.read_working_inventory())
299
self._set_inventory(_inventory)
302
fget=lambda self: self._branch,
303
doc="""The branch this WorkingTree is connected to.
305
This cannot be set - it is reflective of the actual disk structure
306
the working tree has been constructed from.
309
def _set_inventory(self, inv):
310
self._inventory = inv
311
self.path2id = self._inventory.path2id
313
def is_control_filename(self, filename):
314
"""True if filename is the name of a control file in this tree.
316
This is true IF and ONLY IF the filename is part of the meta data
317
that bzr controls in this tree. I.E. a random .bzr directory placed
318
on disk will not be a control file for this tree.
321
self.bzrdir.transport.relpath(self.abspath(filename))
323
except errors.PathNotChild:
327
def open(path=None, _unsupported=False):
328
"""Open an existing working tree at path.
332
path = os.path.getcwdu()
333
control = bzrdir.BzrDir.open(path, _unsupported)
334
return control.open_workingtree(_unsupported)
337
def open_containing(path=None):
338
"""Open an existing working tree which has its root about path.
340
This probes for a working tree at path and searches upwards from there.
342
Basically we keep looking up until we find the control directory or
343
run into /. If there isn't one, raises NotBranchError.
344
TODO: give this a new exception.
345
If there is one, it is returned, along with the unused portion of path.
349
control, relpath = bzrdir.BzrDir.open_containing(path)
350
return control.open_workingtree(), relpath
353
def open_downlevel(path=None):
354
"""Open an unsupported working tree.
356
Only intended for advanced situations like upgrading part of a bzrdir.
358
return WorkingTree.open(path, _unsupported=True)
64
360
def __iter__(self):
65
361
"""Iterate through file_ids for this tree.
91
441
def get_file_byname(self, filename):
92
442
return file(self.abspath(filename), 'rb')
444
def get_root_id(self):
445
"""Return the id of this trees root"""
446
inv = self.read_working_inventory()
447
return inv.root.file_id
94
449
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
96
return self.abspath(self.id2path(file_id))
450
## XXX: badly named; this is not in the store at all
451
return self.abspath(self.id2path(file_id))
454
def clone(self, to_bzrdir, revision_id=None, basis=None):
455
"""Duplicate this working tree into to_bzr, including all state.
457
Specifically modified files are kept as modified, but
458
ignored and unknown files are discarded.
460
If you want to make a new line of development, see bzrdir.sprout()
463
If not None, the cloned tree will have its last revision set to
464
revision, and and difference between the source trees last revision
465
and this one merged in.
468
If not None, a closer copy of a tree which may have some files in
469
common, and which file content should be preferentially copied from.
471
# assumes the target bzr dir format is compatible.
472
result = self._format.initialize(to_bzrdir)
473
self.copy_content_into(result, revision_id)
477
def copy_content_into(self, tree, revision_id=None):
478
"""Copy the current content and user files of this tree into tree."""
479
if revision_id is None:
480
transform_tree(tree, self)
482
# TODO now merge from tree.last_revision to revision
483
transform_tree(tree, self)
484
tree.set_last_revision(revision_id)
487
def commit(self, message=None, revprops=None, *args, **kwargs):
488
# avoid circular imports
489
from bzrlib.commit import Commit
492
if not 'branch-nick' in revprops:
493
revprops['branch-nick'] = self.branch.nick
494
# args for wt.commit start at message from the Commit.commit method,
495
# but with branch a kwarg now, passing in args as is results in the
496
#message being used for the branch
497
args = (DEPRECATED_PARAMETER, message, ) + args
498
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
499
self._set_inventory(self.read_working_inventory())
501
def id2abspath(self, file_id):
502
return self.abspath(self.id2path(file_id))
99
504
def has_id(self, file_id):
100
505
# files that have been deleted are excluded
101
506
inv = self._inventory
102
507
if not inv.has_id(file_id):
104
509
path = inv.id2path(file_id)
105
return os.path.exists(self.abspath(path))
510
return bzrlib.osutils.lexists(self.abspath(path))
512
def has_or_had_id(self, file_id):
513
if file_id == self.inventory.root.file_id:
515
return self.inventory.has_id(file_id)
108
517
__contains__ = has_id
111
519
def get_file_size(self, file_id):
112
# is this still called?
113
raise NotImplementedError()
520
return os.path.getsize(self.id2abspath(file_id))
116
523
def get_file_sha1(self, file_id):
117
524
path = self._inventory.id2path(file_id)
118
525
return self._hashcache.get_sha1(path)
527
def is_executable(self, file_id):
528
if not supports_executable():
529
return self._inventory[file_id].executable
531
path = self._inventory.id2path(file_id)
532
mode = os.lstat(self.abspath(path)).st_mode
533
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
536
def add(self, files, ids=None):
537
"""Make files versioned.
539
Note that the command line normally calls smart_add instead,
540
which can automatically recurse.
542
This adds the files to the inventory, so that they will be
543
recorded by the next commit.
546
List of paths to add, relative to the base of the tree.
549
If set, use these instead of automatically generated ids.
550
Must be the same length as the list of files, but may
551
contain None for ids that are to be autogenerated.
553
TODO: Perhaps have an option to add the ids even if the files do
556
TODO: Perhaps callback with the ids and paths as they're added.
558
# TODO: Re-adding a file that is removed in the working copy
559
# should probably put it back with the previous ID.
560
if isinstance(files, basestring):
561
assert(ids is None or isinstance(ids, basestring))
567
ids = [None] * len(files)
569
assert(len(ids) == len(files))
571
inv = self.read_working_inventory()
572
for f,file_id in zip(files, ids):
573
if self.is_control_filename(f):
574
raise BzrError("cannot add control file %s" % quotefn(f))
579
raise BzrError("cannot add top-level %r" % f)
581
fullpath = normpath(self.abspath(f))
584
kind = file_kind(fullpath)
586
if e.errno == errno.ENOENT:
587
raise NoSuchFile(fullpath)
588
# maybe something better?
589
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
591
if not InventoryEntry.versionable_kind(kind):
592
raise BzrError('cannot add: not a versionable file ('
593
'i.e. regular file, symlink or directory): %s' % quotefn(f))
596
file_id = gen_file_id(f)
597
inv.add_path(f, kind=kind, file_id=file_id)
599
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
600
self._write_inventory(inv)
603
def add_pending_merge(self, *revision_ids):
604
# TODO: Perhaps should check at this point that the
605
# history of the revision is actually present?
606
p = self.pending_merges()
608
for rev_id in revision_ids:
614
self.set_pending_merges(p)
617
def pending_merges(self):
618
"""Return a list of pending merges.
620
These are revisions that have been merged into the working
621
directory but not yet committed.
624
merges_file = self._control_files.get_utf8('pending-merges')
626
if e.errno != errno.ENOENT:
630
for l in merges_file.readlines():
631
p.append(l.rstrip('\n'))
635
def set_pending_merges(self, rev_list):
636
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
639
def set_merge_modified(self, modified_hashes):
641
for file_id, hash in modified_hashes.iteritems():
642
yield Stanza(file_id=file_id, hash=hash)
643
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
646
def _put_rio(self, filename, stanzas, header):
647
my_file = rio_file(stanzas, header)
648
self._control_files.put(filename, my_file)
651
def merge_modified(self):
653
hashfile = self._control_files.get('merge-hashes')
658
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
659
raise MergeModifiedFormatError()
660
except StopIteration:
661
raise MergeModifiedFormatError()
662
for s in RioReader(hashfile):
663
file_id = s.get("file_id")
664
if file_id not in self.inventory:
667
if hash == self.get_file_sha1(file_id):
668
merge_hashes[file_id] = hash
671
def get_symlink_target(self, file_id):
672
return os.readlink(self.id2abspath(file_id))
121
674
def file_class(self, filename):
122
675
if self.path2id(filename):
183
750
for ff in descend(fp, f_ie.file_id, fap):
186
for f in descend('', inv.root.file_id, self.basedir):
753
for f in descend(u'', inv.root.file_id, self.basedir):
757
def move(self, from_paths, to_name):
760
to_name must exist in the inventory.
762
If to_name exists and is a directory, the files are moved into
763
it, keeping their old names.
765
Note that to_name is only the last component of the new name;
766
this doesn't change the directory.
768
This returns a list of (from_path, to_path) pairs for each
772
## TODO: Option to move IDs only
773
assert not isinstance(from_paths, basestring)
775
to_abs = self.abspath(to_name)
776
if not isdir(to_abs):
777
raise BzrError("destination %r is not a directory" % to_abs)
778
if not self.has_filename(to_name):
779
raise BzrError("destination %r not in working directory" % to_abs)
780
to_dir_id = inv.path2id(to_name)
781
if to_dir_id == None and to_name != '':
782
raise BzrError("destination %r is not a versioned directory" % to_name)
783
to_dir_ie = inv[to_dir_id]
784
if to_dir_ie.kind not in ('directory', 'root_directory'):
785
raise BzrError("destination %r is not a directory" % to_abs)
787
to_idpath = inv.get_idpath(to_dir_id)
790
if not self.has_filename(f):
791
raise BzrError("%r does not exist in working tree" % f)
792
f_id = inv.path2id(f)
794
raise BzrError("%r is not versioned" % f)
795
name_tail = splitpath(f)[-1]
796
dest_path = appendpath(to_name, name_tail)
797
if self.has_filename(dest_path):
798
raise BzrError("destination %r already exists" % dest_path)
799
if f_id in to_idpath:
800
raise BzrError("can't move %r to a subdirectory of itself" % f)
802
# OK, so there's a race here, it's possible that someone will
803
# create a file in this interval and then the rename might be
804
# left half-done. But we should have caught most problems.
805
orig_inv = deepcopy(self.inventory)
808
name_tail = splitpath(f)[-1]
809
dest_path = appendpath(to_name, name_tail)
810
result.append((f, dest_path))
811
inv.rename(inv.path2id(f), to_dir_id, name_tail)
813
rename(self.abspath(f), self.abspath(dest_path))
815
raise BzrError("failed to rename %r to %r: %s" %
816
(f, dest_path, e[1]),
817
["rename rolled back"])
819
# restore the inventory on error
820
self._set_inventory(orig_inv)
822
self._write_inventory(inv)
826
def rename_one(self, from_rel, to_rel):
829
This can change the directory or the filename or both.
832
if not self.has_filename(from_rel):
833
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
834
if self.has_filename(to_rel):
835
raise BzrError("can't rename: new working file %r already exists" % to_rel)
837
file_id = inv.path2id(from_rel)
839
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
842
from_parent = entry.parent_id
843
from_name = entry.name
845
if inv.path2id(to_rel):
846
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
848
to_dir, to_tail = os.path.split(to_rel)
849
to_dir_id = inv.path2id(to_dir)
850
if to_dir_id == None and to_dir != '':
851
raise BzrError("can't determine destination directory id for %r" % to_dir)
853
mutter("rename_one:")
854
mutter(" file_id {%s}" % file_id)
855
mutter(" from_rel %r" % from_rel)
856
mutter(" to_rel %r" % to_rel)
857
mutter(" to_dir %r" % to_dir)
858
mutter(" to_dir_id {%s}" % to_dir_id)
860
inv.rename(file_id, to_dir_id, to_tail)
862
from_abs = self.abspath(from_rel)
863
to_abs = self.abspath(to_rel)
865
rename(from_abs, to_abs)
867
inv.rename(file_id, from_parent, from_name)
868
raise BzrError("failed to rename %r to %r: %s"
869
% (from_abs, to_abs, e[1]),
870
["rename rolled back"])
871
self._write_inventory(inv)
191
874
def unknowns(self):
875
"""Return all unknown files.
877
These are files in the working directory that are not versioned or
878
control files or ignored.
880
>>> from bzrlib.bzrdir import ScratchDir
881
>>> d = ScratchDir(files=['foo', 'foo~'])
882
>>> b = d.open_branch()
883
>>> tree = d.open_workingtree()
884
>>> map(str, tree.unknowns())
887
>>> list(b.unknowns())
889
>>> tree.remove('foo')
890
>>> list(b.unknowns())
192
893
for subp in self.extras():
193
894
if not self.is_ignored(subp):
897
@deprecated_method(zero_eight)
898
def iter_conflicts(self):
899
"""List all files in the tree that have text or content conflicts.
900
DEPRECATED. Use conflicts instead."""
901
return self._iter_conflicts()
903
def _iter_conflicts(self):
905
for path in (s[0] for s in self.list_files()):
906
stem = get_conflicted_stem(path)
909
if stem not in conflicted:
914
def pull(self, source, overwrite=False, stop_revision=None):
915
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
918
pp = ProgressPhase("Pull phase", 2, top_pb)
920
old_revision_history = self.branch.revision_history()
921
basis_tree = self.basis_tree()
922
count = self.branch.pull(source, overwrite, stop_revision)
923
new_revision_history = self.branch.revision_history()
924
if new_revision_history != old_revision_history:
926
if len(old_revision_history):
927
other_revision = old_revision_history[-1]
929
other_revision = None
930
repository = self.branch.repository
931
pb = bzrlib.ui.ui_factory.nested_progress_bar()
933
merge_inner(self.branch,
934
self.branch.basis_tree(),
940
self.set_last_revision(self.branch.last_revision())
197
946
def extras(self):
198
947
"""Yield all unknown files in this WorkingTree.
1042
def kind(self, file_id):
1043
return file_kind(self.id2abspath(file_id))
1046
def last_revision(self):
1047
"""Return the last revision id of this working tree.
1049
In early branch formats this was == the branch last_revision,
1050
but that cannot be relied upon - for working tree operations,
1051
always use tree.last_revision().
1053
return self.branch.last_revision()
1055
def lock_read(self):
1056
"""See Branch.lock_read, and WorkingTree.unlock."""
1057
self.branch.lock_read()
1059
return self._control_files.lock_read()
1061
self.branch.unlock()
1064
def lock_write(self):
1065
"""See Branch.lock_write, and WorkingTree.unlock."""
1066
self.branch.lock_write()
1068
return self._control_files.lock_write()
1070
self.branch.unlock()
1073
def _basis_inventory_name(self):
1074
return 'basis-inventory'
1077
def set_last_revision(self, new_revision):
1078
"""Change the last revision in the working tree."""
1079
if self._change_last_revision(new_revision):
1080
self._cache_basis_inventory(new_revision)
1082
def _change_last_revision(self, new_revision):
1083
"""Template method part of set_last_revision to perform the change.
1085
This is used to allow WorkingTree3 instances to not affect branch
1086
when their last revision is set.
1088
if new_revision is None:
1089
self.branch.set_revision_history([])
1091
# current format is locked in with the branch
1092
revision_history = self.branch.revision_history()
1094
position = revision_history.index(new_revision)
1096
raise errors.NoSuchRevision(self.branch, new_revision)
1097
self.branch.set_revision_history(revision_history[:position + 1])
1100
def _cache_basis_inventory(self, new_revision):
1101
"""Cache new_revision as the basis inventory."""
1103
# this double handles the inventory - unpack and repack -
1104
# but is easier to understand. We can/should put a conditional
1105
# in here based on whether the inventory is in the latest format
1106
# - perhaps we should repack all inventories on a repository
1108
inv = self.branch.repository.get_inventory(new_revision)
1109
inv.revision_id = new_revision
1110
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1112
path = self._basis_inventory_name()
1113
self._control_files.put_utf8(path, xml)
1114
except WeaveRevisionNotPresent:
1117
def read_basis_inventory(self):
1118
"""Read the cached basis inventory."""
1119
path = self._basis_inventory_name()
1120
return self._control_files.get_utf8(path).read()
1123
def read_working_inventory(self):
1124
"""Read the working inventory."""
1125
# ElementTree does its own conversion from UTF-8, so open in
1127
result = bzrlib.xml5.serializer_v5.read_inventory(
1128
self._control_files.get('inventory'))
1129
self._set_inventory(result)
1133
def remove(self, files, verbose=False):
1134
"""Remove nominated files from the working inventory..
1136
This does not remove their text. This does not run on XXX on what? RBC
1138
TODO: Refuse to remove modified files unless --force is given?
1140
TODO: Do something useful with directories.
1142
TODO: Should this remove the text or not? Tough call; not
1143
removing may be useful and the user can just use use rm, and
1144
is the opposite of add. Removing it is consistent with most
1145
other tools. Maybe an option.
1147
## TODO: Normalize names
1148
## TODO: Remove nested loops; better scalability
1149
if isinstance(files, basestring):
1152
inv = self.inventory
1154
# do this before any modifications
1156
fid = inv.path2id(f)
1158
# TODO: Perhaps make this just a warning, and continue?
1159
# This tends to happen when
1160
raise NotVersionedError(path=f)
1161
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1163
# having remove it, it must be either ignored or unknown
1164
if self.is_ignored(f):
1168
show_status(new_status, inv[fid].kind, quotefn(f))
1171
self._write_inventory(inv)
1174
def revert(self, filenames, old_tree=None, backups=True,
1175
pb=DummyProgress()):
1176
from transform import revert
1177
from conflicts import resolve
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
conflicts = revert(self, old_tree, filenames, backups, pb)
1181
if not len(filenames):
1182
self.set_pending_merges([])
1185
resolve(self, filenames, ignore_misses=True)
1188
# XXX: This method should be deprecated in favour of taking in a proper
1189
# new Inventory object.
1191
def set_inventory(self, new_inventory_list):
1192
from bzrlib.inventory import (Inventory,
1197
inv = Inventory(self.get_root_id())
1198
for path, file_id, parent, kind in new_inventory_list:
1199
name = os.path.basename(path)
1202
# fixme, there should be a factory function inv,add_??
1203
if kind == 'directory':
1204
inv.add(InventoryDirectory(file_id, name, parent))
1205
elif kind == 'file':
1206
inv.add(InventoryFile(file_id, name, parent))
1207
elif kind == 'symlink':
1208
inv.add(InventoryLink(file_id, name, parent))
1210
raise BzrError("unknown kind %r" % kind)
1211
self._write_inventory(inv)
1214
def set_root_id(self, file_id):
1215
"""Set the root id for this tree."""
1216
inv = self.read_working_inventory()
1217
orig_root_id = inv.root.file_id
1218
del inv._byid[inv.root.file_id]
1219
inv.root.file_id = file_id
1220
inv._byid[inv.root.file_id] = inv.root
1223
if entry.parent_id == orig_root_id:
1224
entry.parent_id = inv.root.file_id
1225
self._write_inventory(inv)
1228
"""See Branch.unlock.
1230
WorkingTree locking just uses the Branch locking facilities.
1231
This is current because all working trees have an embedded branch
1232
within them. IF in the future, we were to make branch data shareable
1233
between multiple working trees, i.e. via shared storage, then we
1234
would probably want to lock both the local tree, and the branch.
1236
# FIXME: We want to write out the hashcache only when the last lock on
1237
# this working copy is released. Peeking at the lock count is a bit
1238
# of a nasty hack; probably it's better to have a transaction object,
1239
# which can do some finalization when it's either successfully or
1240
# unsuccessfully completed. (Denys's original patch did that.)
1241
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1242
# wrongly. Hookinh into unllock on the control files object is fine though.
1244
# TODO: split this per format so there is no ugly if block
1245
if self._hashcache.needs_write and (
1246
# dedicated lock files
1247
self._control_files._lock_count==1 or
1249
(self._control_files is self.branch.control_files and
1250
self._control_files._lock_count==3)):
1251
self._hashcache.write()
1252
# reverse order of locking.
1253
result = self._control_files.unlock()
1255
self.branch.unlock()
1261
"""Update a working tree along its branch.
1263
This will update the branch if its bound too, which means we have multiple trees involved:
1264
The new basis tree of the master.
1265
The old basis tree of the branch.
1266
The old basis tree of the working tree.
1267
The current working tree state.
1268
pathologically all three may be different, and non ancestors of each other.
1269
Conceptually we want to:
1270
Preserve the wt.basis->wt.state changes
1271
Transform the wt.basis to the new master basis.
1272
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1273
Restore the wt.basis->wt.state changes.
1275
There isn't a single operation at the moment to do that, so we:
1276
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1277
Do a 'normal' merge of the old branch basis if it is relevant.
1279
old_tip = self.branch.update()
1280
if old_tip is not None:
1281
self.add_pending_merge(old_tip)
1282
self.branch.lock_read()
1285
if self.last_revision() != self.branch.last_revision():
1286
# merge tree state up to new branch tip.
1287
basis = self.basis_tree()
1288
to_tree = self.branch.basis_tree()
1289
result += merge_inner(self.branch,
1293
self.set_last_revision(self.branch.last_revision())
1294
if old_tip and old_tip != self.last_revision():
1295
# our last revision was not the prior branch last reivison
1296
# and we have converted that last revision to a pending merge.
1297
# base is somewhere between the branch tip now
1298
# and the now pending merge
1299
from bzrlib.revision import common_ancestor
1301
base_rev_id = common_ancestor(self.branch.last_revision(),
1303
self.branch.repository)
1304
except errors.NoCommonAncestor:
1306
base_tree = self.branch.repository.revision_tree(base_rev_id)
1307
other_tree = self.branch.repository.revision_tree(old_tip)
1308
result += merge_inner(self.branch,
1314
self.branch.unlock()
1317
def _write_inventory(self, inv):
1318
"""Write inventory as the current inventory."""
1320
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1322
self._control_files.put('inventory', sio)
1323
self._set_inventory(inv)
1324
mutter('wrote working inventory')
1326
def set_conflicts(self, arg):
1327
raise UnsupportedOperation(self.set_conflicts, self)
1330
def conflicts(self):
1331
conflicts = ConflictList()
1332
for conflicted in self._iter_conflicts():
1335
if file_kind(self.abspath(conflicted)) != "file":
1338
if e.errno == errno.ENOENT:
1343
for suffix in ('.THIS', '.OTHER'):
1345
kind = file_kind(self.abspath(conflicted+suffix))
1347
if e.errno == errno.ENOENT:
1355
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1356
conflicts.append(Conflict.factory(ctype, path=conflicted,
1357
file_id=self.path2id(conflicted)))
1361
class WorkingTree3(WorkingTree):
1362
"""This is the Format 3 working tree.
1364
This differs from the base WorkingTree by:
1365
- having its own file lock
1366
- having its own last-revision property.
1368
This is new in bzr 0.8
1372
def last_revision(self):
1373
"""See WorkingTree.last_revision."""
1375
return self._control_files.get_utf8('last-revision').read()
1379
def _change_last_revision(self, revision_id):
1380
"""See WorkingTree._change_last_revision."""
1381
if revision_id is None or revision_id == NULL_REVISION:
1383
self._control_files._transport.delete('last-revision')
1384
except errors.NoSuchFile:
1389
self.branch.revision_history().index(revision_id)
1391
raise errors.NoSuchRevision(self.branch, revision_id)
1392
self._control_files.put_utf8('last-revision', revision_id)
1396
def set_conflicts(self, conflicts):
1397
self._put_rio('conflicts', conflicts.to_stanzas(),
1401
def conflicts(self):
1403
confile = self._control_files.get('conflicts')
1405
return ConflictList()
1407
if confile.next() != CONFLICT_HEADER_1 + '\n':
1408
raise ConflictFormatError()
1409
except StopIteration:
1410
raise ConflictFormatError()
1411
return ConflictList.from_stanzas(RioReader(confile))
1414
def get_conflicted_stem(path):
1415
for suffix in CONFLICT_SUFFIXES:
1416
if path.endswith(suffix):
1417
return path[:-len(suffix)]
1419
@deprecated_function(zero_eight)
1420
def is_control_file(filename):
1421
"""See WorkingTree.is_control_filename(filename)."""
1422
## FIXME: better check
1423
filename = normpath(filename)
1424
while filename != '':
1425
head, tail = os.path.split(filename)
1426
## mutter('check %r for control file' % ((head, tail),))
1429
if filename == head:
1435
class WorkingTreeFormat(object):
1436
"""An encapsulation of the initialization and open routines for a format.
1438
Formats provide three things:
1439
* An initialization routine,
1443
Formats are placed in an dict by their format string for reference
1444
during workingtree opening. Its not required that these be instances, they
1445
can be classes themselves with class methods - it simply depends on
1446
whether state is needed for a given format or not.
1448
Once a format is deprecated, just deprecate the initialize and open
1449
methods on the format class. Do not deprecate the object, as the
1450
object will be created every time regardless.
1453
_default_format = None
1454
"""The default format used for new trees."""
1457
"""The known formats."""
1460
def find_format(klass, a_bzrdir):
1461
"""Return the format for the working tree object in a_bzrdir."""
1463
transport = a_bzrdir.get_workingtree_transport(None)
1464
format_string = transport.get("format").read()
1465
return klass._formats[format_string]
1467
raise errors.NoWorkingTree(base=transport.base)
1469
raise errors.UnknownFormatError(format_string)
1472
def get_default_format(klass):
1473
"""Return the current default format."""
1474
return klass._default_format
1476
def get_format_string(self):
1477
"""Return the ASCII format string that identifies this format."""
1478
raise NotImplementedError(self.get_format_string)
1480
def get_format_description(self):
1481
"""Return the short description for this format."""
1482
raise NotImplementedError(self.get_format_description)
1484
def is_supported(self):
1485
"""Is this format supported?
1487
Supported formats can be initialized and opened.
1488
Unsupported formats may not support initialization or committing or
1489
some other features depending on the reason for not being supported.
1494
def register_format(klass, format):
1495
klass._formats[format.get_format_string()] = format
1498
def set_default_format(klass, format):
1499
klass._default_format = format
1502
def unregister_format(klass, format):
1503
assert klass._formats[format.get_format_string()] is format
1504
del klass._formats[format.get_format_string()]
1508
class WorkingTreeFormat2(WorkingTreeFormat):
1509
"""The second working tree format.
1511
This format modified the hash cache from the format 1 hash cache.
1514
def get_format_description(self):
1515
"""See WorkingTreeFormat.get_format_description()."""
1516
return "Working tree format 2"
1518
def initialize(self, a_bzrdir, revision_id=None):
1519
"""See WorkingTreeFormat.initialize()."""
1520
if not isinstance(a_bzrdir.transport, LocalTransport):
1521
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1522
branch = a_bzrdir.open_branch()
1523
if revision_id is not None:
1526
revision_history = branch.revision_history()
1528
position = revision_history.index(revision_id)
1530
raise errors.NoSuchRevision(branch, revision_id)
1531
branch.set_revision_history(revision_history[:position + 1])
1534
revision = branch.last_revision()
1536
wt = WorkingTree(a_bzrdir.root_transport.base,
1542
wt._write_inventory(inv)
1543
wt.set_root_id(inv.root.file_id)
1544
wt.set_last_revision(revision)
1545
wt.set_pending_merges([])
1546
build_tree(wt.basis_tree(), wt)
1550
super(WorkingTreeFormat2, self).__init__()
1551
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1553
def open(self, a_bzrdir, _found=False):
1554
"""Return the WorkingTree object for a_bzrdir
1556
_found is a private parameter, do not use it. It is used to indicate
1557
if format probing has already been done.
1560
# we are being called directly and must probe.
1561
raise NotImplementedError
1562
if not isinstance(a_bzrdir.transport, LocalTransport):
1563
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1564
return WorkingTree(a_bzrdir.root_transport.base,
1570
class WorkingTreeFormat3(WorkingTreeFormat):
1571
"""The second working tree format updated to record a format marker.
1574
- exists within a metadir controlling .bzr
1575
- includes an explicit version marker for the workingtree control
1576
files, separate from the BzrDir format
1577
- modifies the hash cache format
1579
- uses a LockDir to guard access to the repository
1582
def get_format_string(self):
1583
"""See WorkingTreeFormat.get_format_string()."""
1584
return "Bazaar-NG Working Tree format 3"
1586
def get_format_description(self):
1587
"""See WorkingTreeFormat.get_format_description()."""
1588
return "Working tree format 3"
1590
_lock_file_name = 'lock'
1591
_lock_class = LockDir
1593
def _open_control_files(self, a_bzrdir):
1594
transport = a_bzrdir.get_workingtree_transport(None)
1595
return LockableFiles(transport, self._lock_file_name,
1598
def initialize(self, a_bzrdir, revision_id=None):
1599
"""See WorkingTreeFormat.initialize().
1601
revision_id allows creating a working tree at a differnet
1602
revision than the branch is at.
1604
if not isinstance(a_bzrdir.transport, LocalTransport):
1605
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1606
transport = a_bzrdir.get_workingtree_transport(self)
1607
control_files = self._open_control_files(a_bzrdir)
1608
control_files.create_lock()
1609
control_files.lock_write()
1610
control_files.put_utf8('format', self.get_format_string())
1611
branch = a_bzrdir.open_branch()
1612
if revision_id is None:
1613
revision_id = branch.last_revision()
1615
wt = WorkingTree3(a_bzrdir.root_transport.base,
1621
_control_files=control_files)
1624
wt._write_inventory(inv)
1625
wt.set_root_id(inv.root.file_id)
1626
wt.set_last_revision(revision_id)
1627
wt.set_pending_merges([])
1628
build_tree(wt.basis_tree(), wt)
1631
control_files.unlock()
1635
super(WorkingTreeFormat3, self).__init__()
1636
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1638
def open(self, a_bzrdir, _found=False):
1639
"""Return the WorkingTree object for a_bzrdir
1641
_found is a private parameter, do not use it. It is used to indicate
1642
if format probing has already been done.
1645
# we are being called directly and must probe.
1646
raise NotImplementedError
1647
if not isinstance(a_bzrdir.transport, LocalTransport):
1648
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1649
control_files = self._open_control_files(a_bzrdir)
1650
return WorkingTree3(a_bzrdir.root_transport.base,
1654
_control_files=control_files)
1657
return self.get_format_string()
1660
# formats which have no format string are not discoverable
1661
# and not independently creatable, so are not registered.
1662
__default_format = WorkingTreeFormat3()
1663
WorkingTreeFormat.register_format(__default_format)
1664
WorkingTreeFormat.set_default_format(__default_format)
1665
_legacy_formats = [WorkingTreeFormat2(),
1669
class WorkingTreeTestProviderAdapter(object):
1670
"""A tool to generate a suite testing multiple workingtree formats at once.
1672
This is done by copying the test once for each transport and injecting
1673
the transport_server, transport_readonly_server, and workingtree_format
1674
classes into each copy. Each copy is also given a new id() to make it
1678
def __init__(self, transport_server, transport_readonly_server, formats):
1679
self._transport_server = transport_server
1680
self._transport_readonly_server = transport_readonly_server
1681
self._formats = formats
1683
def adapt(self, test):
1684
from bzrlib.tests import TestSuite
1685
result = TestSuite()
1686
for workingtree_format, bzrdir_format in self._formats:
1687
new_test = deepcopy(test)
1688
new_test.transport_server = self._transport_server
1689
new_test.transport_readonly_server = self._transport_readonly_server
1690
new_test.bzrdir_format = bzrdir_format
1691
new_test.workingtree_format = workingtree_format
1692
def make_new_test_id():
1693
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1694
return lambda: new_id
1695
new_test.id = make_new_test_id()
1696
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
