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
57
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
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,
99
from bzrlib.trace import mutter, note
100
from bzrlib.transform import build_tree
101
from bzrlib.transport import get_transport
102
from bzrlib.transport.local import LocalTransport
103
from bzrlib.textui import show_status
25
104
import bzrlib.tree
26
from errors import BzrCheckError
27
from trace import mutter
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')
153
class TreeEntry(object):
154
"""An entry that implements the minimum interface used by commands.
156
This needs further inspection, it may be better to have
157
InventoryEntries without ids - though that seems wrong. For now,
158
this is a parallel hierarchy to InventoryEntry, and needs to become
159
one of several things: decorates to that hierarchy, children of, or
161
Another note is that these objects are currently only used when there is
162
no InventoryEntry available - i.e. for unversioned objects.
163
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
166
def __eq__(self, other):
167
# yes, this us ugly, TODO: best practice __eq__ style.
168
return (isinstance(other, TreeEntry)
169
and other.__class__ == self.__class__)
171
def kind_character(self):
175
class TreeDirectory(TreeEntry):
176
"""See TreeEntry. This is a directory in a working tree."""
178
def __eq__(self, other):
179
return (isinstance(other, TreeDirectory)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class TreeFile(TreeEntry):
187
"""See TreeEntry. This is a regular file in a working tree."""
189
def __eq__(self, other):
190
return (isinstance(other, TreeFile)
191
and other.__class__ == self.__class__)
193
def kind_character(self):
197
class TreeLink(TreeEntry):
198
"""See TreeEntry. This is a symlink in a working tree."""
200
def __eq__(self, other):
201
return (isinstance(other, TreeLink)
202
and other.__class__ == self.__class__)
204
def kind_character(self):
29
208
class WorkingTree(bzrlib.tree.Tree):
30
209
"""Working copy tree.
35
214
It is possible for a `WorkingTree` to have a filename which is
36
215
not listed in the Inventory and vice versa.
38
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
39
248
from bzrlib.hashcache import HashCache
40
249
from bzrlib.trace import note, mutter
43
self.basedir = basedir
44
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
# assume all other formats have their own control files.
272
assert isinstance(_control_files, LockableFiles), \
273
"_control_files must be a LockableFiles, not %r" \
275
self._control_files = _control_files
46
276
# update the whole cache up front and write to disk if anything changed;
47
277
# in the future we might want to do this more selectively
48
hc = self._hashcache = HashCache(basedir)
278
# two possible ways offer themselves : in self._unlock, write the cache
279
# if needed, or, when the cache sees a change, append it to the hash
280
# cache file, and have the parser take the most recent entry for a
282
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
283
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
285
# is this scan needed ? it makes things kinda slow.
52
288
if hc.needs_write:
53
289
mutter("write hc")
58
if self._hashcache.needs_write:
59
self._hashcache.write()
292
if _inventory is None:
293
self._set_inventory(self.read_working_inventory())
295
self._set_inventory(_inventory)
298
fget=lambda self: self._branch,
299
doc="""The branch this WorkingTree is connected to.
301
This cannot be set - it is reflective of the actual disk structure
302
the working tree has been constructed from.
305
def break_lock(self):
306
"""Break a lock if one is present from another instance.
308
Uses the ui factory to ask for confirmation if the lock may be from
311
This will probe the repository for its lock as well.
313
self._control_files.break_lock()
314
self.branch.break_lock()
316
def _set_inventory(self, inv):
317
self._inventory = inv
318
self.path2id = self._inventory.path2id
320
def is_control_filename(self, filename):
321
"""True if filename is the name of a control file in this tree.
323
:param filename: A filename within the tree. This is a relative path
324
from the root of this tree.
326
This is true IF and ONLY IF the filename is part of the meta data
327
that bzr controls in this tree. I.E. a random .bzr directory placed
328
on disk will not be a control file for this tree.
330
return self.bzrdir.is_control_filename(filename)
333
def open(path=None, _unsupported=False):
334
"""Open an existing working tree at path.
338
path = os.path.getcwdu()
339
control = bzrdir.BzrDir.open(path, _unsupported)
340
return control.open_workingtree(_unsupported)
343
def open_containing(path=None):
344
"""Open an existing working tree which has its root about path.
346
This probes for a working tree at path and searches upwards from there.
348
Basically we keep looking up until we find the control directory or
349
run into /. If there isn't one, raises NotBranchError.
350
TODO: give this a new exception.
351
If there is one, it is returned, along with the unused portion of path.
353
:return: The WorkingTree that contains 'path', and the rest of path
356
path = osutils.getcwd()
357
control, relpath = bzrdir.BzrDir.open_containing(path)
359
return control.open_workingtree(), relpath
362
def open_downlevel(path=None):
363
"""Open an unsupported working tree.
365
Only intended for advanced situations like upgrading part of a bzrdir.
367
return WorkingTree.open(path, _unsupported=True)
62
369
def __iter__(self):
63
370
"""Iterate through file_ids for this tree.
89
454
def get_file_byname(self, filename):
90
455
return file(self.abspath(filename), 'rb')
457
def get_parent_ids(self):
458
"""See Tree.get_parent_ids.
460
This implementation reads the pending merges list and last_revision
461
value and uses that to decide what the parents list should be.
463
last_rev = self.last_revision()
468
other_parents = self.pending_merges()
469
return parents + other_parents
471
def get_root_id(self):
472
"""Return the id of this trees root"""
473
inv = self.read_working_inventory()
474
return inv.root.file_id
92
476
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))
477
## XXX: badly named; this is not in the store at all
478
return self.abspath(self.id2path(file_id))
481
def clone(self, to_bzrdir, revision_id=None, basis=None):
482
"""Duplicate this working tree into to_bzr, including all state.
484
Specifically modified files are kept as modified, but
485
ignored and unknown files are discarded.
487
If you want to make a new line of development, see bzrdir.sprout()
490
If not None, the cloned tree will have its last revision set to
491
revision, and and difference between the source trees last revision
492
and this one merged in.
495
If not None, a closer copy of a tree which may have some files in
496
common, and which file content should be preferentially copied from.
498
# assumes the target bzr dir format is compatible.
499
result = self._format.initialize(to_bzrdir)
500
self.copy_content_into(result, revision_id)
504
def copy_content_into(self, tree, revision_id=None):
505
"""Copy the current content and user files of this tree into tree."""
506
if revision_id is None:
507
transform_tree(tree, self)
509
# TODO now merge from tree.last_revision to revision
510
transform_tree(tree, self)
511
tree.set_last_revision(revision_id)
514
def commit(self, message=None, revprops=None, *args, **kwargs):
515
# avoid circular imports
516
from bzrlib.commit import Commit
519
if not 'branch-nick' in revprops:
520
revprops['branch-nick'] = self.branch.nick
521
# args for wt.commit start at message from the Commit.commit method,
522
# but with branch a kwarg now, passing in args as is results in the
523
#message being used for the branch
524
args = (DEPRECATED_PARAMETER, message, ) + args
525
committed_id = Commit().commit( working_tree=self, revprops=revprops,
527
self._set_inventory(self.read_working_inventory())
530
def id2abspath(self, file_id):
531
return self.abspath(self.id2path(file_id))
97
533
def has_id(self, file_id):
98
534
# files that have been deleted are excluded
99
535
inv = self._inventory
100
536
if not inv.has_id(file_id):
102
538
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
539
return bzrlib.osutils.lexists(self.abspath(path))
541
def has_or_had_id(self, file_id):
542
if file_id == self.inventory.root.file_id:
544
return self.inventory.has_id(file_id)
106
546
__contains__ = has_id
109
548
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)
549
return os.path.getsize(self.id2abspath(file_id))
552
def get_file_sha1(self, file_id, path=None):
554
path = self._inventory.id2path(file_id)
116
555
return self._hashcache.get_sha1(path)
557
def get_file_mtime(self, file_id, path=None):
559
path = self._inventory.id2path(file_id)
560
return os.lstat(self.abspath(path)).st_mtime
562
if not supports_executable():
563
def is_executable(self, file_id, path=None):
564
return self._inventory[file_id].executable
566
def is_executable(self, file_id, path=None):
568
path = self._inventory.id2path(file_id)
569
mode = os.lstat(self.abspath(path)).st_mode
570
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
573
def add(self, files, ids=None):
574
"""Make files versioned.
576
Note that the command line normally calls smart_add instead,
577
which can automatically recurse.
579
This adds the files to the inventory, so that they will be
580
recorded by the next commit.
583
List of paths to add, relative to the base of the tree.
586
If set, use these instead of automatically generated ids.
587
Must be the same length as the list of files, but may
588
contain None for ids that are to be autogenerated.
590
TODO: Perhaps have an option to add the ids even if the files do
593
TODO: Perhaps callback with the ids and paths as they're added.
595
# TODO: Re-adding a file that is removed in the working copy
596
# should probably put it back with the previous ID.
597
if isinstance(files, basestring):
598
assert(ids is None or isinstance(ids, basestring))
604
ids = [None] * len(files)
606
assert(len(ids) == len(files))
608
inv = self.read_working_inventory()
609
for f,file_id in zip(files, ids):
610
if self.is_control_filename(f):
611
raise errors.ForbiddenControlFileError(filename=f)
616
raise BzrError("cannot add top-level %r" % f)
618
fullpath = normpath(self.abspath(f))
620
kind = file_kind(fullpath)
622
if e.errno == errno.ENOENT:
623
raise NoSuchFile(fullpath)
624
if not InventoryEntry.versionable_kind(kind):
625
raise errors.BadFileKindError(filename=f, kind=kind)
627
inv.add_path(f, kind=kind)
629
inv.add_path(f, kind=kind, file_id=file_id)
631
self._write_inventory(inv)
634
def add_pending_merge(self, *revision_ids):
635
# TODO: Perhaps should check at this point that the
636
# history of the revision is actually present?
637
p = self.pending_merges()
639
for rev_id in revision_ids:
645
self.set_pending_merges(p)
648
def pending_merges(self):
649
"""Return a list of pending merges.
651
These are revisions that have been merged into the working
652
directory but not yet committed.
655
merges_file = self._control_files.get_utf8('pending-merges')
659
for l in merges_file.readlines():
660
p.append(l.rstrip('\n'))
664
def set_pending_merges(self, rev_list):
665
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
668
def set_merge_modified(self, modified_hashes):
670
for file_id, hash in modified_hashes.iteritems():
671
yield Stanza(file_id=file_id, hash=hash)
672
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
675
def _put_rio(self, filename, stanzas, header):
676
my_file = rio_file(stanzas, header)
677
self._control_files.put(filename, my_file)
680
def merge_modified(self):
682
hashfile = self._control_files.get('merge-hashes')
687
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
688
raise MergeModifiedFormatError()
689
except StopIteration:
690
raise MergeModifiedFormatError()
691
for s in RioReader(hashfile):
692
file_id = s.get("file_id")
693
if file_id not in self.inventory:
696
if hash == self.get_file_sha1(file_id):
697
merge_hashes[file_id] = hash
700
def get_symlink_target(self, file_id):
701
return os.readlink(self.id2abspath(file_id))
119
703
def file_class(self, filename):
120
704
if self.path2id(filename):
173
794
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
796
# make a last minute entry
798
yield fp[1:], c, fk, f_ie.file_id, f_ie
801
yield fp[1:], c, fk, None, fk_entries[fk]()
803
yield fp[1:], c, fk, None, TreeEntry()
177
806
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):
809
# But do this child first
810
new_children = os.listdir(fap)
812
new_children = collections.deque(new_children)
813
stack.append((f_ie.file_id, fp, fap, new_children))
814
# Break out of inner loop, so that we start outer loop with child
817
# if we finished all children, pop it off the stack
822
def move(self, from_paths, to_name):
825
to_name must exist in the inventory.
827
If to_name exists and is a directory, the files are moved into
828
it, keeping their old names.
830
Note that to_name is only the last component of the new name;
831
this doesn't change the directory.
833
This returns a list of (from_path, to_path) pairs for each
837
## TODO: Option to move IDs only
838
assert not isinstance(from_paths, basestring)
840
to_abs = self.abspath(to_name)
841
if not isdir(to_abs):
842
raise BzrError("destination %r is not a directory" % to_abs)
843
if not self.has_filename(to_name):
844
raise BzrError("destination %r not in working directory" % to_abs)
845
to_dir_id = inv.path2id(to_name)
846
if to_dir_id == None and to_name != '':
847
raise BzrError("destination %r is not a versioned directory" % to_name)
848
to_dir_ie = inv[to_dir_id]
849
if to_dir_ie.kind not in ('directory', 'root_directory'):
850
raise BzrError("destination %r is not a directory" % to_abs)
852
to_idpath = inv.get_idpath(to_dir_id)
855
if not self.has_filename(f):
856
raise BzrError("%r does not exist in working tree" % f)
857
f_id = inv.path2id(f)
859
raise BzrError("%r is not versioned" % f)
860
name_tail = splitpath(f)[-1]
861
dest_path = pathjoin(to_name, name_tail)
862
if self.has_filename(dest_path):
863
raise BzrError("destination %r already exists" % dest_path)
864
if f_id in to_idpath:
865
raise BzrError("can't move %r to a subdirectory of itself" % f)
867
# OK, so there's a race here, it's possible that someone will
868
# create a file in this interval and then the rename might be
869
# left half-done. But we should have caught most problems.
870
orig_inv = deepcopy(self.inventory)
873
name_tail = splitpath(f)[-1]
874
dest_path = pathjoin(to_name, name_tail)
875
result.append((f, dest_path))
876
inv.rename(inv.path2id(f), to_dir_id, name_tail)
878
rename(self.abspath(f), self.abspath(dest_path))
880
raise BzrError("failed to rename %r to %r: %s" %
881
(f, dest_path, e[1]),
882
["rename rolled back"])
884
# restore the inventory on error
885
self._set_inventory(orig_inv)
887
self._write_inventory(inv)
891
def rename_one(self, from_rel, to_rel):
894
This can change the directory or the filename or both.
897
if not self.has_filename(from_rel):
898
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
899
if self.has_filename(to_rel):
900
raise BzrError("can't rename: new working file %r already exists" % to_rel)
902
file_id = inv.path2id(from_rel)
904
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
907
from_parent = entry.parent_id
908
from_name = entry.name
910
if inv.path2id(to_rel):
911
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
913
to_dir, to_tail = os.path.split(to_rel)
914
to_dir_id = inv.path2id(to_dir)
915
if to_dir_id == None and to_dir != '':
916
raise BzrError("can't determine destination directory id for %r" % to_dir)
918
mutter("rename_one:")
919
mutter(" file_id {%s}" % file_id)
920
mutter(" from_rel %r" % from_rel)
921
mutter(" to_rel %r" % to_rel)
922
mutter(" to_dir %r" % to_dir)
923
mutter(" to_dir_id {%s}" % to_dir_id)
925
inv.rename(file_id, to_dir_id, to_tail)
927
from_abs = self.abspath(from_rel)
928
to_abs = self.abspath(to_rel)
930
rename(from_abs, to_abs)
932
inv.rename(file_id, from_parent, from_name)
933
raise BzrError("failed to rename %r to %r: %s"
934
% (from_abs, to_abs, e[1]),
935
["rename rolled back"])
936
self._write_inventory(inv)
192
939
def unknowns(self):
940
"""Return all unknown files.
942
These are files in the working directory that are not versioned or
943
control files or ignored.
193
945
for subp in self.extras():
194
946
if not self.is_ignored(subp):
949
@deprecated_method(zero_eight)
950
def iter_conflicts(self):
951
"""List all files in the tree that have text or content conflicts.
952
DEPRECATED. Use conflicts instead."""
953
return self._iter_conflicts()
955
def _iter_conflicts(self):
957
for info in self.list_files():
959
stem = get_conflicted_stem(path)
962
if stem not in conflicted:
967
def pull(self, source, overwrite=False, stop_revision=None):
968
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
971
pp = ProgressPhase("Pull phase", 2, top_pb)
973
old_revision_history = self.branch.revision_history()
974
basis_tree = self.basis_tree()
975
count = self.branch.pull(source, overwrite, stop_revision)
976
new_revision_history = self.branch.revision_history()
977
if new_revision_history != old_revision_history:
979
if len(old_revision_history):
980
other_revision = old_revision_history[-1]
982
other_revision = None
983
repository = self.branch.repository
984
pb = bzrlib.ui.ui_factory.nested_progress_bar()
986
merge_inner(self.branch,
987
self.branch.basis_tree(),
993
self.set_last_revision(self.branch.last_revision())
198
999
def extras(self):
199
1000
"""Yield all unknown files in this WorkingTree.
268
1137
# treat dotfiles correctly and allows * to match /.
269
1138
# 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] == '.\\'):
1141
rules = self._get_ignore_rules_as_regex()
1142
for regex, mapping in rules:
1143
match = regex.match(filename)
1144
if match is not None:
1145
# one or more of the groups in mapping will have a non-None group
1147
groups = match.groups()
1148
rules = [mapping[group] for group in
1149
mapping if groups[group] is not None]
1153
def kind(self, file_id):
1154
return file_kind(self.id2abspath(file_id))
1157
def last_revision(self):
1158
"""Return the last revision id of this working tree.
1160
In early branch formats this was == the branch last_revision,
1161
but that cannot be relied upon - for working tree operations,
1162
always use tree.last_revision().
1164
return self.branch.last_revision()
1166
def is_locked(self):
1167
return self._control_files.is_locked()
1169
def lock_read(self):
1170
"""See Branch.lock_read, and WorkingTree.unlock."""
1171
self.branch.lock_read()
1173
return self._control_files.lock_read()
1175
self.branch.unlock()
1178
def lock_write(self):
1179
"""See Branch.lock_write, and WorkingTree.unlock."""
1180
self.branch.lock_write()
1182
return self._control_files.lock_write()
1184
self.branch.unlock()
1187
def get_physical_lock_status(self):
1188
return self._control_files.get_physical_lock_status()
1190
def _basis_inventory_name(self):
1191
return 'basis-inventory'
1194
def set_last_revision(self, new_revision):
1195
"""Change the last revision in the working tree."""
1196
if self._change_last_revision(new_revision):
1197
self._cache_basis_inventory(new_revision)
1199
def _change_last_revision(self, new_revision):
1200
"""Template method part of set_last_revision to perform the change.
1202
This is used to allow WorkingTree3 instances to not affect branch
1203
when their last revision is set.
1205
if new_revision is None:
1206
self.branch.set_revision_history([])
1208
# current format is locked in with the branch
1209
revision_history = self.branch.revision_history()
1211
position = revision_history.index(new_revision)
1213
raise errors.NoSuchRevision(self.branch, new_revision)
1214
self.branch.set_revision_history(revision_history[:position + 1])
1217
def _cache_basis_inventory(self, new_revision):
1218
"""Cache new_revision as the basis inventory."""
1219
# TODO: this should allow the ready-to-use inventory to be passed in,
1220
# as commit already has that ready-to-use [while the format is the
1223
# this double handles the inventory - unpack and repack -
1224
# but is easier to understand. We can/should put a conditional
1225
# in here based on whether the inventory is in the latest format
1226
# - perhaps we should repack all inventories on a repository
1228
# the fast path is to copy the raw xml from the repository. If the
1229
# xml contains 'revision_id="', then we assume the right
1230
# revision_id is set. We must check for this full string, because a
1231
# root node id can legitimately look like 'revision_id' but cannot
1233
xml = self.branch.repository.get_inventory_xml(new_revision)
1234
if not 'revision_id="' in xml.split('\n', 1)[0]:
1235
inv = self.branch.repository.deserialise_inventory(
1237
inv.revision_id = new_revision
1238
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1239
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1240
path = self._basis_inventory_name()
1242
self._control_files.put(path, sio)
1243
except WeaveRevisionNotPresent:
1246
def read_basis_inventory(self):
1247
"""Read the cached basis inventory."""
1248
path = self._basis_inventory_name()
1249
return self._control_files.get(path).read()
1252
def read_working_inventory(self):
1253
"""Read the working inventory."""
1254
# ElementTree does its own conversion from UTF-8, so open in
1256
result = bzrlib.xml5.serializer_v5.read_inventory(
1257
self._control_files.get('inventory'))
1258
self._set_inventory(result)
1262
def remove(self, files, verbose=False, to_file=None):
1263
"""Remove nominated files from the working inventory..
1265
This does not remove their text. This does not run on XXX on what? RBC
1267
TODO: Refuse to remove modified files unless --force is given?
1269
TODO: Do something useful with directories.
1271
TODO: Should this remove the text or not? Tough call; not
1272
removing may be useful and the user can just use use rm, and
1273
is the opposite of add. Removing it is consistent with most
1274
other tools. Maybe an option.
1276
## TODO: Normalize names
1277
## TODO: Remove nested loops; better scalability
1278
if isinstance(files, basestring):
1281
inv = self.inventory
1283
# do this before any modifications
1285
fid = inv.path2id(f)
1287
# TODO: Perhaps make this just a warning, and continue?
1288
# This tends to happen when
1289
raise NotVersionedError(path=f)
1291
# having remove it, it must be either ignored or unknown
1292
if self.is_ignored(f):
286
if fnmatch.fnmatchcase(filename, newpat):
1296
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1299
self._write_inventory(inv)
1302
def revert(self, filenames, old_tree=None, backups=True,
1303
pb=DummyProgress()):
1304
from transform import revert
1305
from conflicts import resolve
1306
if old_tree is None:
1307
old_tree = self.basis_tree()
1308
conflicts = revert(self, old_tree, filenames, backups, pb)
1309
if not len(filenames):
1310
self.set_pending_merges([])
1313
resolve(self, filenames, ignore_misses=True)
1316
# XXX: This method should be deprecated in favour of taking in a proper
1317
# new Inventory object.
1319
def set_inventory(self, new_inventory_list):
1320
from bzrlib.inventory import (Inventory,
1325
inv = Inventory(self.get_root_id())
1326
for path, file_id, parent, kind in new_inventory_list:
1327
name = os.path.basename(path)
1330
# fixme, there should be a factory function inv,add_??
1331
if kind == 'directory':
1332
inv.add(InventoryDirectory(file_id, name, parent))
1333
elif kind == 'file':
1334
inv.add(InventoryFile(file_id, name, parent))
1335
elif kind == 'symlink':
1336
inv.add(InventoryLink(file_id, name, parent))
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1338
raise BzrError("unknown kind %r" % kind)
1339
self._write_inventory(inv)
1342
def set_root_id(self, file_id):
1343
"""Set the root id for this tree."""
1344
inv = self.read_working_inventory()
1345
orig_root_id = inv.root.file_id
1346
del inv._byid[inv.root.file_id]
1347
inv.root.file_id = file_id
1348
inv._byid[inv.root.file_id] = inv.root
1351
if entry.parent_id == orig_root_id:
1352
entry.parent_id = inv.root.file_id
1353
self._write_inventory(inv)
1356
"""See Branch.unlock.
1358
WorkingTree locking just uses the Branch locking facilities.
1359
This is current because all working trees have an embedded branch
1360
within them. IF in the future, we were to make branch data shareable
1361
between multiple working trees, i.e. via shared storage, then we
1362
would probably want to lock both the local tree, and the branch.
1364
raise NotImplementedError(self.unlock)
1368
"""Update a working tree along its branch.
1370
This will update the branch if its bound too, which means we have multiple trees involved:
1371
The new basis tree of the master.
1372
The old basis tree of the branch.
1373
The old basis tree of the working tree.
1374
The current working tree state.
1375
pathologically all three may be different, and non ancestors of each other.
1376
Conceptually we want to:
1377
Preserve the wt.basis->wt.state changes
1378
Transform the wt.basis to the new master basis.
1379
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1380
Restore the wt.basis->wt.state changes.
1382
There isn't a single operation at the moment to do that, so we:
1383
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1384
Do a 'normal' merge of the old branch basis if it is relevant.
1386
old_tip = self.branch.update()
1387
if old_tip is not None:
1388
self.add_pending_merge(old_tip)
1389
self.branch.lock_read()
1392
if self.last_revision() != self.branch.last_revision():
1393
# merge tree state up to new branch tip.
1394
basis = self.basis_tree()
1395
to_tree = self.branch.basis_tree()
1396
result += merge_inner(self.branch,
1400
self.set_last_revision(self.branch.last_revision())
1401
if old_tip and old_tip != self.last_revision():
1402
# our last revision was not the prior branch last revision
1403
# and we have converted that last revision to a pending merge.
1404
# base is somewhere between the branch tip now
1405
# and the now pending merge
1406
from bzrlib.revision import common_ancestor
1408
base_rev_id = common_ancestor(self.branch.last_revision(),
1410
self.branch.repository)
1411
except errors.NoCommonAncestor:
1413
base_tree = self.branch.repository.revision_tree(base_rev_id)
1414
other_tree = self.branch.repository.revision_tree(old_tip)
1415
result += merge_inner(self.branch,
1421
self.branch.unlock()
1424
def _write_inventory(self, inv):
1425
"""Write inventory as the current inventory."""
1427
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1429
self._control_files.put('inventory', sio)
1430
self._set_inventory(inv)
1431
mutter('wrote working inventory')
1433
def set_conflicts(self, arg):
1434
raise UnsupportedOperation(self.set_conflicts, self)
1436
def add_conflicts(self, arg):
1437
raise UnsupportedOperation(self.add_conflicts, self)
1440
def conflicts(self):
1441
conflicts = ConflictList()
1442
for conflicted in self._iter_conflicts():
1445
if file_kind(self.abspath(conflicted)) != "file":
1447
except errors.NoSuchFile:
1450
for suffix in ('.THIS', '.OTHER'):
1452
kind = file_kind(self.abspath(conflicted+suffix))
1455
except errors.NoSuchFile:
1459
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1460
conflicts.append(Conflict.factory(ctype, path=conflicted,
1461
file_id=self.path2id(conflicted)))
1465
class WorkingTree2(WorkingTree):
1466
"""This is the Format 2 working tree.
1468
This was the first weave based working tree.
1469
- uses os locks for locking.
1470
- uses the branch last-revision.
1474
# we share control files:
1475
if self._hashcache.needs_write and self._control_files._lock_count==3:
1476
self._hashcache.write()
1477
# reverse order of locking.
1479
return self._control_files.unlock()
1481
self.branch.unlock()
1484
class WorkingTree3(WorkingTree):
1485
"""This is the Format 3 working tree.
1487
This differs from the base WorkingTree by:
1488
- having its own file lock
1489
- having its own last-revision property.
1491
This is new in bzr 0.8
1495
def last_revision(self):
1496
"""See WorkingTree.last_revision."""
1498
return self._control_files.get_utf8('last-revision').read()
b'\\ No newline at end of file'
1502
def _change_last_revision(self, revision_id):
1503
"""See WorkingTree._change_last_revision."""
1504
if revision_id is None or revision_id == NULL_REVISION:
1506
self._control_files._transport.delete('last-revision')
1507
except errors.NoSuchFile:
1512
self.branch.revision_history().index(revision_id)
1514
raise errors.NoSuchRevision(self.branch, revision_id)
1515
self._control_files.put_utf8('last-revision', revision_id)
1519
def set_conflicts(self, conflicts):
1520
self._put_rio('conflicts', conflicts.to_stanzas(),
1524
def add_conflicts(self, new_conflicts):
1525
conflict_set = set(self.conflicts())
1526
conflict_set.update(set(list(new_conflicts)))
1527
self.set_conflicts(ConflictList(sorted(conflict_set,
1528
key=Conflict.sort_key)))
1531
def conflicts(self):
1533
confile = self._control_files.get('conflicts')
1535
return ConflictList()
1537
if confile.next() != CONFLICT_HEADER_1 + '\n':
1538
raise ConflictFormatError()
1539
except StopIteration:
1540
raise ConflictFormatError()
1541
return ConflictList.from_stanzas(RioReader(confile))
1544
if self._hashcache.needs_write and self._control_files._lock_count==1:
1545
self._hashcache.write()
1546
# reverse order of locking.
1548
return self._control_files.unlock()
1550
self.branch.unlock()
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 = WorkingTree2(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 WorkingTree2(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 _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1846
"""Clone test for adaption."""
1847
new_test = deepcopy(test)
1848
new_test.transport_server = self._transport_server
1849
new_test.transport_readonly_server = self._transport_readonly_server
1850
new_test.bzrdir_format = bzrdir_format
1851
new_test.workingtree_format = workingtree_format
1852
def make_new_test_id():
1853
new_id = "%s(%s)" % (test.id(), variation)
1854
return lambda: new_id
1855
new_test.id = make_new_test_id()
1858
def adapt(self, test):
1859
from bzrlib.tests import TestSuite
1860
result = TestSuite()
1861
for workingtree_format, bzrdir_format in self._formats:
1862
new_test = self._clone_test(
1865
workingtree_format, workingtree_format.__class__.__name__)
1866
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
