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
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
25
105
import bzrlib.tree
26
from errors import BzrCheckError
27
from trace import mutter
110
# the regex here does the following:
111
# 1) remove any weird characters; we don't escape them but rather
113
# 2) match leading '.'s to make it not hidden
114
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
115
_gen_id_suffix = None
119
def _next_id_suffix():
120
"""Create a new file id suffix that is reasonably unique.
122
On the first call we combine the current time with 64 bits of randomness
123
to give a highly probably globally unique number. Then each call in the same
124
process adds 1 to a serial number we append to that unique value.
126
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
127
# than having to move the id randomness out of the inner loop like this.
128
# XXX TODO: for the global randomness this uses we should add the thread-id
129
# before the serial #.
130
global _gen_id_suffix, _gen_id_serial
131
if _gen_id_suffix is None:
132
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
134
return _gen_id_suffix + str(_gen_id_serial)
137
def gen_file_id(name):
138
"""Return new file id for the basename 'name'.
140
The uniqueness is supplied from _next_id_suffix.
142
# XXX TODO: squash the filename to lowercase.
143
# XXX TODO: truncate the filename to something like 20 or 30 chars.
144
# XXX TODO: consider what to do with ids that look like illegal filepaths
145
# on platforms we support.
146
return _gen_file_id_re.sub('', name) + _next_id_suffix()
150
"""Return a new tree-root file id."""
151
return gen_file_id('TREE_ROOT')
154
class TreeEntry(object):
155
"""An entry that implements the minimum interface used by commands.
157
This needs further inspection, it may be better to have
158
InventoryEntries without ids - though that seems wrong. For now,
159
this is a parallel hierarchy to InventoryEntry, and needs to become
160
one of several things: decorates to that hierarchy, children of, or
162
Another note is that these objects are currently only used when there is
163
no InventoryEntry available - i.e. for unversioned objects.
164
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
167
def __eq__(self, other):
168
# yes, this us ugly, TODO: best practice __eq__ style.
169
return (isinstance(other, TreeEntry)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class TreeDirectory(TreeEntry):
177
"""See TreeEntry. This is a directory in a working tree."""
179
def __eq__(self, other):
180
return (isinstance(other, TreeDirectory)
181
and other.__class__ == self.__class__)
183
def kind_character(self):
187
class TreeFile(TreeEntry):
188
"""See TreeEntry. This is a regular file in a working tree."""
190
def __eq__(self, other):
191
return (isinstance(other, TreeFile)
192
and other.__class__ == self.__class__)
194
def kind_character(self):
198
class TreeLink(TreeEntry):
199
"""See TreeEntry. This is a symlink in a working tree."""
201
def __eq__(self, other):
202
return (isinstance(other, TreeLink)
203
and other.__class__ == self.__class__)
205
def kind_character(self):
29
209
class WorkingTree(bzrlib.tree.Tree):
30
210
"""Working copy tree.
35
215
It is possible for a `WorkingTree` to have a filename which is
36
216
not listed in the Inventory and vice versa.
38
def __init__(self, basedir, inv):
219
def __init__(self, basedir='.',
220
branch=DEPRECATED_PARAMETER,
226
"""Construct a WorkingTree for basedir.
228
If the branch is not supplied, it is opened automatically.
229
If the branch is supplied, it must be the branch for this basedir.
230
(branch.base is not cross checked, because for remote branches that
231
would be meaningless).
233
self._format = _format
234
self.bzrdir = _bzrdir
236
# not created via open etc.
237
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
238
"Please use bzrdir.open_workingtree or WorkingTree.open().",
241
wt = WorkingTree.open(basedir)
242
self._branch = wt.branch
243
self.basedir = wt.basedir
244
self._control_files = wt._control_files
245
self._hashcache = wt._hashcache
246
self._set_inventory(wt._inventory)
247
self._format = wt._format
248
self.bzrdir = wt.bzrdir
39
249
from bzrlib.hashcache import HashCache
40
250
from bzrlib.trace import note, mutter
43
self.basedir = basedir
44
self.path2id = inv.path2id
251
assert isinstance(basedir, basestring), \
252
"base directory %r is not a string" % basedir
253
basedir = safe_unicode(basedir)
254
mutter("opening working tree %r", basedir)
255
if deprecated_passed(branch):
257
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
258
" Please use bzrdir.open_workingtree() or"
259
" WorkingTree.open().",
263
self._branch = branch
265
self._branch = self.bzrdir.open_branch()
266
self.basedir = realpath(basedir)
267
# if branch is at our basedir and is a format 6 or less
268
if isinstance(self._format, WorkingTreeFormat2):
269
# share control object
270
self._control_files = self.branch.control_files
272
# assume all other formats have their own control files.
273
assert isinstance(_control_files, LockableFiles), \
274
"_control_files must be a LockableFiles, not %r" \
276
self._control_files = _control_files
46
277
# update the whole cache up front and write to disk if anything changed;
47
278
# in the future we might want to do this more selectively
48
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.
52
289
if hc.needs_write:
53
290
mutter("write hc")
58
if self._hashcache.needs_write:
59
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
357
path = osutils.getcwd()
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)
62
370
def __iter__(self):
63
371
"""Iterate through file_ids for this tree.
89
455
def get_file_byname(self, filename):
90
456
return file(self.abspath(filename), 'rb')
458
def get_parent_ids(self):
459
"""See Tree.get_parent_ids.
461
This implementation reads the pending merges list and last_revision
462
value and uses that to decide what the parents list should be.
464
last_rev = self.last_revision()
469
other_parents = self.pending_merges()
470
return parents + other_parents
472
def get_root_id(self):
473
"""Return the id of this trees root"""
474
inv = self.read_working_inventory()
475
return inv.root.file_id
92
477
def _get_store_filename(self, file_id):
93
## XXX: badly named; this isn't in the store at all
94
return self.abspath(self.id2path(file_id))
478
## XXX: badly named; this is not in the store at all
479
return self.abspath(self.id2path(file_id))
482
def clone(self, to_bzrdir, revision_id=None, basis=None):
483
"""Duplicate this working tree into to_bzr, including all state.
485
Specifically modified files are kept as modified, but
486
ignored and unknown files are discarded.
488
If you want to make a new line of development, see bzrdir.sprout()
491
If not None, the cloned tree will have its last revision set to
492
revision, and and difference between the source trees last revision
493
and this one merged in.
496
If not None, a closer copy of a tree which may have some files in
497
common, and which file content should be preferentially copied from.
499
# assumes the target bzr dir format is compatible.
500
result = self._format.initialize(to_bzrdir)
501
self.copy_content_into(result, revision_id)
505
def copy_content_into(self, tree, revision_id=None):
506
"""Copy the current content and user files of this tree into tree."""
507
if revision_id is None:
508
transform_tree(tree, self)
510
# TODO now merge from tree.last_revision to revision
511
transform_tree(tree, self)
512
tree.set_last_revision(revision_id)
515
def commit(self, message=None, revprops=None, *args, **kwargs):
516
# avoid circular imports
517
from bzrlib.commit import Commit
520
if not 'branch-nick' in revprops:
521
revprops['branch-nick'] = self.branch.nick
522
# args for wt.commit start at message from the Commit.commit method,
523
# but with branch a kwarg now, passing in args as is results in the
524
#message being used for the branch
525
args = (DEPRECATED_PARAMETER, message, ) + args
526
committed_id = Commit().commit( working_tree=self, revprops=revprops,
528
self._set_inventory(self.read_working_inventory())
531
def id2abspath(self, file_id):
532
return self.abspath(self.id2path(file_id))
97
534
def has_id(self, file_id):
98
535
# files that have been deleted are excluded
99
536
inv = self._inventory
100
537
if not inv.has_id(file_id):
102
539
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
540
return 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)
106
547
__contains__ = has_id
109
549
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
114
def get_file_sha1(self, file_id):
115
path = self._inventory.id2path(file_id)
550
return os.path.getsize(self.id2abspath(file_id))
553
def get_file_sha1(self, file_id, path=None):
555
path = self._inventory.id2path(file_id)
116
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
563
if not supports_executable():
564
def is_executable(self, file_id, path=None):
565
return self._inventory[file_id].executable
567
def is_executable(self, file_id, path=None):
569
path = self._inventory.id2path(file_id)
570
mode = os.lstat(self.abspath(path)).st_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
701
def get_symlink_target(self, file_id):
702
return os.readlink(self.id2abspath(file_id))
119
704
def file_class(self, filename):
120
705
if self.path2id(filename):
173
795
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
797
# make a last minute entry
799
yield fp[1:], c, fk, f_ie.file_id, f_ie
802
yield fp[1:], c, fk, None, fk_entries[fk]()
804
yield fp[1:], c, fk, None, TreeEntry()
177
807
if fk != 'directory':
181
# don't descend unversioned directories
184
for ff in descend(fp, f_ie.file_id, fap):
187
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)
192
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.
193
946
for subp in self.extras():
194
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())
198
1000
def extras(self):
199
1001
"""Yield all unknown files in this WorkingTree.
268
1145
# treat dotfiles correctly and allows * to match /.
269
1146
# Eventually it should be replaced with something more
273
from osutils import splitpath
275
for pat in self.get_ignore_list():
276
if '/' in pat or '\\' in pat:
278
# as a special case, you can put ./ at the start of a
279
# pattern; this is good to match in the top-level
282
if (pat[:2] == './') or (pat[:2] == '.\\'):
1149
rules = self._get_ignore_rules_as_regex()
1150
for regex, mapping in rules:
1151
match = regex.match(filename)
1152
if match is not None:
1153
# one or more of the groups in mapping will have a non-None group
1155
groups = match.groups()
1156
rules = [mapping[group] for group in
1157
mapping if groups[group] is not None]
1161
def kind(self, file_id):
1162
return file_kind(self.id2abspath(file_id))
1165
def last_revision(self):
1166
"""Return the last revision id of this working tree.
1168
In early branch formats this was == the branch last_revision,
1169
but that cannot be relied upon - for working tree operations,
1170
always use tree.last_revision().
1172
return self.branch.last_revision()
1174
def is_locked(self):
1175
return self._control_files.is_locked()
1177
def lock_read(self):
1178
"""See Branch.lock_read, and WorkingTree.unlock."""
1179
self.branch.lock_read()
1181
return self._control_files.lock_read()
1183
self.branch.unlock()
1186
def lock_write(self):
1187
"""See Branch.lock_write, and WorkingTree.unlock."""
1188
self.branch.lock_write()
1190
return self._control_files.lock_write()
1192
self.branch.unlock()
1195
def get_physical_lock_status(self):
1196
return self._control_files.get_physical_lock_status()
1198
def _basis_inventory_name(self):
1199
return 'basis-inventory'
1202
def set_last_revision(self, new_revision):
1203
"""Change the last revision in the working tree."""
1204
if self._change_last_revision(new_revision):
1205
self._cache_basis_inventory(new_revision)
1207
def _change_last_revision(self, new_revision):
1208
"""Template method part of set_last_revision to perform the change.
1210
This is used to allow WorkingTree3 instances to not affect branch
1211
when their last revision is set.
1213
if new_revision is None:
1214
self.branch.set_revision_history([])
1216
# current format is locked in with the branch
1217
revision_history = self.branch.revision_history()
1219
position = revision_history.index(new_revision)
1221
raise errors.NoSuchRevision(self.branch, new_revision)
1222
self.branch.set_revision_history(revision_history[:position + 1])
1225
def _cache_basis_inventory(self, new_revision):
1226
"""Cache new_revision as the basis inventory."""
1227
# TODO: this should allow the ready-to-use inventory to be passed in,
1228
# as commit already has that ready-to-use [while the format is the
1231
# this double handles the inventory - unpack and repack -
1232
# but is easier to understand. We can/should put a conditional
1233
# in here based on whether the inventory is in the latest format
1234
# - perhaps we should repack all inventories on a repository
1236
# the fast path is to copy the raw xml from the repository. If the
1237
# xml contains 'revision_id="', then we assume the right
1238
# revision_id is set. We must check for this full string, because a
1239
# root node id can legitimately look like 'revision_id' but cannot
1241
xml = self.branch.repository.get_inventory_xml(new_revision)
1242
if not 'revision_id="' in xml.split('\n', 1)[0]:
1243
inv = self.branch.repository.deserialise_inventory(
1245
inv.revision_id = new_revision
1246
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1247
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1248
path = self._basis_inventory_name()
1250
self._control_files.put(path, sio)
1251
except WeaveRevisionNotPresent:
1254
def read_basis_inventory(self):
1255
"""Read the cached basis inventory."""
1256
path = self._basis_inventory_name()
1257
return self._control_files.get(path).read()
1260
def read_working_inventory(self):
1261
"""Read the working inventory."""
1262
# ElementTree does its own conversion from UTF-8, so open in
1264
result = bzrlib.xml5.serializer_v5.read_inventory(
1265
self._control_files.get('inventory'))
1266
self._set_inventory(result)
1270
def remove(self, files, verbose=False, to_file=None):
1271
"""Remove nominated files from the working inventory..
1273
This does not remove their text. This does not run on XXX on what? RBC
1275
TODO: Refuse to remove modified files unless --force is given?
1277
TODO: Do something useful with directories.
1279
TODO: Should this remove the text or not? Tough call; not
1280
removing may be useful and the user can just use use rm, and
1281
is the opposite of add. Removing it is consistent with most
1282
other tools. Maybe an option.
1284
## TODO: Normalize names
1285
## TODO: Remove nested loops; better scalability
1286
if isinstance(files, basestring):
1289
inv = self.inventory
1291
# do this before any modifications
1293
fid = inv.path2id(f)
1295
# TODO: Perhaps make this just a warning, and continue?
1296
# This tends to happen when
1297
raise NotVersionedError(path=f)
1299
# having remove it, it must be either ignored or unknown
1300
if self.is_ignored(f):
286
if fnmatch.fnmatchcase(filename, newpat):
1304
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1307
self._write_inventory(inv)
1310
def revert(self, filenames, old_tree=None, backups=True,
1311
pb=DummyProgress()):
1312
from transform import revert
1313
from conflicts import resolve
1314
if old_tree is None:
1315
old_tree = self.basis_tree()
1316
conflicts = revert(self, old_tree, filenames, backups, pb)
1317
if not len(filenames):
1318
self.set_pending_merges([])
1321
resolve(self, filenames, ignore_misses=True)
1324
# XXX: This method should be deprecated in favour of taking in a proper
1325
# new Inventory object.
1327
def set_inventory(self, new_inventory_list):
1328
from bzrlib.inventory import (Inventory,
1333
inv = Inventory(self.get_root_id())
1334
for path, file_id, parent, kind in new_inventory_list:
1335
name = os.path.basename(path)
1338
# fixme, there should be a factory function inv,add_??
1339
if kind == 'directory':
1340
inv.add(InventoryDirectory(file_id, name, parent))
1341
elif kind == 'file':
1342
inv.add(InventoryFile(file_id, name, parent))
1343
elif kind == 'symlink':
1344
inv.add(InventoryLink(file_id, name, parent))
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1346
raise BzrError("unknown kind %r" % kind)
1347
self._write_inventory(inv)
1350
def set_root_id(self, file_id):
1351
"""Set the root id for this tree."""
1352
inv = self.read_working_inventory()
1353
orig_root_id = inv.root.file_id
1354
del inv._byid[inv.root.file_id]
1355
inv.root.file_id = file_id
1356
inv._byid[inv.root.file_id] = inv.root
1359
if entry.parent_id == orig_root_id:
1360
entry.parent_id = inv.root.file_id
1361
self._write_inventory(inv)
1364
"""See Branch.unlock.
1366
WorkingTree locking just uses the Branch locking facilities.
1367
This is current because all working trees have an embedded branch
1368
within them. IF in the future, we were to make branch data shareable
1369
between multiple working trees, i.e. via shared storage, then we
1370
would probably want to lock both the local tree, and the branch.
1372
# FIXME: We want to write out the hashcache only when the last lock on
1373
# this working copy is released. Peeking at the lock count is a bit
1374
# of a nasty hack; probably it's better to have a transaction object,
1375
# which can do some finalization when it's either successfully or
1376
# unsuccessfully completed. (Denys's original patch did that.)
1377
# RBC 20060206 hooking into transaction will couple lock and transaction
1378
# wrongly. Hooking into unlock on the control files object is fine though.
1380
# TODO: split this per format so there is no ugly if block
1381
if self._hashcache.needs_write and (
1382
# dedicated lock files
1383
self._control_files._lock_count==1 or
1385
(self._control_files is self.branch.control_files and
1386
self._control_files._lock_count==3)):
1387
self._hashcache.write()
1388
# reverse order of locking.
1390
return self._control_files.unlock()
1392
self.branch.unlock()
1396
"""Update a working tree along its branch.
1398
This will update the branch if its bound too, which means we have multiple trees involved:
1399
The new basis tree of the master.
1400
The old basis tree of the branch.
1401
The old basis tree of the working tree.
1402
The current working tree state.
1403
pathologically all three may be different, and non ancestors of each other.
1404
Conceptually we want to:
1405
Preserve the wt.basis->wt.state changes
1406
Transform the wt.basis to the new master basis.
1407
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1408
Restore the wt.basis->wt.state changes.
1410
There isn't a single operation at the moment to do that, so we:
1411
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1412
Do a 'normal' merge of the old branch basis if it is relevant.
1414
old_tip = self.branch.update()
1415
if old_tip is not None:
1416
self.add_pending_merge(old_tip)
1417
self.branch.lock_read()
1420
if self.last_revision() != self.branch.last_revision():
1421
# merge tree state up to new branch tip.
1422
basis = self.basis_tree()
1423
to_tree = self.branch.basis_tree()
1424
result += merge_inner(self.branch,
1428
self.set_last_revision(self.branch.last_revision())
1429
if old_tip and old_tip != self.last_revision():
1430
# our last revision was not the prior branch last revision
1431
# and we have converted that last revision to a pending merge.
1432
# base is somewhere between the branch tip now
1433
# and the now pending merge
1434
from bzrlib.revision import common_ancestor
1436
base_rev_id = common_ancestor(self.branch.last_revision(),
1438
self.branch.repository)
1439
except errors.NoCommonAncestor:
1441
base_tree = self.branch.repository.revision_tree(base_rev_id)
1442
other_tree = self.branch.repository.revision_tree(old_tip)
1443
result += merge_inner(self.branch,
1449
self.branch.unlock()
1452
def _write_inventory(self, inv):
1453
"""Write inventory as the current inventory."""
1455
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1457
self._control_files.put('inventory', sio)
1458
self._set_inventory(inv)
1459
mutter('wrote working inventory')
1461
def set_conflicts(self, arg):
1462
raise UnsupportedOperation(self.set_conflicts, self)
1464
def add_conflicts(self, arg):
1465
raise UnsupportedOperation(self.add_conflicts, self)
1468
def conflicts(self):
1469
conflicts = ConflictList()
1470
for conflicted in self._iter_conflicts():
1473
if file_kind(self.abspath(conflicted)) != "file":
1475
except errors.NoSuchFile:
1478
for suffix in ('.THIS', '.OTHER'):
1480
kind = file_kind(self.abspath(conflicted+suffix))
1483
except errors.NoSuchFile:
1487
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1488
conflicts.append(Conflict.factory(ctype, path=conflicted,
1489
file_id=self.path2id(conflicted)))
1493
class WorkingTree3(WorkingTree):
1494
"""This is the Format 3 working tree.
1496
This differs from the base WorkingTree by:
1497
- having its own file lock
1498
- having its own last-revision property.
1500
This is new in bzr 0.8
1504
def last_revision(self):
1505
"""See WorkingTree.last_revision."""
1507
return self._control_files.get_utf8('last-revision').read()
b'\\ No newline at end of file'
1511
def _change_last_revision(self, revision_id):
1512
"""See WorkingTree._change_last_revision."""
1513
if revision_id is None or revision_id == NULL_REVISION:
1515
self._control_files._transport.delete('last-revision')
1516
except errors.NoSuchFile:
1521
self.branch.revision_history().index(revision_id)
1523
raise errors.NoSuchRevision(self.branch, revision_id)
1524
self._control_files.put_utf8('last-revision', revision_id)
1528
def set_conflicts(self, conflicts):
1529
self._put_rio('conflicts', conflicts.to_stanzas(),
1533
def add_conflicts(self, new_conflicts):
1534
conflict_set = set(self.conflicts())
1535
conflict_set.update(set(list(new_conflicts)))
1536
self.set_conflicts(ConflictList(sorted(conflict_set,
1537
key=Conflict.sort_key)))
1540
def conflicts(self):
1542
confile = self._control_files.get('conflicts')
1544
return ConflictList()
1546
if confile.next() != CONFLICT_HEADER_1 + '\n':
1547
raise ConflictFormatError()
1548
except StopIteration:
1549
raise ConflictFormatError()
1550
return ConflictList.from_stanzas(RioReader(confile))
1553
def get_conflicted_stem(path):
1554
for suffix in CONFLICT_SUFFIXES:
1555
if path.endswith(suffix):
1556
return path[:-len(suffix)]
1558
@deprecated_function(zero_eight)
1559
def is_control_file(filename):
1560
"""See WorkingTree.is_control_filename(filename)."""
1561
## FIXME: better check
1562
filename = normpath(filename)
1563
while filename != '':
1564
head, tail = os.path.split(filename)
1565
## mutter('check %r for control file' % ((head, tail),))
1568
if filename == head:
1574
class WorkingTreeFormat(object):
1575
"""An encapsulation of the initialization and open routines for a format.
1577
Formats provide three things:
1578
* An initialization routine,
1582
Formats are placed in an dict by their format string for reference
1583
during workingtree opening. Its not required that these be instances, they
1584
can be classes themselves with class methods - it simply depends on
1585
whether state is needed for a given format or not.
1587
Once a format is deprecated, just deprecate the initialize and open
1588
methods on the format class. Do not deprecate the object, as the
1589
object will be created every time regardless.
1592
_default_format = None
1593
"""The default format used for new trees."""
1596
"""The known formats."""
1599
def find_format(klass, a_bzrdir):
1600
"""Return the format for the working tree object in a_bzrdir."""
1602
transport = a_bzrdir.get_workingtree_transport(None)
1603
format_string = transport.get("format").read()
1604
return klass._formats[format_string]
1606
raise errors.NoWorkingTree(base=transport.base)
1608
raise errors.UnknownFormatError(format=format_string)
1611
def get_default_format(klass):
1612
"""Return the current default format."""
1613
return klass._default_format
1615
def get_format_string(self):
1616
"""Return the ASCII format string that identifies this format."""
1617
raise NotImplementedError(self.get_format_string)
1619
def get_format_description(self):
1620
"""Return the short description for this format."""
1621
raise NotImplementedError(self.get_format_description)
1623
def is_supported(self):
1624
"""Is this format supported?
1626
Supported formats can be initialized and opened.
1627
Unsupported formats may not support initialization or committing or
1628
some other features depending on the reason for not being supported.
1633
def register_format(klass, format):
1634
klass._formats[format.get_format_string()] = format
1637
def set_default_format(klass, format):
1638
klass._default_format = format
1641
def unregister_format(klass, format):
1642
assert klass._formats[format.get_format_string()] is format
1643
del klass._formats[format.get_format_string()]
1647
class WorkingTreeFormat2(WorkingTreeFormat):
1648
"""The second working tree format.
1650
This format modified the hash cache from the format 1 hash cache.
1653
def get_format_description(self):
1654
"""See WorkingTreeFormat.get_format_description()."""
1655
return "Working tree format 2"
1657
def stub_initialize_remote(self, control_files):
1658
"""As a special workaround create critical control files for a remote working tree
1660
This ensures that it can later be updated and dealt with locally,
1661
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1662
no working tree. (See bug #43064).
1666
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1668
control_files.put('inventory', sio)
1670
control_files.put_utf8('pending-merges', '')
1673
def initialize(self, a_bzrdir, revision_id=None):
1674
"""See WorkingTreeFormat.initialize()."""
1675
if not isinstance(a_bzrdir.transport, LocalTransport):
1676
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1677
branch = a_bzrdir.open_branch()
1678
if revision_id is not None:
1681
revision_history = branch.revision_history()
1683
position = revision_history.index(revision_id)
1685
raise errors.NoSuchRevision(branch, revision_id)
1686
branch.set_revision_history(revision_history[:position + 1])
1689
revision = branch.last_revision()
1691
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1697
wt._write_inventory(inv)
1698
wt.set_root_id(inv.root.file_id)
1699
wt.set_last_revision(revision)
1700
wt.set_pending_merges([])
1701
build_tree(wt.basis_tree(), wt)
1705
super(WorkingTreeFormat2, self).__init__()
1706
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1708
def open(self, a_bzrdir, _found=False):
1709
"""Return the WorkingTree object for a_bzrdir
1711
_found is a private parameter, do not use it. It is used to indicate
1712
if format probing has already been done.
1715
# we are being called directly and must probe.
1716
raise NotImplementedError
1717
if not isinstance(a_bzrdir.transport, LocalTransport):
1718
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1719
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1725
class WorkingTreeFormat3(WorkingTreeFormat):
1726
"""The second working tree format updated to record a format marker.
1729
- exists within a metadir controlling .bzr
1730
- includes an explicit version marker for the workingtree control
1731
files, separate from the BzrDir format
1732
- modifies the hash cache format
1734
- uses a LockDir to guard access for writes.
1737
def get_format_string(self):
1738
"""See WorkingTreeFormat.get_format_string()."""
1739
return "Bazaar-NG Working Tree format 3"
1741
def get_format_description(self):
1742
"""See WorkingTreeFormat.get_format_description()."""
1743
return "Working tree format 3"
1745
_lock_file_name = 'lock'
1746
_lock_class = LockDir
1748
def _open_control_files(self, a_bzrdir):
1749
transport = a_bzrdir.get_workingtree_transport(None)
1750
return LockableFiles(transport, self._lock_file_name,
1753
def initialize(self, a_bzrdir, revision_id=None):
1754
"""See WorkingTreeFormat.initialize().
1756
revision_id allows creating a working tree at a different
1757
revision than the branch is at.
1759
if not isinstance(a_bzrdir.transport, LocalTransport):
1760
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1761
transport = a_bzrdir.get_workingtree_transport(self)
1762
control_files = self._open_control_files(a_bzrdir)
1763
control_files.create_lock()
1764
control_files.lock_write()
1765
control_files.put_utf8('format', self.get_format_string())
1766
branch = a_bzrdir.open_branch()
1767
if revision_id is None:
1768
revision_id = branch.last_revision()
1770
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1776
_control_files=control_files)
1779
wt._write_inventory(inv)
1780
wt.set_root_id(inv.root.file_id)
1781
wt.set_last_revision(revision_id)
1782
wt.set_pending_merges([])
1783
build_tree(wt.basis_tree(), wt)
1786
control_files.unlock()
1790
super(WorkingTreeFormat3, self).__init__()
1791
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1793
def open(self, a_bzrdir, _found=False):
1794
"""Return the WorkingTree object for a_bzrdir
1796
_found is a private parameter, do not use it. It is used to indicate
1797
if format probing has already been done.
1800
# we are being called directly and must probe.
1801
raise NotImplementedError
1802
if not isinstance(a_bzrdir.transport, LocalTransport):
1803
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1804
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1806
def _open(self, a_bzrdir, control_files):
1807
"""Open the tree itself.
1809
:param a_bzrdir: the dir for the tree.
1810
:param control_files: the control files for the tree.
1812
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1816
_control_files=control_files)
1819
return self.get_format_string()
1822
# formats which have no format string are not discoverable
1823
# and not independently creatable, so are not registered.
1824
__default_format = WorkingTreeFormat3()
1825
WorkingTreeFormat.register_format(__default_format)
1826
WorkingTreeFormat.set_default_format(__default_format)
1827
_legacy_formats = [WorkingTreeFormat2(),
1831
class WorkingTreeTestProviderAdapter(object):
1832
"""A tool to generate a suite testing multiple workingtree formats at once.
1834
This is done by copying the test once for each transport and injecting
1835
the transport_server, transport_readonly_server, and workingtree_format
1836
classes into each copy. Each copy is also given a new id() to make it
1840
def __init__(self, transport_server, transport_readonly_server, formats):
1841
self._transport_server = transport_server
1842
self._transport_readonly_server = transport_readonly_server
1843
self._formats = formats
1845
def adapt(self, test):
1846
from bzrlib.tests import TestSuite
1847
result = TestSuite()
1848
for workingtree_format, bzrdir_format in self._formats:
1849
new_test = deepcopy(test)
1850
new_test.transport_server = self._transport_server
1851
new_test.transport_readonly_server = self._transport_readonly_server
1852
new_test.bzrdir_format = bzrdir_format
1853
new_test.workingtree_format = workingtree_format
1854
def make_new_test_id():
1855
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1856
return lambda: new_id
1857
new_test.id = make_new_test_id()
1858
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
