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 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 (
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
27
101
import bzrlib.tree
28
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
29
from bzrlib.errors import BzrCheckError
30
from bzrlib.trace import mutter
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
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')
32
155
class TreeEntry(object):
33
"""An entry that implements the minium interface used by commands.
156
"""An entry that implements the minimum interface used by commands.
35
158
This needs further inspection, it may be better to have
36
159
InventoryEntries without ids - though that seems wrong. For now,
93
216
It is possible for a `WorkingTree` to have a filename which is
94
217
not listed in the Inventory and vice versa.
96
def __init__(self, basedir, inv):
220
def __init__(self, basedir='.',
221
branch=DEPRECATED_PARAMETER,
227
"""Construct a WorkingTree for basedir.
229
If the branch is not supplied, it is opened automatically.
230
If the branch is supplied, it must be the branch for this basedir.
231
(branch.base is not cross checked, because for remote branches that
232
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
97
250
from bzrlib.hashcache import HashCache
98
251
from bzrlib.trace import note, mutter
100
self._inventory = inv
101
self.basedir = basedir
102
self.path2id = inv.path2id
252
assert isinstance(basedir, basestring), \
253
"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
104
279
# update the whole cache up front and write to disk if anything changed;
105
280
# in the future we might want to do this more selectively
106
hc = self._hashcache = HashCache(basedir)
281
# two possible ways offer themselves : in self._unlock, write the cache
282
# if needed, or, when the cache sees a change, append it to the hash
283
# cache file, and have the parser take the most recent entry for a
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)
288
# is this scan needed ? it makes things kinda slow.
110
291
if hc.needs_write:
111
292
mutter("write hc")
116
if self._hashcache.needs_write:
117
self._hashcache.write()
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)
120
372
def __iter__(self):
121
373
"""Iterate through file_ids for this tree.
164
541
path = inv.id2path(file_id)
165
542
return bzrlib.osutils.lexists(self.abspath(path))
544
def has_or_had_id(self, file_id):
545
if file_id == self.inventory.root.file_id:
547
return self.inventory.has_id(file_id)
168
549
__contains__ = has_id
171
551
def get_file_size(self, file_id):
172
552
return os.path.getsize(self.id2abspath(file_id))
174
def get_file_sha1(self, file_id):
175
path = self._inventory.id2path(file_id)
555
def get_file_sha1(self, file_id, path=None):
557
path = self._inventory.id2path(file_id)
176
558
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
179
def is_executable(self, file_id):
565
if not supports_executable():
566
def is_executable(self, file_id, path=None):
181
567
return self._inventory[file_id].executable
183
path = self._inventory.id2path(file_id)
569
def is_executable(self, file_id, path=None):
571
path = self._inventory.id2path(file_id)
184
572
mode = os.lstat(self.abspath(path)).st_mode
185
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&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)
637
def add_pending_merge(self, *revision_ids):
638
# TODO: Perhaps should check at this point that the
639
# history of the revision is actually present?
640
p = self.pending_merges()
642
for rev_id in revision_ids:
648
self.set_pending_merges(p)
651
def pending_merges(self):
652
"""Return a list of pending merges.
654
These are revisions that have been merged into the working
655
directory but not yet committed.
658
merges_file = self._control_files.get_utf8('pending-merges')
660
if e.errno != errno.ENOENT:
664
for l in merges_file.readlines():
665
p.append(l.rstrip('\n'))
669
def set_pending_merges(self, rev_list):
670
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
673
def set_merge_modified(self, modified_hashes):
675
for file_id, hash in modified_hashes.iteritems():
676
yield Stanza(file_id=file_id, hash=hash)
677
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
680
def _put_rio(self, filename, stanzas, header):
681
my_file = rio_file(stanzas, header)
682
self._control_files.put(filename, my_file)
685
def merge_modified(self):
687
hashfile = self._control_files.get('merge-hashes')
692
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
693
raise MergeModifiedFormatError()
694
except StopIteration:
695
raise MergeModifiedFormatError()
696
for s in RioReader(hashfile):
697
file_id = s.get("file_id")
698
if file_id not in self.inventory:
701
if hash == self.get_file_sha1(file_id):
702
merge_hashes[file_id] = hash
187
705
def get_symlink_target(self, file_id):
188
return os.readlink(self.id2path(file_id))
706
return os.readlink(self.id2abspath(file_id))
190
708
def file_class(self, filename):
191
709
if self.path2id(filename):
243
783
# make a last minute entry
785
yield fp[1:], c, fk, f_ie.file_id, f_ie
247
if fk == 'directory':
248
entry = TreeDirectory()
251
elif fk == 'symlink':
788
yield fp[1:], c, fk, None, fk_entries[fk]()
790
yield fp[1:], c, fk, None, TreeEntry()
256
yield fp, c, fk, (f_ie and f_ie.file_id), entry
258
793
if fk != 'directory':
262
# don't descend unversioned directories
265
for ff in descend(fp, f_ie.file_id, fap):
268
for f in descend('', inv.root.file_id, self.basedir):
796
# But do this child first
797
new_children = os.listdir(fap)
799
new_children = collections.deque(new_children)
800
stack.append((f_ie.file_id, fp, fap, new_children))
801
# Break out of inner loop, so that we start outer loop with child
804
# if we finished all children, pop it off the stack
809
def move(self, from_paths, to_name):
812
to_name must exist in the inventory.
814
If to_name exists and is a directory, the files are moved into
815
it, keeping their old names.
817
Note that to_name is only the last component of the new name;
818
this doesn't change the directory.
820
This returns a list of (from_path, to_path) pairs for each
824
## TODO: Option to move IDs only
825
assert not isinstance(from_paths, basestring)
827
to_abs = self.abspath(to_name)
828
if not isdir(to_abs):
829
raise BzrError("destination %r is not a directory" % to_abs)
830
if not self.has_filename(to_name):
831
raise BzrError("destination %r not in working directory" % to_abs)
832
to_dir_id = inv.path2id(to_name)
833
if to_dir_id == None and to_name != '':
834
raise BzrError("destination %r is not a versioned directory" % to_name)
835
to_dir_ie = inv[to_dir_id]
836
if to_dir_ie.kind not in ('directory', 'root_directory'):
837
raise BzrError("destination %r is not a directory" % to_abs)
839
to_idpath = inv.get_idpath(to_dir_id)
842
if not self.has_filename(f):
843
raise BzrError("%r does not exist in working tree" % f)
844
f_id = inv.path2id(f)
846
raise BzrError("%r is not versioned" % f)
847
name_tail = splitpath(f)[-1]
848
dest_path = pathjoin(to_name, name_tail)
849
if self.has_filename(dest_path):
850
raise BzrError("destination %r already exists" % dest_path)
851
if f_id in to_idpath:
852
raise BzrError("can't move %r to a subdirectory of itself" % f)
854
# OK, so there's a race here, it's possible that someone will
855
# create a file in this interval and then the rename might be
856
# left half-done. But we should have caught most problems.
857
orig_inv = deepcopy(self.inventory)
860
name_tail = splitpath(f)[-1]
861
dest_path = pathjoin(to_name, name_tail)
862
result.append((f, dest_path))
863
inv.rename(inv.path2id(f), to_dir_id, name_tail)
865
rename(self.abspath(f), self.abspath(dest_path))
867
raise BzrError("failed to rename %r to %r: %s" %
868
(f, dest_path, e[1]),
869
["rename rolled back"])
871
# restore the inventory on error
872
self._set_inventory(orig_inv)
874
self._write_inventory(inv)
878
def rename_one(self, from_rel, to_rel):
881
This can change the directory or the filename or both.
884
if not self.has_filename(from_rel):
885
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
886
if self.has_filename(to_rel):
887
raise BzrError("can't rename: new working file %r already exists" % to_rel)
889
file_id = inv.path2id(from_rel)
891
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
894
from_parent = entry.parent_id
895
from_name = entry.name
897
if inv.path2id(to_rel):
898
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
900
to_dir, to_tail = os.path.split(to_rel)
901
to_dir_id = inv.path2id(to_dir)
902
if to_dir_id == None and to_dir != '':
903
raise BzrError("can't determine destination directory id for %r" % to_dir)
905
mutter("rename_one:")
906
mutter(" file_id {%s}" % file_id)
907
mutter(" from_rel %r" % from_rel)
908
mutter(" to_rel %r" % to_rel)
909
mutter(" to_dir %r" % to_dir)
910
mutter(" to_dir_id {%s}" % to_dir_id)
912
inv.rename(file_id, to_dir_id, to_tail)
914
from_abs = self.abspath(from_rel)
915
to_abs = self.abspath(to_rel)
917
rename(from_abs, to_abs)
919
inv.rename(file_id, from_parent, from_name)
920
raise BzrError("failed to rename %r to %r: %s"
921
% (from_abs, to_abs, e[1]),
922
["rename rolled back"])
923
self._write_inventory(inv)
273
926
def unknowns(self):
927
"""Return all unknown files.
929
These are files in the working directory that are not versioned or
930
control files or ignored.
274
932
for subp in self.extras():
275
933
if not self.is_ignored(subp):
936
@deprecated_method(zero_eight)
278
937
def iter_conflicts(self):
938
"""List all files in the tree that have text or content conflicts.
939
DEPRECATED. Use conflicts instead."""
940
return self._iter_conflicts()
942
def _iter_conflicts(self):
279
943
conflicted = set()
280
for path in (s[0] for s in self.list_files()):
944
for info in self.list_files():
281
946
stem = get_conflicted_stem(path)
356
1118
# treat dotfiles correctly and allows * to match /.
357
1119
# Eventually it should be replaced with something more
360
for pat in self.get_ignore_list():
361
if '/' in pat or '\\' in pat:
363
# as a special case, you can put ./ at the start of a
364
# pattern; this is good to match in the top-level
367
if (pat[:2] == './') or (pat[:2] == '.\\'):
1122
rules = self._get_ignore_rules_as_regex()
1123
for regex, mapping in rules:
1124
match = regex.match(filename)
1125
if match is not None:
1126
# one or more of the groups in mapping will have a non-None group
1128
groups = match.groups()
1129
rules = [mapping[group] for group in
1130
mapping if groups[group] is not None]
1134
def kind(self, file_id):
1135
return file_kind(self.id2abspath(file_id))
1138
def last_revision(self):
1139
"""Return the last revision id of this working tree.
1141
In early branch formats this was == the branch last_revision,
1142
but that cannot be relied upon - for working tree operations,
1143
always use tree.last_revision().
1145
return self.branch.last_revision()
1147
def is_locked(self):
1148
return self._control_files.is_locked()
1150
def lock_read(self):
1151
"""See Branch.lock_read, and WorkingTree.unlock."""
1152
self.branch.lock_read()
1154
return self._control_files.lock_read()
1156
self.branch.unlock()
1159
def lock_write(self):
1160
"""See Branch.lock_write, and WorkingTree.unlock."""
1161
self.branch.lock_write()
1163
return self._control_files.lock_write()
1165
self.branch.unlock()
1168
def get_physical_lock_status(self):
1169
return self._control_files.get_physical_lock_status()
1171
def _basis_inventory_name(self):
1172
return 'basis-inventory'
1175
def set_last_revision(self, new_revision):
1176
"""Change the last revision in the working tree."""
1177
if self._change_last_revision(new_revision):
1178
self._cache_basis_inventory(new_revision)
1180
def _change_last_revision(self, new_revision):
1181
"""Template method part of set_last_revision to perform the change.
1183
This is used to allow WorkingTree3 instances to not affect branch
1184
when their last revision is set.
1186
if new_revision is None:
1187
self.branch.set_revision_history([])
1189
# current format is locked in with the branch
1190
revision_history = self.branch.revision_history()
1192
position = revision_history.index(new_revision)
1194
raise errors.NoSuchRevision(self.branch, new_revision)
1195
self.branch.set_revision_history(revision_history[:position + 1])
1198
def _cache_basis_inventory(self, new_revision):
1199
"""Cache new_revision as the basis inventory."""
1200
# TODO: this should allow the ready-to-use inventory to be passed in,
1201
# as commit already has that ready-to-use [while the format is the
1204
# this double handles the inventory - unpack and repack -
1205
# but is easier to understand. We can/should put a conditional
1206
# in here based on whether the inventory is in the latest format
1207
# - perhaps we should repack all inventories on a repository
1209
# the fast path is to copy the raw xml from the repository. If the
1210
# xml contains 'revision_id="', then we assume the right
1211
# revision_id is set. We must check for this full string, because a
1212
# root node id can legitimately look like 'revision_id' but cannot
1214
xml = self.branch.repository.get_inventory_xml(new_revision)
1215
if not 'revision_id="' in xml.split('\n', 1)[0]:
1216
inv = self.branch.repository.deserialise_inventory(
1218
inv.revision_id = new_revision
1219
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1220
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1221
path = self._basis_inventory_name()
1223
self._control_files.put(path, sio)
1224
except WeaveRevisionNotPresent:
1227
def read_basis_inventory(self):
1228
"""Read the cached basis inventory."""
1229
path = self._basis_inventory_name()
1230
return self._control_files.get(path).read()
1233
def read_working_inventory(self):
1234
"""Read the working inventory."""
1235
# ElementTree does its own conversion from UTF-8, so open in
1237
result = bzrlib.xml5.serializer_v5.read_inventory(
1238
self._control_files.get('inventory'))
1239
self._set_inventory(result)
1243
def remove(self, files, verbose=False, to_file=None):
1244
"""Remove nominated files from the working inventory..
1246
This does not remove their text. This does not run on XXX on what? RBC
1248
TODO: Refuse to remove modified files unless --force is given?
1250
TODO: Do something useful with directories.
1252
TODO: Should this remove the text or not? Tough call; not
1253
removing may be useful and the user can just use use rm, and
1254
is the opposite of add. Removing it is consistent with most
1255
other tools. Maybe an option.
1257
## TODO: Normalize names
1258
## TODO: Remove nested loops; better scalability
1259
if isinstance(files, basestring):
1262
inv = self.inventory
1264
# do this before any modifications
1266
fid = inv.path2id(f)
1268
# TODO: Perhaps make this just a warning, and continue?
1269
# This tends to happen when
1270
raise NotVersionedError(path=f)
1272
# having remove it, it must be either ignored or unknown
1273
if self.is_ignored(f):
371
if fnmatch.fnmatchcase(filename, newpat):
1277
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1280
self._write_inventory(inv)
1283
def revert(self, filenames, old_tree=None, backups=True,
1284
pb=DummyProgress()):
1285
from transform import revert
1286
from conflicts import resolve
1287
if old_tree is None:
1288
old_tree = self.basis_tree()
1289
conflicts = revert(self, old_tree, filenames, backups, pb)
1290
if not len(filenames):
1291
self.set_pending_merges([])
1294
resolve(self, filenames, ignore_misses=True)
1297
# XXX: This method should be deprecated in favour of taking in a proper
1298
# new Inventory object.
1300
def set_inventory(self, new_inventory_list):
1301
from bzrlib.inventory import (Inventory,
1306
inv = Inventory(self.get_root_id())
1307
for path, file_id, parent, kind in new_inventory_list:
1308
name = os.path.basename(path)
1311
# fixme, there should be a factory function inv,add_??
1312
if kind == 'directory':
1313
inv.add(InventoryDirectory(file_id, name, parent))
1314
elif kind == 'file':
1315
inv.add(InventoryFile(file_id, name, parent))
1316
elif kind == 'symlink':
1317
inv.add(InventoryLink(file_id, name, parent))
374
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1319
raise BzrError("unknown kind %r" % kind)
1320
self._write_inventory(inv)
1323
def set_root_id(self, file_id):
1324
"""Set the root id for this tree."""
1325
inv = self.read_working_inventory()
1326
orig_root_id = inv.root.file_id
1327
del inv._byid[inv.root.file_id]
1328
inv.root.file_id = file_id
1329
inv._byid[inv.root.file_id] = inv.root
1332
if entry.parent_id == orig_root_id:
1333
entry.parent_id = inv.root.file_id
1334
self._write_inventory(inv)
1337
"""See Branch.unlock.
1339
WorkingTree locking just uses the Branch locking facilities.
1340
This is current because all working trees have an embedded branch
1341
within them. IF in the future, we were to make branch data shareable
1342
between multiple working trees, i.e. via shared storage, then we
1343
would probably want to lock both the local tree, and the branch.
1345
# FIXME: We want to write out the hashcache only when the last lock on
1346
# this working copy is released. Peeking at the lock count is a bit
1347
# of a nasty hack; probably it's better to have a transaction object,
1348
# which can do some finalization when it's either successfully or
1349
# unsuccessfully completed. (Denys's original patch did that.)
1350
# RBC 20060206 hooking into transaction will couple lock and transaction
1351
# wrongly. Hooking into unlock on the control files object is fine though.
1353
# TODO: split this per format so there is no ugly if block
1354
if self._hashcache.needs_write and (
1355
# dedicated lock files
1356
self._control_files._lock_count==1 or
1358
(self._control_files is self.branch.control_files and
1359
self._control_files._lock_count==3)):
1360
self._hashcache.write()
1361
# reverse order of locking.
1363
return self._control_files.unlock()
1365
self.branch.unlock()
1369
"""Update a working tree along its branch.
1371
This will update the branch if its bound too, which means we have multiple trees involved:
1372
The new basis tree of the master.
1373
The old basis tree of the branch.
1374
The old basis tree of the working tree.
1375
The current working tree state.
1376
pathologically all three may be different, and non ancestors of each other.
1377
Conceptually we want to:
1378
Preserve the wt.basis->wt.state changes
1379
Transform the wt.basis to the new master basis.
1380
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1381
Restore the wt.basis->wt.state changes.
1383
There isn't a single operation at the moment to do that, so we:
1384
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1385
Do a 'normal' merge of the old branch basis if it is relevant.
1387
old_tip = self.branch.update()
1388
if old_tip is not None:
1389
self.add_pending_merge(old_tip)
1390
self.branch.lock_read()
1393
if self.last_revision() != self.branch.last_revision():
1394
# merge tree state up to new branch tip.
1395
basis = self.basis_tree()
1396
to_tree = self.branch.basis_tree()
1397
result += merge_inner(self.branch,
1401
self.set_last_revision(self.branch.last_revision())
1402
if old_tip and old_tip != self.last_revision():
1403
# our last revision was not the prior branch last revision
1404
# and we have converted that last revision to a pending merge.
1405
# base is somewhere between the branch tip now
1406
# and the now pending merge
1407
from bzrlib.revision import common_ancestor
1409
base_rev_id = common_ancestor(self.branch.last_revision(),
1411
self.branch.repository)
1412
except errors.NoCommonAncestor:
1414
base_tree = self.branch.repository.revision_tree(base_rev_id)
1415
other_tree = self.branch.repository.revision_tree(old_tip)
1416
result += merge_inner(self.branch,
1422
self.branch.unlock()
1425
def _write_inventory(self, inv):
1426
"""Write inventory as the current inventory."""
1428
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1430
self._control_files.put('inventory', sio)
1431
self._set_inventory(inv)
1432
mutter('wrote working inventory')
1434
def set_conflicts(self, arg):
1435
raise UnsupportedOperation(self.set_conflicts, self)
1438
def conflicts(self):
1439
conflicts = ConflictList()
1440
for conflicted in self._iter_conflicts():
1443
if file_kind(self.abspath(conflicted)) != "file":
1445
except errors.NoSuchFile:
1448
for suffix in ('.THIS', '.OTHER'):
1450
kind = file_kind(self.abspath(conflicted+suffix))
1453
except errors.NoSuchFile:
1457
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1458
conflicts.append(Conflict.factory(ctype, path=conflicted,
1459
file_id=self.path2id(conflicted)))
1463
class WorkingTree3(WorkingTree):
1464
"""This is the Format 3 working tree.
1466
This differs from the base WorkingTree by:
1467
- having its own file lock
1468
- having its own last-revision property.
1470
This is new in bzr 0.8
1474
def last_revision(self):
1475
"""See WorkingTree.last_revision."""
1477
return self._control_files.get_utf8('last-revision').read()
379
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1481
def _change_last_revision(self, revision_id):
1482
"""See WorkingTree._change_last_revision."""
1483
if revision_id is None or revision_id == NULL_REVISION:
1485
self._control_files._transport.delete('last-revision')
1486
except errors.NoSuchFile:
1491
self.branch.revision_history().index(revision_id)
1493
raise errors.NoSuchRevision(self.branch, revision_id)
1494
self._control_files.put_utf8('last-revision', revision_id)
1498
def set_conflicts(self, conflicts):
1499
self._put_rio('conflicts', conflicts.to_stanzas(),
1503
def conflicts(self):
1505
confile = self._control_files.get('conflicts')
1507
return ConflictList()
1509
if confile.next() != CONFLICT_HEADER_1 + '\n':
1510
raise ConflictFormatError()
1511
except StopIteration:
1512
raise ConflictFormatError()
1513
return ConflictList.from_stanzas(RioReader(confile))
380
1516
def get_conflicted_stem(path):
381
1517
for suffix in CONFLICT_SUFFIXES:
382
1518
if path.endswith(suffix):
383
1519
return path[:-len(suffix)]
1521
@deprecated_function(zero_eight)
1522
def is_control_file(filename):
1523
"""See WorkingTree.is_control_filename(filename)."""
1524
## FIXME: better check
1525
filename = normpath(filename)
1526
while filename != '':
1527
head, tail = os.path.split(filename)
1528
## mutter('check %r for control file' % ((head, tail),))
1531
if filename == head:
1537
class WorkingTreeFormat(object):
1538
"""An encapsulation of the initialization and open routines for a format.
1540
Formats provide three things:
1541
* An initialization routine,
1545
Formats are placed in an dict by their format string for reference
1546
during workingtree opening. Its not required that these be instances, they
1547
can be classes themselves with class methods - it simply depends on
1548
whether state is needed for a given format or not.
1550
Once a format is deprecated, just deprecate the initialize and open
1551
methods on the format class. Do not deprecate the object, as the
1552
object will be created every time regardless.
1555
_default_format = None
1556
"""The default format used for new trees."""
1559
"""The known formats."""
1562
def find_format(klass, a_bzrdir):
1563
"""Return the format for the working tree object in a_bzrdir."""
1565
transport = a_bzrdir.get_workingtree_transport(None)
1566
format_string = transport.get("format").read()
1567
return klass._formats[format_string]
1569
raise errors.NoWorkingTree(base=transport.base)
1571
raise errors.UnknownFormatError(format=format_string)
1574
def get_default_format(klass):
1575
"""Return the current default format."""
1576
return klass._default_format
1578
def get_format_string(self):
1579
"""Return the ASCII format string that identifies this format."""
1580
raise NotImplementedError(self.get_format_string)
1582
def get_format_description(self):
1583
"""Return the short description for this format."""
1584
raise NotImplementedError(self.get_format_description)
1586
def is_supported(self):
1587
"""Is this format supported?
1589
Supported formats can be initialized and opened.
1590
Unsupported formats may not support initialization or committing or
1591
some other features depending on the reason for not being supported.
1596
def register_format(klass, format):
1597
klass._formats[format.get_format_string()] = format
1600
def set_default_format(klass, format):
1601
klass._default_format = format
1604
def unregister_format(klass, format):
1605
assert klass._formats[format.get_format_string()] is format
1606
del klass._formats[format.get_format_string()]
1610
class WorkingTreeFormat2(WorkingTreeFormat):
1611
"""The second working tree format.
1613
This format modified the hash cache from the format 1 hash cache.
1616
def get_format_description(self):
1617
"""See WorkingTreeFormat.get_format_description()."""
1618
return "Working tree format 2"
1620
def stub_initialize_remote(self, control_files):
1621
"""As a special workaround create critical control files for a remote working tree
1623
This ensures that it can later be updated and dealt with locally,
1624
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1625
no working tree. (See bug #43064).
1629
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1631
control_files.put('inventory', sio)
1633
control_files.put_utf8('pending-merges', '')
1636
def initialize(self, a_bzrdir, revision_id=None):
1637
"""See WorkingTreeFormat.initialize()."""
1638
if not isinstance(a_bzrdir.transport, LocalTransport):
1639
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1640
branch = a_bzrdir.open_branch()
1641
if revision_id is not None:
1644
revision_history = branch.revision_history()
1646
position = revision_history.index(revision_id)
1648
raise errors.NoSuchRevision(branch, revision_id)
1649
branch.set_revision_history(revision_history[:position + 1])
1652
revision = branch.last_revision()
1654
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1660
wt._write_inventory(inv)
1661
wt.set_root_id(inv.root.file_id)
1662
wt.set_last_revision(revision)
1663
wt.set_pending_merges([])
1664
build_tree(wt.basis_tree(), wt)
1668
super(WorkingTreeFormat2, self).__init__()
1669
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1671
def open(self, a_bzrdir, _found=False):
1672
"""Return the WorkingTree object for a_bzrdir
1674
_found is a private parameter, do not use it. It is used to indicate
1675
if format probing has already been done.
1678
# we are being called directly and must probe.
1679
raise NotImplementedError
1680
if not isinstance(a_bzrdir.transport, LocalTransport):
1681
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1682
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1688
class WorkingTreeFormat3(WorkingTreeFormat):
1689
"""The second working tree format updated to record a format marker.
1692
- exists within a metadir controlling .bzr
1693
- includes an explicit version marker for the workingtree control
1694
files, separate from the BzrDir format
1695
- modifies the hash cache format
1697
- uses a LockDir to guard access to the repository
1700
def get_format_string(self):
1701
"""See WorkingTreeFormat.get_format_string()."""
1702
return "Bazaar-NG Working Tree format 3"
1704
def get_format_description(self):
1705
"""See WorkingTreeFormat.get_format_description()."""
1706
return "Working tree format 3"
1708
_lock_file_name = 'lock'
1709
_lock_class = LockDir
1711
def _open_control_files(self, a_bzrdir):
1712
transport = a_bzrdir.get_workingtree_transport(None)
1713
return LockableFiles(transport, self._lock_file_name,
1716
def initialize(self, a_bzrdir, revision_id=None):
1717
"""See WorkingTreeFormat.initialize().
1719
revision_id allows creating a working tree at a different
1720
revision than the branch is at.
1722
if not isinstance(a_bzrdir.transport, LocalTransport):
1723
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1724
transport = a_bzrdir.get_workingtree_transport(self)
1725
control_files = self._open_control_files(a_bzrdir)
1726
control_files.create_lock()
1727
control_files.lock_write()
1728
control_files.put_utf8('format', self.get_format_string())
1729
branch = a_bzrdir.open_branch()
1730
if revision_id is None:
1731
revision_id = branch.last_revision()
1733
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1739
_control_files=control_files)
1742
wt._write_inventory(inv)
1743
wt.set_root_id(inv.root.file_id)
1744
wt.set_last_revision(revision_id)
1745
wt.set_pending_merges([])
1746
build_tree(wt.basis_tree(), wt)
1749
control_files.unlock()
1753
super(WorkingTreeFormat3, self).__init__()
1754
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1756
def open(self, a_bzrdir, _found=False):
1757
"""Return the WorkingTree object for a_bzrdir
1759
_found is a private parameter, do not use it. It is used to indicate
1760
if format probing has already been done.
1763
# we are being called directly and must probe.
1764
raise NotImplementedError
1765
if not isinstance(a_bzrdir.transport, LocalTransport):
1766
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1767
control_files = self._open_control_files(a_bzrdir)
1768
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1772
_control_files=control_files)
1775
return self.get_format_string()
1778
# formats which have no format string are not discoverable
1779
# and not independently creatable, so are not registered.
1780
__default_format = WorkingTreeFormat3()
1781
WorkingTreeFormat.register_format(__default_format)
1782
WorkingTreeFormat.set_default_format(__default_format)
1783
_legacy_formats = [WorkingTreeFormat2(),
1787
class WorkingTreeTestProviderAdapter(object):
1788
"""A tool to generate a suite testing multiple workingtree formats at once.
1790
This is done by copying the test once for each transport and injecting
1791
the transport_server, transport_readonly_server, and workingtree_format
1792
classes into each copy. Each copy is also given a new id() to make it
1796
def __init__(self, transport_server, transport_readonly_server, formats):
1797
self._transport_server = transport_server
1798
self._transport_readonly_server = transport_readonly_server
1799
self._formats = formats
1801
def adapt(self, test):
1802
from bzrlib.tests import TestSuite
1803
result = TestSuite()
1804
for workingtree_format, bzrdir_format in self._formats:
1805
new_test = deepcopy(test)
1806
new_test.transport_server = self._transport_server
1807
new_test.transport_readonly_server = self._transport_readonly_server
1808
new_test.bzrdir_format = bzrdir_format
1809
new_test.workingtree_format = workingtree_format
1810
def make_new_test_id():
1811
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1812
return lambda: new_id
1813
new_test.id = make_new_test_id()
1814
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
