25
25
At the moment every WorkingTree has its own branch. Remote
26
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
28
To get a WorkingTree, call Branch.working_tree():
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
32
# TODO: Don't allow WorkingTrees to be constructed for remote branches if
35
# FIXME: I don't know if writing out the cache from the destructor is really a
36
# good idea, because destructors are considered poor taste in Python, and it's
37
# not predictable when it will be written out.
35
39
# TODO: Give the workingtree sole responsibility for the working inventory;
36
40
# remove the variable and references to it from the branch. This may require
37
41
# updating the commit code so as to update the inventory within the working
38
42
# 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)
43
# At the momenthey may alias the inventory and have old copies of it in memory.
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
54
from bzrlib.atomicfile import AtomicFile
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
56
import bzrlib.bzrdir as bzrdir
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
import bzrlib.errors as errors
59
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 (
49
from bzrlib.branch import Branch, needs_read_lock, needs_write_lock, quotefn
51
from bzrlib.osutils import (appendpath,
90
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
92
from bzrlib.rio import RioReader, rio_file, Stanza
93
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.textui import show_status
102
from bzrlib.transform import build_tree
103
from bzrlib.trace import mutter, note
104
from bzrlib.transport import get_transport
105
from bzrlib.transport.local import LocalTransport
106
import bzrlib.urlutils as urlutils
57
from bzrlib.errors import BzrCheckError, DivergedBranches, NotVersionedError
58
from bzrlib.trace import mutter
108
59
import bzrlib.xml5
111
# the regex here does the following:
112
# 1) remove any weird characters; we don't escape them but rather
114
# 2) match leading '.'s to make it not hidden
115
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
116
_gen_id_suffix = None
120
def _next_id_suffix():
121
"""Create a new file id suffix that is reasonably unique.
123
On the first call we combine the current time with 64 bits of randomness
124
to give a highly probably globally unique number. Then each call in the same
125
process adds 1 to a serial number we append to that unique value.
127
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
128
# than having to move the id randomness out of the inner loop like this.
129
# XXX TODO: for the global randomness this uses we should add the thread-id
130
# before the serial #.
131
global _gen_id_suffix, _gen_id_serial
132
if _gen_id_suffix is None:
133
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
135
return _gen_id_suffix + str(_gen_id_serial)
138
def gen_file_id(name):
139
"""Return new file id for the basename 'name'.
141
The uniqueness is supplied from _next_id_suffix.
143
# XXX TODO: squash the filename to lowercase.
144
# XXX TODO: truncate the filename to something like 20 or 30 chars.
145
# XXX TODO: consider what to do with ids that look like illegal filepaths
146
# on platforms we support.
147
return _gen_file_id_re.sub('', name) + _next_id_suffix()
151
"""Return a new tree-root file id."""
152
return gen_file_id('TREE_ROOT')
155
62
class TreeEntry(object):
156
"""An entry that implements the minimum interface used by commands.
63
"""An entry that implements the minium interface used by commands.
158
65
This needs further inspection, it may be better to have
159
66
InventoryEntries without ids - though that seems wrong. For now,
231
132
(branch.base is not cross checked, because for remote branches that
232
133
would be meaningless).
234
self._format = _format
235
self.bzrdir = _bzrdir
237
# not created via open etc.
238
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
239
"Please use bzrdir.open_workingtree or WorkingTree.open().",
242
wt = WorkingTree.open(basedir)
243
self._branch = wt.branch
244
self.basedir = wt.basedir
245
self._control_files = wt._control_files
246
self._hashcache = wt._hashcache
247
self._set_inventory(wt._inventory)
248
self._format = wt._format
249
self.bzrdir = wt.bzrdir
250
135
from bzrlib.hashcache import HashCache
251
136
from bzrlib.trace import note, mutter
252
137
assert isinstance(basedir, basestring), \
253
138
"base directory %r is not a string" % basedir
254
basedir = safe_unicode(basedir)
255
mutter("opening working tree %r", basedir)
256
if deprecated_passed(branch):
258
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
259
" Please use bzrdir.open_workingtree() or"
260
" WorkingTree.open().",
264
self._branch = branch
266
self._branch = self.bzrdir.open_branch()
267
self.basedir = realpath(basedir)
268
# if branch is at our basedir and is a format 6 or less
269
if isinstance(self._format, WorkingTreeFormat2):
270
# share control object
271
self._control_files = self.branch.control_files
273
# only ready for format 3
274
assert isinstance(self._format, WorkingTreeFormat3)
275
assert isinstance(_control_files, LockableFiles), \
276
"_control_files must be a LockableFiles, not %r" \
278
self._control_files = _control_files
140
branch = Branch.open(basedir)
141
assert isinstance(branch, Branch), \
142
"branch %r is not a Branch" % branch
144
self.basedir = basedir
145
self._inventory = self.read_working_inventory()
146
self.path2id = self._inventory.path2id
279
148
# update the whole cache up front and write to disk if anything changed;
280
149
# in the future we might want to do this more selectively
281
150
# two possible ways offer themselves : in self._unlock, write the cache
282
151
# if needed, or, when the cache sees a change, append it to the hash
283
152
# cache file, and have the parser take the most recent entry for a
284
153
# given path only.
285
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
286
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
154
hc = self._hashcache = HashCache(basedir)
288
# is this scan needed ? it makes things kinda slow.
291
158
if hc.needs_write:
292
159
mutter("write hc")
295
if _inventory is None:
296
self._set_inventory(self.read_working_inventory())
298
self._set_inventory(_inventory)
301
fget=lambda self: self._branch,
302
doc="""The branch this WorkingTree is connected to.
304
This cannot be set - it is reflective of the actual disk structure
305
the working tree has been constructed from.
308
def break_lock(self):
309
"""Break a lock if one is present from another instance.
311
Uses the ui factory to ask for confirmation if the lock may be from
314
This will probe the repository for its lock as well.
316
self._control_files.break_lock()
317
self.branch.break_lock()
319
def _set_inventory(self, inv):
320
self._inventory = inv
321
self.path2id = self._inventory.path2id
323
def is_control_filename(self, filename):
324
"""True if filename is the name of a control file in this tree.
326
:param filename: A filename within the tree. This is a relative path
327
from the root of this tree.
329
This is true IF and ONLY IF the filename is part of the meta data
330
that bzr controls in this tree. I.E. a random .bzr directory placed
331
on disk will not be a control file for this tree.
333
return self.bzrdir.is_control_filename(filename)
336
def open(path=None, _unsupported=False):
337
"""Open an existing working tree at path.
341
path = os.path.getcwdu()
342
control = bzrdir.BzrDir.open(path, _unsupported)
343
return control.open_workingtree(_unsupported)
346
def open_containing(path=None):
347
"""Open an existing working tree which has its root about path.
349
This probes for a working tree at path and searches upwards from there.
351
Basically we keep looking up until we find the control directory or
352
run into /. If there isn't one, raises NotBranchError.
353
TODO: give this a new exception.
354
If there is one, it is returned, along with the unused portion of path.
356
:return: The WorkingTree that contains 'path', and the rest of path
360
control, relpath = bzrdir.BzrDir.open_containing(path)
362
return control.open_workingtree(), relpath
365
def open_downlevel(path=None):
366
"""Open an unsupported working tree.
368
Only intended for advanced situations like upgrading part of a bzrdir.
370
return WorkingTree.open(path, _unsupported=True)
372
162
def __iter__(self):
373
163
"""Iterate through file_ids for this tree.
457
193
def get_file_byname(self, filename):
458
194
return file(self.abspath(filename), 'rb')
460
def get_parent_ids(self):
461
"""See Tree.get_parent_ids.
463
This implementation reads the pending merges list and last_revision
464
value and uses that to decide what the parents list should be.
466
last_rev = self.last_revision()
471
other_parents = self.pending_merges()
472
return parents + other_parents
474
196
def get_root_id(self):
475
197
"""Return the id of this trees root"""
476
198
inv = self.read_working_inventory()
477
199
return inv.root.file_id
479
201
def _get_store_filename(self, file_id):
480
## XXX: badly named; this is not in the store at all
202
## XXX: badly named; this isn't in the store at all
481
203
return self.abspath(self.id2path(file_id))
484
def clone(self, to_bzrdir, revision_id=None, basis=None):
485
"""Duplicate this working tree into to_bzr, including all state.
487
Specifically modified files are kept as modified, but
488
ignored and unknown files are discarded.
490
If you want to make a new line of development, see bzrdir.sprout()
493
If not None, the cloned tree will have its last revision set to
494
revision, and and difference between the source trees last revision
495
and this one merged in.
498
If not None, a closer copy of a tree which may have some files in
499
common, and which file content should be preferentially copied from.
501
# assumes the target bzr dir format is compatible.
502
result = self._format.initialize(to_bzrdir)
503
self.copy_content_into(result, revision_id)
507
def copy_content_into(self, tree, revision_id=None):
508
"""Copy the current content and user files of this tree into tree."""
509
if revision_id is None:
510
transform_tree(tree, self)
512
# TODO now merge from tree.last_revision to revision
513
transform_tree(tree, self)
514
tree.set_last_revision(revision_id)
516
205
@needs_write_lock
517
def commit(self, message=None, revprops=None, *args, **kwargs):
518
# avoid circular imports
206
def commit(self, *args, **kw):
519
207
from bzrlib.commit import Commit
522
if not 'branch-nick' in revprops:
523
revprops['branch-nick'] = self.branch.nick
524
# args for wt.commit start at message from the Commit.commit method,
525
# but with branch a kwarg now, passing in args as is results in the
526
#message being used for the branch
527
args = (DEPRECATED_PARAMETER, message, ) + args
528
committed_id = Commit().commit( working_tree=self, revprops=revprops,
530
self._set_inventory(self.read_working_inventory())
208
Commit().commit(self.branch, *args, **kw)
209
self._inventory = self.read_working_inventory()
533
211
def id2abspath(self, file_id):
534
212
return self.abspath(self.id2path(file_id))
536
215
def has_id(self, file_id):
537
216
# files that have been deleted are excluded
538
217
inv = self._inventory
547
226
return self.inventory.has_id(file_id)
549
228
__contains__ = has_id
551
231
def get_file_size(self, file_id):
552
232
return os.path.getsize(self.id2abspath(file_id))
555
def get_file_sha1(self, file_id, path=None):
557
path = self._inventory.id2path(file_id)
234
def get_file_sha1(self, file_id):
235
path = self._inventory.id2path(file_id)
558
236
return self._hashcache.get_sha1(path)
560
def get_file_mtime(self, file_id, path=None):
562
path = self._inventory.id2path(file_id)
563
return os.lstat(self.abspath(path)).st_mtime
565
if not supports_executable():
566
def is_executable(self, file_id, path=None):
239
def is_executable(self, file_id):
567
241
return self._inventory[file_id].executable
569
def is_executable(self, file_id, path=None):
571
path = self._inventory.id2path(file_id)
243
path = self._inventory.id2path(file_id)
572
244
mode = os.lstat(self.abspath(path)).st_mode
573
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
576
def add(self, files, ids=None):
577
"""Make files versioned.
579
Note that the command line normally calls smart_add instead,
580
which can automatically recurse.
582
This adds the files to the inventory, so that they will be
583
recorded by the next commit.
586
List of paths to add, relative to the base of the tree.
589
If set, use these instead of automatically generated ids.
590
Must be the same length as the list of files, but may
591
contain None for ids that are to be autogenerated.
593
TODO: Perhaps have an option to add the ids even if the files do
596
TODO: Perhaps callback with the ids and paths as they're added.
598
# TODO: Re-adding a file that is removed in the working copy
599
# should probably put it back with the previous ID.
600
if isinstance(files, basestring):
601
assert(ids is None or isinstance(ids, basestring))
607
ids = [None] * len(files)
609
assert(len(ids) == len(files))
611
inv = self.read_working_inventory()
612
for f,file_id in zip(files, ids):
613
if self.is_control_filename(f):
614
raise errors.ForbiddenControlFileError(filename=f)
619
raise BzrError("cannot add top-level %r" % f)
621
fullpath = normpath(self.abspath(f))
623
kind = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise NoSuchFile(fullpath)
627
if not InventoryEntry.versionable_kind(kind):
628
raise errors.BadFileKindError(filename=f, kind=kind)
630
inv.add_path(f, kind=kind)
632
inv.add_path(f, kind=kind, file_id=file_id)
634
self._write_inventory(inv)
245
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
636
247
@needs_write_lock
637
248
def add_pending_merge(self, *revision_ids):
781
335
# make a last minute entry
783
yield fp[1:], c, fk, f_ie.file_id, f_ie
786
yield fp[1:], c, fk, None, fk_entries[fk]()
788
yield fp[1:], c, fk, None, TreeEntry()
339
if fk == 'directory':
340
entry = TreeDirectory()
343
elif fk == 'symlink':
348
yield fp, c, fk, (f_ie and f_ie.file_id), entry
791
350
if fk != 'directory':
794
# But do this child first
795
new_children = os.listdir(fap)
797
new_children = collections.deque(new_children)
798
stack.append((f_ie.file_id, fp, fap, new_children))
799
# Break out of inner loop, so that we start outer loop with child
802
# if we finished all children, pop it off the stack
807
def move(self, from_paths, to_name):
810
to_name must exist in the inventory.
812
If to_name exists and is a directory, the files are moved into
813
it, keeping their old names.
815
Note that to_name is only the last component of the new name;
816
this doesn't change the directory.
818
This returns a list of (from_path, to_path) pairs for each
822
## TODO: Option to move IDs only
823
assert not isinstance(from_paths, basestring)
825
to_abs = self.abspath(to_name)
826
if not isdir(to_abs):
827
raise BzrError("destination %r is not a directory" % to_abs)
828
if not self.has_filename(to_name):
829
raise BzrError("destination %r not in working directory" % to_abs)
830
to_dir_id = inv.path2id(to_name)
831
if to_dir_id == None and to_name != '':
832
raise BzrError("destination %r is not a versioned directory" % to_name)
833
to_dir_ie = inv[to_dir_id]
834
if to_dir_ie.kind not in ('directory', 'root_directory'):
835
raise BzrError("destination %r is not a directory" % to_abs)
837
to_idpath = inv.get_idpath(to_dir_id)
840
if not self.has_filename(f):
841
raise BzrError("%r does not exist in working tree" % f)
842
f_id = inv.path2id(f)
844
raise BzrError("%r is not versioned" % f)
845
name_tail = splitpath(f)[-1]
846
dest_path = pathjoin(to_name, name_tail)
847
if self.has_filename(dest_path):
848
raise BzrError("destination %r already exists" % dest_path)
849
if f_id in to_idpath:
850
raise BzrError("can't move %r to a subdirectory of itself" % f)
852
# OK, so there's a race here, it's possible that someone will
853
# create a file in this interval and then the rename might be
854
# left half-done. But we should have caught most problems.
855
orig_inv = deepcopy(self.inventory)
858
name_tail = splitpath(f)[-1]
859
dest_path = pathjoin(to_name, name_tail)
860
result.append((f, dest_path))
861
inv.rename(inv.path2id(f), to_dir_id, name_tail)
863
rename(self.abspath(f), self.abspath(dest_path))
865
raise BzrError("failed to rename %r to %r: %s" %
866
(f, dest_path, e[1]),
867
["rename rolled back"])
869
# restore the inventory on error
870
self._set_inventory(orig_inv)
872
self._write_inventory(inv)
876
def rename_one(self, from_rel, to_rel):
879
This can change the directory or the filename or both.
882
if not self.has_filename(from_rel):
883
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
884
if self.has_filename(to_rel):
885
raise BzrError("can't rename: new working file %r already exists" % to_rel)
887
file_id = inv.path2id(from_rel)
889
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
892
from_parent = entry.parent_id
893
from_name = entry.name
895
if inv.path2id(to_rel):
896
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
898
to_dir, to_tail = os.path.split(to_rel)
899
to_dir_id = inv.path2id(to_dir)
900
if to_dir_id == None and to_dir != '':
901
raise BzrError("can't determine destination directory id for %r" % to_dir)
903
mutter("rename_one:")
904
mutter(" file_id {%s}" % file_id)
905
mutter(" from_rel %r" % from_rel)
906
mutter(" to_rel %r" % to_rel)
907
mutter(" to_dir %r" % to_dir)
908
mutter(" to_dir_id {%s}" % to_dir_id)
910
inv.rename(file_id, to_dir_id, to_tail)
912
from_abs = self.abspath(from_rel)
913
to_abs = self.abspath(to_rel)
915
rename(from_abs, to_abs)
917
inv.rename(file_id, from_parent, from_name)
918
raise BzrError("failed to rename %r to %r: %s"
919
% (from_abs, to_abs, e[1]),
920
["rename rolled back"])
921
self._write_inventory(inv)
354
# don't descend unversioned directories
357
for ff in descend(fp, f_ie.file_id, fap):
360
for f in descend('', inv.root.file_id, self.basedir):
924
365
def unknowns(self):
925
"""Return all unknown files.
927
These are files in the working directory that are not versioned or
928
control files or ignored.
930
366
for subp in self.extras():
931
367
if not self.is_ignored(subp):
934
@deprecated_method(zero_eight)
935
370
def iter_conflicts(self):
936
"""List all files in the tree that have text or content conflicts.
937
DEPRECATED. Use conflicts instead."""
938
return self._iter_conflicts()
940
def _iter_conflicts(self):
941
371
conflicted = set()
942
for info in self.list_files():
372
for path in (s[0] for s in self.list_files()):
944
373
stem = get_conflicted_stem(path)
1116
467
# treat dotfiles correctly and allows * to match /.
1117
468
# Eventually it should be replaced with something more
1120
rules = self._get_ignore_rules_as_regex()
1121
for regex, mapping in rules:
1122
match = regex.match(filename)
1123
if match is not None:
1124
# one or more of the groups in mapping will have a non-None group
1126
groups = match.groups()
1127
rules = [mapping[group] for group in
1128
mapping if groups[group] is not None]
471
for pat in self.get_ignore_list():
472
if '/' in pat or '\\' in pat:
474
# as a special case, you can put ./ at the start of a
475
# pattern; this is good to match in the top-level
478
if (pat[:2] == './') or (pat[:2] == '.\\'):
482
if fnmatch.fnmatchcase(filename, newpat):
485
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1132
490
def kind(self, file_id):
1133
491
return file_kind(self.id2abspath(file_id))
1136
def last_revision(self):
1137
"""Return the last revision id of this working tree.
1139
In early branch formats this was == the branch last_revision,
1140
but that cannot be relied upon - for working tree operations,
1141
always use tree.last_revision().
1143
return self.branch.last_revision()
1145
def is_locked(self):
1146
return self._control_files.is_locked()
1148
493
def lock_read(self):
1149
494
"""See Branch.lock_read, and WorkingTree.unlock."""
1150
self.branch.lock_read()
1152
return self._control_files.lock_read()
1154
self.branch.unlock()
495
return self.branch.lock_read()
1157
497
def lock_write(self):
1158
498
"""See Branch.lock_write, and WorkingTree.unlock."""
1159
self.branch.lock_write()
1161
return self._control_files.lock_write()
1163
self.branch.unlock()
1166
def get_physical_lock_status(self):
1167
return self._control_files.get_physical_lock_status()
1169
def _basis_inventory_name(self):
1170
return 'basis-inventory'
1173
def set_last_revision(self, new_revision):
1174
"""Change the last revision in the working tree."""
1175
if self._change_last_revision(new_revision):
1176
self._cache_basis_inventory(new_revision)
1178
def _change_last_revision(self, new_revision):
1179
"""Template method part of set_last_revision to perform the change.
1181
This is used to allow WorkingTree3 instances to not affect branch
1182
when their last revision is set.
1184
if new_revision is None:
1185
self.branch.set_revision_history([])
1187
# current format is locked in with the branch
1188
revision_history = self.branch.revision_history()
1190
position = revision_history.index(new_revision)
1192
raise errors.NoSuchRevision(self.branch, new_revision)
1193
self.branch.set_revision_history(revision_history[:position + 1])
1196
def _cache_basis_inventory(self, new_revision):
1197
"""Cache new_revision as the basis inventory."""
1198
# TODO: this should allow the ready-to-use inventory to be passed in,
1199
# as commit already has that ready-to-use [while the format is the
1202
# this double handles the inventory - unpack and repack -
1203
# but is easier to understand. We can/should put a conditional
1204
# in here based on whether the inventory is in the latest format
1205
# - perhaps we should repack all inventories on a repository
1207
# the fast path is to copy the raw xml from the repository. If the
1208
# xml contains 'revision_id="', then we assume the right
1209
# revision_id is set. We must check for this full string, because a
1210
# root node id can legitimately look like 'revision_id' but cannot
1212
xml = self.branch.repository.get_inventory_xml(new_revision)
1213
if not 'revision_id="' in xml.split('\n', 1)[0]:
1214
inv = self.branch.repository.deserialise_inventory(
1216
inv.revision_id = new_revision
1217
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1218
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1219
path = self._basis_inventory_name()
1221
self._control_files.put(path, sio)
1222
except WeaveRevisionNotPresent:
1225
def read_basis_inventory(self):
1226
"""Read the cached basis inventory."""
1227
path = self._basis_inventory_name()
1228
return self._control_files.get(path).read()
499
return self.branch.lock_write()
1230
501
@needs_read_lock
1231
502
def read_working_inventory(self):
1232
503
"""Read the working inventory."""
1233
504
# ElementTree does its own conversion from UTF-8, so open in
1235
result = bzrlib.xml5.serializer_v5.read_inventory(
1236
self._control_files.get('inventory'))
1237
self._set_inventory(result)
506
f = self.branch.controlfile('inventory', 'rb')
507
return bzrlib.xml5.serializer_v5.read_inventory(f)
1240
509
@needs_write_lock
1241
def remove(self, files, verbose=False, to_file=None):
510
def remove(self, files, verbose=False):
1242
511
"""Remove nominated files from the working inventory..
1244
513
This does not remove their text. This does not run on XXX on what? RBC
1340
605
between multiple working trees, i.e. via shared storage, then we
1341
606
would probably want to lock both the local tree, and the branch.
1343
# FIXME: We want to write out the hashcache only when the last lock on
1344
# this working copy is released. Peeking at the lock count is a bit
1345
# of a nasty hack; probably it's better to have a transaction object,
1346
# which can do some finalization when it's either successfully or
1347
# unsuccessfully completed. (Denys's original patch did that.)
1348
# RBC 20060206 hooking into transaction will couple lock and transaction
1349
# wrongly. Hooking into unlock on the control files object is fine though.
1351
# TODO: split this per format so there is no ugly if block
1352
if self._hashcache.needs_write and (
1353
# dedicated lock files
1354
self._control_files._lock_count==1 or
1356
(self._control_files is self.branch.control_files and
1357
self._control_files._lock_count==3)):
1358
self._hashcache.write()
1359
# reverse order of locking.
1361
return self._control_files.unlock()
1363
self.branch.unlock()
1367
"""Update a working tree along its branch.
1369
This will update the branch if its bound too, which means we have multiple trees involved:
1370
The new basis tree of the master.
1371
The old basis tree of the branch.
1372
The old basis tree of the working tree.
1373
The current working tree state.
1374
pathologically all three may be different, and non ancestors of each other.
1375
Conceptually we want to:
1376
Preserve the wt.basis->wt.state changes
1377
Transform the wt.basis to the new master basis.
1378
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1379
Restore the wt.basis->wt.state changes.
1381
There isn't a single operation at the moment to do that, so we:
1382
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1383
Do a 'normal' merge of the old branch basis if it is relevant.
1385
old_tip = self.branch.update()
1386
if old_tip is not None:
1387
self.add_pending_merge(old_tip)
1388
self.branch.lock_read()
1391
if self.last_revision() != self.branch.last_revision():
1392
# merge tree state up to new branch tip.
1393
basis = self.basis_tree()
1394
to_tree = self.branch.basis_tree()
1395
result += merge_inner(self.branch,
1399
self.set_last_revision(self.branch.last_revision())
1400
if old_tip and old_tip != self.last_revision():
1401
# our last revision was not the prior branch last revision
1402
# and we have converted that last revision to a pending merge.
1403
# base is somewhere between the branch tip now
1404
# and the now pending merge
1405
from bzrlib.revision import common_ancestor
1407
base_rev_id = common_ancestor(self.branch.last_revision(),
1409
self.branch.repository)
1410
except errors.NoCommonAncestor:
1412
base_tree = self.branch.repository.revision_tree(base_rev_id)
1413
other_tree = self.branch.repository.revision_tree(old_tip)
1414
result += merge_inner(self.branch,
1420
self.branch.unlock()
608
return self.branch.unlock()
1422
610
@needs_write_lock
1423
611
def _write_inventory(self, inv):
1424
612
"""Write inventory as the current inventory."""
613
from cStringIO import StringIO
614
from bzrlib.atomicfile import AtomicFile
1425
615
sio = StringIO()
1426
616
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1428
self._control_files.put('inventory', sio)
1429
self._set_inventory(inv)
618
f = AtomicFile(self.branch.controlfilename('inventory'))
1430
624
mutter('wrote working inventory')
1432
def set_conflicts(self, arg):
1433
raise UnsupportedOperation(self.set_conflicts, self)
1436
def conflicts(self):
1437
conflicts = ConflictList()
1438
for conflicted in self._iter_conflicts():
1441
if file_kind(self.abspath(conflicted)) != "file":
1443
except errors.NoSuchFile:
1446
for suffix in ('.THIS', '.OTHER'):
1448
kind = file_kind(self.abspath(conflicted+suffix))
1451
except errors.NoSuchFile:
1455
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1456
conflicts.append(Conflict.factory(ctype, path=conflicted,
1457
file_id=self.path2id(conflicted)))
1461
class WorkingTree3(WorkingTree):
1462
"""This is the Format 3 working tree.
1464
This differs from the base WorkingTree by:
1465
- having its own file lock
1466
- having its own last-revision property.
1468
This is new in bzr 0.8
1472
def last_revision(self):
1473
"""See WorkingTree.last_revision."""
1475
return self._control_files.get_utf8('last-revision').read()
1479
def _change_last_revision(self, revision_id):
1480
"""See WorkingTree._change_last_revision."""
1481
if revision_id is None or revision_id == NULL_REVISION:
1483
self._control_files._transport.delete('last-revision')
1484
except errors.NoSuchFile:
1489
self.branch.revision_history().index(revision_id)
1491
raise errors.NoSuchRevision(self.branch, revision_id)
1492
self._control_files.put_utf8('last-revision', revision_id)
1496
def set_conflicts(self, conflicts):
1497
self._put_rio('conflicts', conflicts.to_stanzas(),
1501
def conflicts(self):
1503
confile = self._control_files.get('conflicts')
1505
return ConflictList()
1507
if confile.next() != CONFLICT_HEADER_1 + '\n':
1508
raise ConflictFormatError()
1509
except StopIteration:
1510
raise ConflictFormatError()
1511
return ConflictList.from_stanzas(RioReader(confile))
627
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1514
628
def get_conflicted_stem(path):
1515
629
for suffix in CONFLICT_SUFFIXES:
1516
630
if path.endswith(suffix):
1517
631
return path[:-len(suffix)]
1519
@deprecated_function(zero_eight)
1520
def is_control_file(filename):
1521
"""See WorkingTree.is_control_filename(filename)."""
1522
## FIXME: better check
1523
filename = normpath(filename)
1524
while filename != '':
1525
head, tail = os.path.split(filename)
1526
## mutter('check %r for control file' % ((head, tail),))
1529
if filename == head:
1535
class WorkingTreeFormat(object):
1536
"""An encapsulation of the initialization and open routines for a format.
1538
Formats provide three things:
1539
* An initialization routine,
1543
Formats are placed in an dict by their format string for reference
1544
during workingtree opening. Its not required that these be instances, they
1545
can be classes themselves with class methods - it simply depends on
1546
whether state is needed for a given format or not.
1548
Once a format is deprecated, just deprecate the initialize and open
1549
methods on the format class. Do not deprecate the object, as the
1550
object will be created every time regardless.
1553
_default_format = None
1554
"""The default format used for new trees."""
1557
"""The known formats."""
1560
def find_format(klass, a_bzrdir):
1561
"""Return the format for the working tree object in a_bzrdir."""
1563
transport = a_bzrdir.get_workingtree_transport(None)
1564
format_string = transport.get("format").read()
1565
return klass._formats[format_string]
1567
raise errors.NoWorkingTree(base=transport.base)
1569
raise errors.UnknownFormatError(format=format_string)
1572
def get_default_format(klass):
1573
"""Return the current default format."""
1574
return klass._default_format
1576
def get_format_string(self):
1577
"""Return the ASCII format string that identifies this format."""
1578
raise NotImplementedError(self.get_format_string)
1580
def get_format_description(self):
1581
"""Return the short description for this format."""
1582
raise NotImplementedError(self.get_format_description)
1584
def is_supported(self):
1585
"""Is this format supported?
1587
Supported formats can be initialized and opened.
1588
Unsupported formats may not support initialization or committing or
1589
some other features depending on the reason for not being supported.
1594
def register_format(klass, format):
1595
klass._formats[format.get_format_string()] = format
1598
def set_default_format(klass, format):
1599
klass._default_format = format
1602
def unregister_format(klass, format):
1603
assert klass._formats[format.get_format_string()] is format
1604
del klass._formats[format.get_format_string()]
1608
class WorkingTreeFormat2(WorkingTreeFormat):
1609
"""The second working tree format.
1611
This format modified the hash cache from the format 1 hash cache.
1614
def get_format_description(self):
1615
"""See WorkingTreeFormat.get_format_description()."""
1616
return "Working tree format 2"
1618
def stub_initialize_remote(self, control_files):
1619
"""As a special workaround create critical control files for a remote working tree
1621
This ensures that it can later be updated and dealt with locally,
1622
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1623
no working tree. (See bug #43064).
1627
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1629
control_files.put('inventory', sio)
1631
control_files.put_utf8('pending-merges', '')
1634
def initialize(self, a_bzrdir, revision_id=None):
1635
"""See WorkingTreeFormat.initialize()."""
1636
if not isinstance(a_bzrdir.transport, LocalTransport):
1637
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1638
branch = a_bzrdir.open_branch()
1639
if revision_id is not None:
1642
revision_history = branch.revision_history()
1644
position = revision_history.index(revision_id)
1646
raise errors.NoSuchRevision(branch, revision_id)
1647
branch.set_revision_history(revision_history[:position + 1])
1650
revision = branch.last_revision()
1652
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1658
wt._write_inventory(inv)
1659
wt.set_root_id(inv.root.file_id)
1660
wt.set_last_revision(revision)
1661
wt.set_pending_merges([])
1662
build_tree(wt.basis_tree(), wt)
1666
super(WorkingTreeFormat2, self).__init__()
1667
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1669
def open(self, a_bzrdir, _found=False):
1670
"""Return the WorkingTree object for a_bzrdir
1672
_found is a private parameter, do not use it. It is used to indicate
1673
if format probing has already been done.
1676
# we are being called directly and must probe.
1677
raise NotImplementedError
1678
if not isinstance(a_bzrdir.transport, LocalTransport):
1679
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1680
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1686
class WorkingTreeFormat3(WorkingTreeFormat):
1687
"""The second working tree format updated to record a format marker.
1690
- exists within a metadir controlling .bzr
1691
- includes an explicit version marker for the workingtree control
1692
files, separate from the BzrDir format
1693
- modifies the hash cache format
1695
- uses a LockDir to guard access to the repository
1698
def get_format_string(self):
1699
"""See WorkingTreeFormat.get_format_string()."""
1700
return "Bazaar-NG Working Tree format 3"
1702
def get_format_description(self):
1703
"""See WorkingTreeFormat.get_format_description()."""
1704
return "Working tree format 3"
1706
_lock_file_name = 'lock'
1707
_lock_class = LockDir
1709
def _open_control_files(self, a_bzrdir):
1710
transport = a_bzrdir.get_workingtree_transport(None)
1711
return LockableFiles(transport, self._lock_file_name,
1714
def initialize(self, a_bzrdir, revision_id=None):
1715
"""See WorkingTreeFormat.initialize().
1717
revision_id allows creating a working tree at a different
1718
revision than the branch is at.
1720
if not isinstance(a_bzrdir.transport, LocalTransport):
1721
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1722
transport = a_bzrdir.get_workingtree_transport(self)
1723
control_files = self._open_control_files(a_bzrdir)
1724
control_files.create_lock()
1725
control_files.lock_write()
1726
control_files.put_utf8('format', self.get_format_string())
1727
branch = a_bzrdir.open_branch()
1728
if revision_id is None:
1729
revision_id = branch.last_revision()
1731
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1737
_control_files=control_files)
1740
wt._write_inventory(inv)
1741
wt.set_root_id(inv.root.file_id)
1742
wt.set_last_revision(revision_id)
1743
wt.set_pending_merges([])
1744
build_tree(wt.basis_tree(), wt)
1747
control_files.unlock()
1751
super(WorkingTreeFormat3, self).__init__()
1752
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1754
def open(self, a_bzrdir, _found=False):
1755
"""Return the WorkingTree object for a_bzrdir
1757
_found is a private parameter, do not use it. It is used to indicate
1758
if format probing has already been done.
1761
# we are being called directly and must probe.
1762
raise NotImplementedError
1763
if not isinstance(a_bzrdir.transport, LocalTransport):
1764
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1765
control_files = self._open_control_files(a_bzrdir)
1766
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1770
_control_files=control_files)
1773
return self.get_format_string()
1776
# formats which have no format string are not discoverable
1777
# and not independently creatable, so are not registered.
1778
__default_format = WorkingTreeFormat3()
1779
WorkingTreeFormat.register_format(__default_format)
1780
WorkingTreeFormat.set_default_format(__default_format)
1781
_legacy_formats = [WorkingTreeFormat2(),
1785
class WorkingTreeTestProviderAdapter(object):
1786
"""A tool to generate a suite testing multiple workingtree formats at once.
1788
This is done by copying the test once for each transport and injecting
1789
the transport_server, transport_readonly_server, and workingtree_format
1790
classes into each copy. Each copy is also given a new id() to make it
1794
def __init__(self, transport_server, transport_readonly_server, formats):
1795
self._transport_server = transport_server
1796
self._transport_readonly_server = transport_readonly_server
1797
self._formats = formats
1799
def adapt(self, test):
1800
from bzrlib.tests import TestSuite
1801
result = TestSuite()
1802
for workingtree_format, bzrdir_format in self._formats:
1803
new_test = deepcopy(test)
1804
new_test.transport_server = self._transport_server
1805
new_test.transport_readonly_server = self._transport_readonly_server
1806
new_test.bzrdir_format = bzrdir_format
1807
new_test.workingtree_format = workingtree_format
1808
def make_new_test_id():
1809
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1810
return lambda: new_id
1811
new_test.id = make_new_test_id()
1812
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
