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 import bzrdir, errors, osutils, urlutils
55
from bzrlib.atomicfile import AtomicFile
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
from bzrlib.errors import (BzrCheckError,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError,
68
from bzrlib.inventory import InventoryEntry, Inventory
69
from bzrlib.lockable_files import LockableFiles, TransportLock
70
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
72
from bzrlib.osutils import (
89
from bzrlib.progress import DummyProgress, ProgressPhase
90
from bzrlib.revision import NULL_REVISION
91
from bzrlib.rio import RioReader, rio_file, Stanza
92
from bzrlib.symbol_versioning import (deprecated_passed,
99
from bzrlib.textui import show_status
27
100
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
101
from bzrlib.transform import build_tree
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport import get_transport
104
from bzrlib.transport.local import LocalTransport
109
# the regex here does the following:
110
# 1) remove any weird characters; we don't escape them but rather
112
# 2) match leading '.'s to make it not hidden
113
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# XXX TODO: squash the filename to lowercase.
142
# XXX TODO: truncate the filename to something like 20 or 30 chars.
143
# XXX TODO: consider what to do with ids that look like illegal filepaths
144
# on platforms we support.
145
return _gen_file_id_re.sub('', name) + _next_id_suffix()
149
"""Return a new tree-root file id."""
150
return gen_file_id('TREE_ROOT')
32
153
class TreeEntry(object):
33
"""An entry that implements the minium interface used by commands.
154
"""An entry that implements the minimum interface used by commands.
35
156
This needs further inspection, it may be better to have
36
157
InventoryEntries without ids - though that seems wrong. For now,
93
214
It is possible for a `WorkingTree` to have a filename which is
94
215
not listed in the Inventory and vice versa.
96
def __init__(self, basedir, inv):
218
def __init__(self, basedir='.',
219
branch=DEPRECATED_PARAMETER,
225
"""Construct a WorkingTree for basedir.
227
If the branch is not supplied, it is opened automatically.
228
If the branch is supplied, it must be the branch for this basedir.
229
(branch.base is not cross checked, because for remote branches that
230
would be meaningless).
232
self._format = _format
233
self.bzrdir = _bzrdir
235
# not created via open etc.
236
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
237
"Please use bzrdir.open_workingtree or WorkingTree.open().",
240
wt = WorkingTree.open(basedir)
241
self._branch = wt.branch
242
self.basedir = wt.basedir
243
self._control_files = wt._control_files
244
self._hashcache = wt._hashcache
245
self._set_inventory(wt._inventory)
246
self._format = wt._format
247
self.bzrdir = wt.bzrdir
97
248
from bzrlib.hashcache import HashCache
98
249
from bzrlib.trace import note, mutter
100
self._inventory = inv
101
self.basedir = basedir
102
self.path2id = inv.path2id
250
assert isinstance(basedir, basestring), \
251
"base directory %r is not a string" % basedir
252
basedir = safe_unicode(basedir)
253
mutter("opening working tree %r", basedir)
254
if deprecated_passed(branch):
256
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
257
" Please use bzrdir.open_workingtree() or"
258
" WorkingTree.open().",
262
self._branch = branch
264
self._branch = self.bzrdir.open_branch()
265
self.basedir = realpath(basedir)
266
# if branch is at our basedir and is a format 6 or less
267
if isinstance(self._format, WorkingTreeFormat2):
268
# share control object
269
self._control_files = self.branch.control_files
271
# only ready for format 3
272
assert isinstance(self._format, WorkingTreeFormat3)
273
assert isinstance(_control_files, LockableFiles), \
274
"_control_files must be a LockableFiles, not %r" \
276
self._control_files = _control_files
104
277
# update the whole cache up front and write to disk if anything changed;
105
278
# in the future we might want to do this more selectively
106
hc = self._hashcache = HashCache(basedir)
279
# two possible ways offer themselves : in self._unlock, write the cache
280
# if needed, or, when the cache sees a change, append it to the hash
281
# cache file, and have the parser take the most recent entry for a
283
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
284
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
286
# is this scan needed ? it makes things kinda slow.
110
289
if hc.needs_write:
111
290
mutter("write hc")
116
if self._hashcache.needs_write:
117
self._hashcache.write()
293
if _inventory is None:
294
self._set_inventory(self.read_working_inventory())
296
self._set_inventory(_inventory)
299
fget=lambda self: self._branch,
300
doc="""The branch this WorkingTree is connected to.
302
This cannot be set - it is reflective of the actual disk structure
303
the working tree has been constructed from.
306
def break_lock(self):
307
"""Break a lock if one is present from another instance.
309
Uses the ui factory to ask for confirmation if the lock may be from
312
This will probe the repository for its lock as well.
314
self._control_files.break_lock()
315
self.branch.break_lock()
317
def _set_inventory(self, inv):
318
self._inventory = inv
319
self.path2id = self._inventory.path2id
321
def is_control_filename(self, filename):
322
"""True if filename is the name of a control file in this tree.
324
:param filename: A filename within the tree. This is a relative path
325
from the root of this tree.
327
This is true IF and ONLY IF the filename is part of the meta data
328
that bzr controls in this tree. I.E. a random .bzr directory placed
329
on disk will not be a control file for this tree.
331
return self.bzrdir.is_control_filename(filename)
334
def open(path=None, _unsupported=False):
335
"""Open an existing working tree at path.
339
path = os.path.getcwdu()
340
control = bzrdir.BzrDir.open(path, _unsupported)
341
return control.open_workingtree(_unsupported)
344
def open_containing(path=None):
345
"""Open an existing working tree which has its root about path.
347
This probes for a working tree at path and searches upwards from there.
349
Basically we keep looking up until we find the control directory or
350
run into /. If there isn't one, raises NotBranchError.
351
TODO: give this a new exception.
352
If there is one, it is returned, along with the unused portion of path.
354
:return: The WorkingTree that contains 'path', and the rest of path
358
control, relpath = bzrdir.BzrDir.open_containing(path)
360
return control.open_workingtree(), relpath
363
def open_downlevel(path=None):
364
"""Open an unsupported working tree.
366
Only intended for advanced situations like upgrading part of a bzrdir.
368
return WorkingTree.open(path, _unsupported=True)
120
370
def __iter__(self):
121
371
"""Iterate through file_ids for this tree.
164
539
path = inv.id2path(file_id)
165
540
return bzrlib.osutils.lexists(self.abspath(path))
542
def has_or_had_id(self, file_id):
543
if file_id == self.inventory.root.file_id:
545
return self.inventory.has_id(file_id)
168
547
__contains__ = has_id
171
549
def get_file_size(self, file_id):
172
550
return os.path.getsize(self.id2abspath(file_id))
174
def get_file_sha1(self, file_id):
175
path = self._inventory.id2path(file_id)
553
def get_file_sha1(self, file_id, path=None):
555
path = self._inventory.id2path(file_id)
176
556
return self._hashcache.get_sha1(path)
558
def get_file_mtime(self, file_id, path=None):
560
path = self._inventory.id2path(file_id)
561
return os.lstat(self.abspath(path)).st_mtime
179
def is_executable(self, file_id):
563
if not supports_executable():
564
def is_executable(self, file_id, path=None):
181
565
return self._inventory[file_id].executable
183
path = self._inventory.id2path(file_id)
567
def is_executable(self, file_id, path=None):
569
path = self._inventory.id2path(file_id)
184
570
mode = os.lstat(self.abspath(path)).st_mode
185
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
571
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
574
def add(self, files, ids=None):
575
"""Make files versioned.
577
Note that the command line normally calls smart_add instead,
578
which can automatically recurse.
580
This adds the files to the inventory, so that they will be
581
recorded by the next commit.
584
List of paths to add, relative to the base of the tree.
587
If set, use these instead of automatically generated ids.
588
Must be the same length as the list of files, but may
589
contain None for ids that are to be autogenerated.
591
TODO: Perhaps have an option to add the ids even if the files do
594
TODO: Perhaps callback with the ids and paths as they're added.
596
# TODO: Re-adding a file that is removed in the working copy
597
# should probably put it back with the previous ID.
598
if isinstance(files, basestring):
599
assert(ids is None or isinstance(ids, basestring))
605
ids = [None] * len(files)
607
assert(len(ids) == len(files))
609
inv = self.read_working_inventory()
610
for f,file_id in zip(files, ids):
611
if self.is_control_filename(f):
612
raise errors.ForbiddenControlFileError(filename=f)
617
raise BzrError("cannot add top-level %r" % f)
619
fullpath = normpath(self.abspath(f))
621
kind = file_kind(fullpath)
623
if e.errno == errno.ENOENT:
624
raise NoSuchFile(fullpath)
625
if not InventoryEntry.versionable_kind(kind):
626
raise errors.BadFileKindError(filename=f, kind=kind)
628
inv.add_path(f, kind=kind)
630
inv.add_path(f, kind=kind, file_id=file_id)
632
self._write_inventory(inv)
635
def add_pending_merge(self, *revision_ids):
636
# TODO: Perhaps should check at this point that the
637
# history of the revision is actually present?
638
p = self.pending_merges()
640
for rev_id in revision_ids:
646
self.set_pending_merges(p)
649
def pending_merges(self):
650
"""Return a list of pending merges.
652
These are revisions that have been merged into the working
653
directory but not yet committed.
656
merges_file = self._control_files.get_utf8('pending-merges')
660
for l in merges_file.readlines():
661
p.append(l.rstrip('\n'))
665
def set_pending_merges(self, rev_list):
666
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
669
def set_merge_modified(self, modified_hashes):
671
for file_id, hash in modified_hashes.iteritems():
672
yield Stanza(file_id=file_id, hash=hash)
673
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
676
def _put_rio(self, filename, stanzas, header):
677
my_file = rio_file(stanzas, header)
678
self._control_files.put(filename, my_file)
681
def merge_modified(self):
683
hashfile = self._control_files.get('merge-hashes')
688
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
689
raise MergeModifiedFormatError()
690
except StopIteration:
691
raise MergeModifiedFormatError()
692
for s in RioReader(hashfile):
693
file_id = s.get("file_id")
694
if file_id not in self.inventory:
697
if hash == self.get_file_sha1(file_id):
698
merge_hashes[file_id] = hash
187
701
def get_symlink_target(self, file_id):
188
return os.readlink(self.id2path(file_id))
702
return os.readlink(self.id2abspath(file_id))
190
704
def file_class(self, filename):
191
705
if self.path2id(filename):
243
797
# make a last minute entry
799
yield fp[1:], c, fk, f_ie.file_id, f_ie
247
if fk == 'directory':
248
entry = TreeDirectory()
251
elif fk == 'symlink':
802
yield fp[1:], c, fk, None, fk_entries[fk]()
804
yield fp[1:], c, fk, None, TreeEntry()
256
yield fp, c, fk, (f_ie and f_ie.file_id), entry
258
807
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):
810
# But do this child first
811
new_children = os.listdir(fap)
813
new_children = collections.deque(new_children)
814
stack.append((f_ie.file_id, fp, fap, new_children))
815
# Break out of inner loop, so that we start outer loop with child
818
# if we finished all children, pop it off the stack
823
def move(self, from_paths, to_name):
826
to_name must exist in the inventory.
828
If to_name exists and is a directory, the files are moved into
829
it, keeping their old names.
831
Note that to_name is only the last component of the new name;
832
this doesn't change the directory.
834
This returns a list of (from_path, to_path) pairs for each
838
## TODO: Option to move IDs only
839
assert not isinstance(from_paths, basestring)
841
to_abs = self.abspath(to_name)
842
if not isdir(to_abs):
843
raise BzrError("destination %r is not a directory" % to_abs)
844
if not self.has_filename(to_name):
845
raise BzrError("destination %r not in working directory" % to_abs)
846
to_dir_id = inv.path2id(to_name)
847
if to_dir_id == None and to_name != '':
848
raise BzrError("destination %r is not a versioned directory" % to_name)
849
to_dir_ie = inv[to_dir_id]
850
if to_dir_ie.kind not in ('directory', 'root_directory'):
851
raise BzrError("destination %r is not a directory" % to_abs)
853
to_idpath = inv.get_idpath(to_dir_id)
856
if not self.has_filename(f):
857
raise BzrError("%r does not exist in working tree" % f)
858
f_id = inv.path2id(f)
860
raise BzrError("%r is not versioned" % f)
861
name_tail = splitpath(f)[-1]
862
dest_path = pathjoin(to_name, name_tail)
863
if self.has_filename(dest_path):
864
raise BzrError("destination %r already exists" % dest_path)
865
if f_id in to_idpath:
866
raise BzrError("can't move %r to a subdirectory of itself" % f)
868
# OK, so there's a race here, it's possible that someone will
869
# create a file in this interval and then the rename might be
870
# left half-done. But we should have caught most problems.
871
orig_inv = deepcopy(self.inventory)
874
name_tail = splitpath(f)[-1]
875
dest_path = pathjoin(to_name, name_tail)
876
result.append((f, dest_path))
877
inv.rename(inv.path2id(f), to_dir_id, name_tail)
879
rename(self.abspath(f), self.abspath(dest_path))
881
raise BzrError("failed to rename %r to %r: %s" %
882
(f, dest_path, e[1]),
883
["rename rolled back"])
885
# restore the inventory on error
886
self._set_inventory(orig_inv)
888
self._write_inventory(inv)
892
def rename_one(self, from_rel, to_rel):
895
This can change the directory or the filename or both.
898
if not self.has_filename(from_rel):
899
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
900
if self.has_filename(to_rel):
901
raise BzrError("can't rename: new working file %r already exists" % to_rel)
903
file_id = inv.path2id(from_rel)
905
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
908
from_parent = entry.parent_id
909
from_name = entry.name
911
if inv.path2id(to_rel):
912
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
914
to_dir, to_tail = os.path.split(to_rel)
915
to_dir_id = inv.path2id(to_dir)
916
if to_dir_id == None and to_dir != '':
917
raise BzrError("can't determine destination directory id for %r" % to_dir)
919
mutter("rename_one:")
920
mutter(" file_id {%s}" % file_id)
921
mutter(" from_rel %r" % from_rel)
922
mutter(" to_rel %r" % to_rel)
923
mutter(" to_dir %r" % to_dir)
924
mutter(" to_dir_id {%s}" % to_dir_id)
926
inv.rename(file_id, to_dir_id, to_tail)
928
from_abs = self.abspath(from_rel)
929
to_abs = self.abspath(to_rel)
931
rename(from_abs, to_abs)
933
inv.rename(file_id, from_parent, from_name)
934
raise BzrError("failed to rename %r to %r: %s"
935
% (from_abs, to_abs, e[1]),
936
["rename rolled back"])
937
self._write_inventory(inv)
273
940
def unknowns(self):
941
"""Return all unknown files.
943
These are files in the working directory that are not versioned or
944
control files or ignored.
274
946
for subp in self.extras():
275
947
if not self.is_ignored(subp):
950
@deprecated_method(zero_eight)
951
def iter_conflicts(self):
952
"""List all files in the tree that have text or content conflicts.
953
DEPRECATED. Use conflicts instead."""
954
return self._iter_conflicts()
956
def _iter_conflicts(self):
958
for info in self.list_files():
960
stem = get_conflicted_stem(path)
963
if stem not in conflicted:
968
def pull(self, source, overwrite=False, stop_revision=None):
969
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
972
pp = ProgressPhase("Pull phase", 2, top_pb)
974
old_revision_history = self.branch.revision_history()
975
basis_tree = self.basis_tree()
976
count = self.branch.pull(source, overwrite, stop_revision)
977
new_revision_history = self.branch.revision_history()
978
if new_revision_history != old_revision_history:
980
if len(old_revision_history):
981
other_revision = old_revision_history[-1]
983
other_revision = None
984
repository = self.branch.repository
985
pb = bzrlib.ui.ui_factory.nested_progress_bar()
987
merge_inner(self.branch,
988
self.branch.basis_tree(),
994
self.set_last_revision(self.branch.last_revision())
279
1000
def extras(self):
280
1001
"""Yield all unknown files in this WorkingTree.
347
1138
# treat dotfiles correctly and allows * to match /.
348
1139
# Eventually it should be replaced with something more
351
for pat in self.get_ignore_list():
352
if '/' in pat or '\\' in pat:
354
# as a special case, you can put ./ at the start of a
355
# pattern; this is good to match in the top-level
358
if (pat[:2] == './') or (pat[:2] == '.\\'):
1142
rules = self._get_ignore_rules_as_regex()
1143
for regex, mapping in rules:
1144
match = regex.match(filename)
1145
if match is not None:
1146
# one or more of the groups in mapping will have a non-None group
1148
groups = match.groups()
1149
rules = [mapping[group] for group in
1150
mapping if groups[group] is not None]
1154
def kind(self, file_id):
1155
return file_kind(self.id2abspath(file_id))
1158
def last_revision(self):
1159
"""Return the last revision id of this working tree.
1161
In early branch formats this was == the branch last_revision,
1162
but that cannot be relied upon - for working tree operations,
1163
always use tree.last_revision().
1165
return self.branch.last_revision()
1167
def is_locked(self):
1168
return self._control_files.is_locked()
1170
def lock_read(self):
1171
"""See Branch.lock_read, and WorkingTree.unlock."""
1172
self.branch.lock_read()
1174
return self._control_files.lock_read()
1176
self.branch.unlock()
1179
def lock_write(self):
1180
"""See Branch.lock_write, and WorkingTree.unlock."""
1181
self.branch.lock_write()
1183
return self._control_files.lock_write()
1185
self.branch.unlock()
1188
def get_physical_lock_status(self):
1189
return self._control_files.get_physical_lock_status()
1191
def _basis_inventory_name(self):
1192
return 'basis-inventory'
1195
def set_last_revision(self, new_revision):
1196
"""Change the last revision in the working tree."""
1197
if self._change_last_revision(new_revision):
1198
self._cache_basis_inventory(new_revision)
1200
def _change_last_revision(self, new_revision):
1201
"""Template method part of set_last_revision to perform the change.
1203
This is used to allow WorkingTree3 instances to not affect branch
1204
when their last revision is set.
1206
if new_revision is None:
1207
self.branch.set_revision_history([])
1209
# current format is locked in with the branch
1210
revision_history = self.branch.revision_history()
1212
position = revision_history.index(new_revision)
1214
raise errors.NoSuchRevision(self.branch, new_revision)
1215
self.branch.set_revision_history(revision_history[:position + 1])
1218
def _cache_basis_inventory(self, new_revision):
1219
"""Cache new_revision as the basis inventory."""
1220
# TODO: this should allow the ready-to-use inventory to be passed in,
1221
# as commit already has that ready-to-use [while the format is the
1224
# this double handles the inventory - unpack and repack -
1225
# but is easier to understand. We can/should put a conditional
1226
# in here based on whether the inventory is in the latest format
1227
# - perhaps we should repack all inventories on a repository
1229
# the fast path is to copy the raw xml from the repository. If the
1230
# xml contains 'revision_id="', then we assume the right
1231
# revision_id is set. We must check for this full string, because a
1232
# root node id can legitimately look like 'revision_id' but cannot
1234
xml = self.branch.repository.get_inventory_xml(new_revision)
1235
if not 'revision_id="' in xml.split('\n', 1)[0]:
1236
inv = self.branch.repository.deserialise_inventory(
1238
inv.revision_id = new_revision
1239
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1240
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1241
path = self._basis_inventory_name()
1243
self._control_files.put(path, sio)
1244
except WeaveRevisionNotPresent:
1247
def read_basis_inventory(self):
1248
"""Read the cached basis inventory."""
1249
path = self._basis_inventory_name()
1250
return self._control_files.get(path).read()
1253
def read_working_inventory(self):
1254
"""Read the working inventory."""
1255
# ElementTree does its own conversion from UTF-8, so open in
1257
result = bzrlib.xml5.serializer_v5.read_inventory(
1258
self._control_files.get('inventory'))
1259
self._set_inventory(result)
1263
def remove(self, files, verbose=False, to_file=None):
1264
"""Remove nominated files from the working inventory..
1266
This does not remove their text. This does not run on XXX on what? RBC
1268
TODO: Refuse to remove modified files unless --force is given?
1270
TODO: Do something useful with directories.
1272
TODO: Should this remove the text or not? Tough call; not
1273
removing may be useful and the user can just use use rm, and
1274
is the opposite of add. Removing it is consistent with most
1275
other tools. Maybe an option.
1277
## TODO: Normalize names
1278
## TODO: Remove nested loops; better scalability
1279
if isinstance(files, basestring):
1282
inv = self.inventory
1284
# do this before any modifications
1286
fid = inv.path2id(f)
1288
# TODO: Perhaps make this just a warning, and continue?
1289
# This tends to happen when
1290
raise NotVersionedError(path=f)
1292
# having remove it, it must be either ignored or unknown
1293
if self.is_ignored(f):
362
if fnmatch.fnmatchcase(filename, newpat):
1297
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1300
self._write_inventory(inv)
1303
def revert(self, filenames, old_tree=None, backups=True,
1304
pb=DummyProgress()):
1305
from transform import revert
1306
from conflicts import resolve
1307
if old_tree is None:
1308
old_tree = self.basis_tree()
1309
conflicts = revert(self, old_tree, filenames, backups, pb)
1310
if not len(filenames):
1311
self.set_pending_merges([])
1314
resolve(self, filenames, ignore_misses=True)
1317
# XXX: This method should be deprecated in favour of taking in a proper
1318
# new Inventory object.
1320
def set_inventory(self, new_inventory_list):
1321
from bzrlib.inventory import (Inventory,
1326
inv = Inventory(self.get_root_id())
1327
for path, file_id, parent, kind in new_inventory_list:
1328
name = os.path.basename(path)
1331
# fixme, there should be a factory function inv,add_??
1332
if kind == 'directory':
1333
inv.add(InventoryDirectory(file_id, name, parent))
1334
elif kind == 'file':
1335
inv.add(InventoryFile(file_id, name, parent))
1336
elif kind == 'symlink':
1337
inv.add(InventoryLink(file_id, name, parent))
365
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1339
raise BzrError("unknown kind %r" % kind)
1340
self._write_inventory(inv)
1343
def set_root_id(self, file_id):
1344
"""Set the root id for this tree."""
1345
inv = self.read_working_inventory()
1346
orig_root_id = inv.root.file_id
1347
del inv._byid[inv.root.file_id]
1348
inv.root.file_id = file_id
1349
inv._byid[inv.root.file_id] = inv.root
1352
if entry.parent_id == orig_root_id:
1353
entry.parent_id = inv.root.file_id
1354
self._write_inventory(inv)
1357
"""See Branch.unlock.
1359
WorkingTree locking just uses the Branch locking facilities.
1360
This is current because all working trees have an embedded branch
1361
within them. IF in the future, we were to make branch data shareable
1362
between multiple working trees, i.e. via shared storage, then we
1363
would probably want to lock both the local tree, and the branch.
1365
# FIXME: We want to write out the hashcache only when the last lock on
1366
# this working copy is released. Peeking at the lock count is a bit
1367
# of a nasty hack; probably it's better to have a transaction object,
1368
# which can do some finalization when it's either successfully or
1369
# unsuccessfully completed. (Denys's original patch did that.)
1370
# RBC 20060206 hooking into transaction will couple lock and transaction
1371
# wrongly. Hooking into unlock on the control files object is fine though.
1373
# TODO: split this per format so there is no ugly if block
1374
if self._hashcache.needs_write and (
1375
# dedicated lock files
1376
self._control_files._lock_count==1 or
1378
(self._control_files is self.branch.control_files and
1379
self._control_files._lock_count==3)):
1380
self._hashcache.write()
1381
# reverse order of locking.
1383
return self._control_files.unlock()
1385
self.branch.unlock()
1389
"""Update a working tree along its branch.
1391
This will update the branch if its bound too, which means we have multiple trees involved:
1392
The new basis tree of the master.
1393
The old basis tree of the branch.
1394
The old basis tree of the working tree.
1395
The current working tree state.
1396
pathologically all three may be different, and non ancestors of each other.
1397
Conceptually we want to:
1398
Preserve the wt.basis->wt.state changes
1399
Transform the wt.basis to the new master basis.
1400
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1401
Restore the wt.basis->wt.state changes.
1403
There isn't a single operation at the moment to do that, so we:
1404
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1405
Do a 'normal' merge of the old branch basis if it is relevant.
1407
old_tip = self.branch.update()
1408
if old_tip is not None:
1409
self.add_pending_merge(old_tip)
1410
self.branch.lock_read()
1413
if self.last_revision() != self.branch.last_revision():
1414
# merge tree state up to new branch tip.
1415
basis = self.basis_tree()
1416
to_tree = self.branch.basis_tree()
1417
result += merge_inner(self.branch,
1421
self.set_last_revision(self.branch.last_revision())
1422
if old_tip and old_tip != self.last_revision():
1423
# our last revision was not the prior branch last revision
1424
# and we have converted that last revision to a pending merge.
1425
# base is somewhere between the branch tip now
1426
# and the now pending merge
1427
from bzrlib.revision import common_ancestor
1429
base_rev_id = common_ancestor(self.branch.last_revision(),
1431
self.branch.repository)
1432
except errors.NoCommonAncestor:
1434
base_tree = self.branch.repository.revision_tree(base_rev_id)
1435
other_tree = self.branch.repository.revision_tree(old_tip)
1436
result += merge_inner(self.branch,
1442
self.branch.unlock()
1445
def _write_inventory(self, inv):
1446
"""Write inventory as the current inventory."""
1448
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1450
self._control_files.put('inventory', sio)
1451
self._set_inventory(inv)
1452
mutter('wrote working inventory')
1454
def set_conflicts(self, arg):
1455
raise UnsupportedOperation(self.set_conflicts, self)
1458
def conflicts(self):
1459
conflicts = ConflictList()
1460
for conflicted in self._iter_conflicts():
1463
if file_kind(self.abspath(conflicted)) != "file":
1465
except errors.NoSuchFile:
1468
for suffix in ('.THIS', '.OTHER'):
1470
kind = file_kind(self.abspath(conflicted+suffix))
1473
except errors.NoSuchFile:
1477
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1478
conflicts.append(Conflict.factory(ctype, path=conflicted,
1479
file_id=self.path2id(conflicted)))
1483
class WorkingTree3(WorkingTree):
1484
"""This is the Format 3 working tree.
1486
This differs from the base WorkingTree by:
1487
- having its own file lock
1488
- having its own last-revision property.
1490
This is new in bzr 0.8
1494
def last_revision(self):
1495
"""See WorkingTree.last_revision."""
1497
return self._control_files.get_utf8('last-revision').read()
1501
def _change_last_revision(self, revision_id):
1502
"""See WorkingTree._change_last_revision."""
1503
if revision_id is None or revision_id == NULL_REVISION:
1505
self._control_files._transport.delete('last-revision')
1506
except errors.NoSuchFile:
1511
self.branch.revision_history().index(revision_id)
1513
raise errors.NoSuchRevision(self.branch, revision_id)
1514
self._control_files.put_utf8('last-revision', revision_id)
1518
def set_conflicts(self, conflicts):
1519
self._put_rio('conflicts', conflicts.to_stanzas(),
1523
def conflicts(self):
1525
confile = self._control_files.get('conflicts')
1527
return ConflictList()
1529
if confile.next() != CONFLICT_HEADER_1 + '\n':
1530
raise ConflictFormatError()
1531
except StopIteration:
1532
raise ConflictFormatError()
1533
return ConflictList.from_stanzas(RioReader(confile))
1536
def get_conflicted_stem(path):
1537
for suffix in CONFLICT_SUFFIXES:
1538
if path.endswith(suffix):
1539
return path[:-len(suffix)]
1541
@deprecated_function(zero_eight)
1542
def is_control_file(filename):
1543
"""See WorkingTree.is_control_filename(filename)."""
1544
## FIXME: better check
1545
filename = normpath(filename)
1546
while filename != '':
1547
head, tail = os.path.split(filename)
1548
## mutter('check %r for control file' % ((head, tail),))
1551
if filename == head:
1557
class WorkingTreeFormat(object):
1558
"""An encapsulation of the initialization and open routines for a format.
1560
Formats provide three things:
1561
* An initialization routine,
1565
Formats are placed in an dict by their format string for reference
1566
during workingtree opening. Its not required that these be instances, they
1567
can be classes themselves with class methods - it simply depends on
1568
whether state is needed for a given format or not.
1570
Once a format is deprecated, just deprecate the initialize and open
1571
methods on the format class. Do not deprecate the object, as the
1572
object will be created every time regardless.
1575
_default_format = None
1576
"""The default format used for new trees."""
1579
"""The known formats."""
1582
def find_format(klass, a_bzrdir):
1583
"""Return the format for the working tree object in a_bzrdir."""
1585
transport = a_bzrdir.get_workingtree_transport(None)
1586
format_string = transport.get("format").read()
1587
return klass._formats[format_string]
1589
raise errors.NoWorkingTree(base=transport.base)
1591
raise errors.UnknownFormatError(format=format_string)
1594
def get_default_format(klass):
1595
"""Return the current default format."""
1596
return klass._default_format
1598
def get_format_string(self):
1599
"""Return the ASCII format string that identifies this format."""
1600
raise NotImplementedError(self.get_format_string)
1602
def get_format_description(self):
1603
"""Return the short description for this format."""
1604
raise NotImplementedError(self.get_format_description)
1606
def is_supported(self):
1607
"""Is this format supported?
1609
Supported formats can be initialized and opened.
1610
Unsupported formats may not support initialization or committing or
1611
some other features depending on the reason for not being supported.
1616
def register_format(klass, format):
1617
klass._formats[format.get_format_string()] = format
1620
def set_default_format(klass, format):
1621
klass._default_format = format
1624
def unregister_format(klass, format):
1625
assert klass._formats[format.get_format_string()] is format
1626
del klass._formats[format.get_format_string()]
1630
class WorkingTreeFormat2(WorkingTreeFormat):
1631
"""The second working tree format.
1633
This format modified the hash cache from the format 1 hash cache.
1636
def get_format_description(self):
1637
"""See WorkingTreeFormat.get_format_description()."""
1638
return "Working tree format 2"
1640
def stub_initialize_remote(self, control_files):
1641
"""As a special workaround create critical control files for a remote working tree
1643
This ensures that it can later be updated and dealt with locally,
1644
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1645
no working tree. (See bug #43064).
1649
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1651
control_files.put('inventory', sio)
1653
control_files.put_utf8('pending-merges', '')
1656
def initialize(self, a_bzrdir, revision_id=None):
1657
"""See WorkingTreeFormat.initialize()."""
1658
if not isinstance(a_bzrdir.transport, LocalTransport):
1659
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1660
branch = a_bzrdir.open_branch()
1661
if revision_id is not None:
1664
revision_history = branch.revision_history()
1666
position = revision_history.index(revision_id)
1668
raise errors.NoSuchRevision(branch, revision_id)
1669
branch.set_revision_history(revision_history[:position + 1])
1672
revision = branch.last_revision()
1674
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1680
wt._write_inventory(inv)
1681
wt.set_root_id(inv.root.file_id)
1682
wt.set_last_revision(revision)
1683
wt.set_pending_merges([])
1684
build_tree(wt.basis_tree(), wt)
1688
super(WorkingTreeFormat2, self).__init__()
1689
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1691
def open(self, a_bzrdir, _found=False):
1692
"""Return the WorkingTree object for a_bzrdir
1694
_found is a private parameter, do not use it. It is used to indicate
1695
if format probing has already been done.
1698
# we are being called directly and must probe.
1699
raise NotImplementedError
1700
if not isinstance(a_bzrdir.transport, LocalTransport):
1701
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1702
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1708
class WorkingTreeFormat3(WorkingTreeFormat):
1709
"""The second working tree format updated to record a format marker.
1712
- exists within a metadir controlling .bzr
1713
- includes an explicit version marker for the workingtree control
1714
files, separate from the BzrDir format
1715
- modifies the hash cache format
1717
- uses a LockDir to guard access to the repository
1720
def get_format_string(self):
1721
"""See WorkingTreeFormat.get_format_string()."""
1722
return "Bazaar-NG Working Tree format 3"
1724
def get_format_description(self):
1725
"""See WorkingTreeFormat.get_format_description()."""
1726
return "Working tree format 3"
1728
_lock_file_name = 'lock'
1729
_lock_class = LockDir
1731
def _open_control_files(self, a_bzrdir):
1732
transport = a_bzrdir.get_workingtree_transport(None)
1733
return LockableFiles(transport, self._lock_file_name,
1736
def initialize(self, a_bzrdir, revision_id=None):
1737
"""See WorkingTreeFormat.initialize().
1739
revision_id allows creating a working tree at a different
1740
revision than the branch is at.
1742
if not isinstance(a_bzrdir.transport, LocalTransport):
1743
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1744
transport = a_bzrdir.get_workingtree_transport(self)
1745
control_files = self._open_control_files(a_bzrdir)
1746
control_files.create_lock()
1747
control_files.lock_write()
1748
control_files.put_utf8('format', self.get_format_string())
1749
branch = a_bzrdir.open_branch()
1750
if revision_id is None:
1751
revision_id = branch.last_revision()
1753
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1759
_control_files=control_files)
1762
wt._write_inventory(inv)
1763
wt.set_root_id(inv.root.file_id)
1764
wt.set_last_revision(revision_id)
1765
wt.set_pending_merges([])
1766
build_tree(wt.basis_tree(), wt)
1769
control_files.unlock()
1773
super(WorkingTreeFormat3, self).__init__()
1774
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1776
def open(self, a_bzrdir, _found=False):
1777
"""Return the WorkingTree object for a_bzrdir
1779
_found is a private parameter, do not use it. It is used to indicate
1780
if format probing has already been done.
1783
# we are being called directly and must probe.
1784
raise NotImplementedError
1785
if not isinstance(a_bzrdir.transport, LocalTransport):
1786
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1787
control_files = self._open_control_files(a_bzrdir)
1788
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1792
_control_files=control_files)
1795
return self.get_format_string()
1798
# formats which have no format string are not discoverable
1799
# and not independently creatable, so are not registered.
1800
__default_format = WorkingTreeFormat3()
1801
WorkingTreeFormat.register_format(__default_format)
1802
WorkingTreeFormat.set_default_format(__default_format)
1803
_legacy_formats = [WorkingTreeFormat2(),
1807
class WorkingTreeTestProviderAdapter(object):
1808
"""A tool to generate a suite testing multiple workingtree formats at once.
1810
This is done by copying the test once for each transport and injecting
1811
the transport_server, transport_readonly_server, and workingtree_format
1812
classes into each copy. Each copy is also given a new id() to make it
1816
def __init__(self, transport_server, transport_readonly_server, formats):
1817
self._transport_server = transport_server
1818
self._transport_readonly_server = transport_readonly_server
1819
self._formats = formats
1821
def adapt(self, test):
1822
from bzrlib.tests import TestSuite
1823
result = TestSuite()
1824
for workingtree_format, bzrdir_format in self._formats:
1825
new_test = deepcopy(test)
1826
new_test.transport_server = self._transport_server
1827
new_test.transport_readonly_server = self._transport_readonly_server
1828
new_test.bzrdir_format = bzrdir_format
1829
new_test.workingtree_format = workingtree_format
1830
def make_new_test_id():
1831
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1832
return lambda: new_id
1833
new_test.id = make_new_test_id()
1834
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
