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
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
64
WeaveRevisionNotPresent,
68
MergeModifiedFormatError,
71
from bzrlib.inventory import InventoryEntry, Inventory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
from bzrlib.merge import merge_inner, transform_tree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
26
from errors import BzrCheckError
27
from trace import mutter
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
106
# the regex here does the following:
107
# 1) remove any weird characters; we don't escape them but rather
109
# 2) match leading '.'s to make it not hidden
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
111
_gen_id_suffix = None
115
def _next_id_suffix():
116
"""Create a new file id suffix that is reasonably unique.
118
On the first call we combine the current time with 64 bits of randomness
119
to give a highly probably globally unique number. Then each call in the same
120
process adds 1 to a serial number we append to that unique value.
122
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
123
# than having to move the id randomness out of the inner loop like this.
124
# XXX TODO: for the global randomness this uses we should add the thread-id
125
# before the serial #.
126
global _gen_id_suffix, _gen_id_serial
127
if _gen_id_suffix is None:
128
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
130
return _gen_id_suffix + str(_gen_id_serial)
133
def gen_file_id(name):
134
"""Return new file id for the basename 'name'.
136
The uniqueness is supplied from _next_id_suffix.
138
# XXX TODO: squash the filename to lowercase.
139
# XXX TODO: truncate the filename to something like 20 or 30 chars.
140
# XXX TODO: consider what to do with ids that look like illegal filepaths
141
# on platforms we support.
142
return _gen_file_id_re.sub('', name) + _next_id_suffix()
146
"""Return a new tree-root file id."""
147
return gen_file_id('TREE_ROOT')
150
class TreeEntry(object):
151
"""An entry that implements the minium interface used by commands.
153
This needs further inspection, it may be better to have
154
InventoryEntries without ids - though that seems wrong. For now,
155
this is a parallel hierarchy to InventoryEntry, and needs to become
156
one of several things: decorates to that hierarchy, children of, or
158
Another note is that these objects are currently only used when there is
159
no InventoryEntry available - i.e. for unversioned objects.
160
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
163
def __eq__(self, other):
164
# yes, this us ugly, TODO: best practice __eq__ style.
165
return (isinstance(other, TreeEntry)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeDirectory(TreeEntry):
173
"""See TreeEntry. This is a directory in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeDirectory)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeFile(TreeEntry):
184
"""See TreeEntry. This is a regular file in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeFile)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeLink(TreeEntry):
195
"""See TreeEntry. This is a symlink in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeLink)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
29
205
class WorkingTree(bzrlib.tree.Tree):
30
206
"""Working copy tree.
35
211
It is possible for a `WorkingTree` to have a filename which is
36
212
not listed in the Inventory and vice versa.
38
def __init__(self, basedir, inv):
215
def __init__(self, basedir='.',
216
branch=DEPRECATED_PARAMETER,
222
"""Construct a WorkingTree for basedir.
224
If the branch is not supplied, it is opened automatically.
225
If the branch is supplied, it must be the branch for this basedir.
226
(branch.base is not cross checked, because for remote branches that
227
would be meaningless).
229
self._format = _format
230
self.bzrdir = _bzrdir
232
# not created via open etc.
233
warn("WorkingTree() is deprecated as of bzr version 0.8. "
234
"Please use bzrdir.open_workingtree or WorkingTree.open().",
237
wt = WorkingTree.open(basedir)
238
self._branch = wt.branch
239
self.basedir = wt.basedir
240
self._control_files = wt._control_files
241
self._hashcache = wt._hashcache
242
self._set_inventory(wt._inventory)
243
self._format = wt._format
244
self.bzrdir = wt.bzrdir
39
245
from bzrlib.hashcache import HashCache
40
246
from bzrlib.trace import note, mutter
43
self.basedir = basedir
44
self.path2id = inv.path2id
247
assert isinstance(basedir, basestring), \
248
"base directory %r is not a string" % basedir
249
basedir = safe_unicode(basedir)
250
mutter("opening working tree %r", basedir)
251
if deprecated_passed(branch):
253
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
254
" Please use bzrdir.open_workingtree() or"
255
" WorkingTree.open().",
259
self._branch = branch
261
self._branch = self.bzrdir.open_branch()
262
assert isinstance(self.branch, Branch), \
263
"branch %r is not a Branch" % self.branch
264
self.basedir = realpath(basedir)
265
# if branch is at our basedir and is a format 6 or less
266
if isinstance(self._format, WorkingTreeFormat2):
267
# share control object
268
self._control_files = self.branch.control_files
270
# only ready for format 3
271
assert isinstance(self._format, WorkingTreeFormat3)
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).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.
355
control, relpath = bzrdir.BzrDir.open_containing(path)
356
return control.open_workingtree(), relpath
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
62
366
def __iter__(self):
63
367
"""Iterate through file_ids for this tree.
89
451
def get_file_byname(self, filename):
90
452
return file(self.abspath(filename), 'rb')
454
def get_root_id(self):
455
"""Return the id of this trees root"""
456
inv = self.read_working_inventory()
457
return inv.root.file_id
92
459
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))
460
## XXX: badly named; this is not in the store at all
461
return self.abspath(self.id2path(file_id))
464
def clone(self, to_bzrdir, revision_id=None, basis=None):
465
"""Duplicate this working tree into to_bzr, including all state.
467
Specifically modified files are kept as modified, but
468
ignored and unknown files are discarded.
470
If you want to make a new line of development, see bzrdir.sprout()
473
If not None, the cloned tree will have its last revision set to
474
revision, and and difference between the source trees last revision
475
and this one merged in.
478
If not None, a closer copy of a tree which may have some files in
479
common, and which file content should be preferentially copied from.
481
# assumes the target bzr dir format is compatible.
482
result = self._format.initialize(to_bzrdir)
483
self.copy_content_into(result, revision_id)
487
def copy_content_into(self, tree, revision_id=None):
488
"""Copy the current content and user files of this tree into tree."""
489
if revision_id is None:
490
transform_tree(tree, self)
492
# TODO now merge from tree.last_revision to revision
493
transform_tree(tree, self)
494
tree.set_last_revision(revision_id)
497
def commit(self, message=None, revprops=None, *args, **kwargs):
498
# avoid circular imports
499
from bzrlib.commit import Commit
502
if not 'branch-nick' in revprops:
503
revprops['branch-nick'] = self.branch.nick
504
# args for wt.commit start at message from the Commit.commit method,
505
# but with branch a kwarg now, passing in args as is results in the
506
#message being used for the branch
507
args = (DEPRECATED_PARAMETER, message, ) + args
508
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
509
self._set_inventory(self.read_working_inventory())
511
def id2abspath(self, file_id):
512
return self.abspath(self.id2path(file_id))
97
514
def has_id(self, file_id):
98
515
# files that have been deleted are excluded
99
516
inv = self._inventory
100
517
if not inv.has_id(file_id):
102
519
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
520
return bzrlib.osutils.lexists(self.abspath(path))
522
def has_or_had_id(self, file_id):
523
if file_id == self.inventory.root.file_id:
525
return self.inventory.has_id(file_id)
106
527
__contains__ = has_id
109
529
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)
530
return os.path.getsize(self.id2abspath(file_id))
533
def get_file_sha1(self, file_id, path=None):
535
path = self._inventory.id2path(file_id)
116
536
return self._hashcache.get_sha1(path)
538
if not supports_executable():
539
def is_executable(self, file_id, path=None):
540
return self._inventory[file_id].executable
542
def is_executable(self, file_id, path=None):
544
path = self._inventory.id2path(file_id)
545
mode = os.lstat(self.abspath(path)).st_mode
546
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
549
def add(self, files, ids=None):
550
"""Make files versioned.
552
Note that the command line normally calls smart_add instead,
553
which can automatically recurse.
555
This adds the files to the inventory, so that they will be
556
recorded by the next commit.
559
List of paths to add, relative to the base of the tree.
562
If set, use these instead of automatically generated ids.
563
Must be the same length as the list of files, but may
564
contain None for ids that are to be autogenerated.
566
TODO: Perhaps have an option to add the ids even if the files do
569
TODO: Perhaps callback with the ids and paths as they're added.
571
# TODO: Re-adding a file that is removed in the working copy
572
# should probably put it back with the previous ID.
573
if isinstance(files, basestring):
574
assert(ids is None or isinstance(ids, basestring))
580
ids = [None] * len(files)
582
assert(len(ids) == len(files))
584
inv = self.read_working_inventory()
585
for f,file_id in zip(files, ids):
586
if self.is_control_filename(f):
587
raise BzrError("cannot add control file %s" % quotefn(f))
592
raise BzrError("cannot add top-level %r" % f)
594
fullpath = normpath(self.abspath(f))
597
kind = file_kind(fullpath)
599
if e.errno == errno.ENOENT:
600
raise NoSuchFile(fullpath)
601
# maybe something better?
602
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
604
if not InventoryEntry.versionable_kind(kind):
605
raise BzrError('cannot add: not a versionable file ('
606
'i.e. regular file, symlink or directory): %s' % quotefn(f))
609
inv.add_path(f, kind=kind)
611
inv.add_path(f, kind=kind, file_id=file_id)
613
self._write_inventory(inv)
616
def add_pending_merge(self, *revision_ids):
617
# TODO: Perhaps should check at this point that the
618
# history of the revision is actually present?
619
p = self.pending_merges()
621
for rev_id in revision_ids:
627
self.set_pending_merges(p)
630
def pending_merges(self):
631
"""Return a list of pending merges.
633
These are revisions that have been merged into the working
634
directory but not yet committed.
637
merges_file = self._control_files.get_utf8('pending-merges')
639
if e.errno != errno.ENOENT:
643
for l in merges_file.readlines():
644
p.append(l.rstrip('\n'))
648
def set_pending_merges(self, rev_list):
649
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
652
def set_merge_modified(self, modified_hashes):
654
for file_id, hash in modified_hashes.iteritems():
655
yield Stanza(file_id=file_id, hash=hash)
656
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
659
def _put_rio(self, filename, stanzas, header):
660
my_file = rio_file(stanzas, header)
661
self._control_files.put(filename, my_file)
664
def merge_modified(self):
666
hashfile = self._control_files.get('merge-hashes')
671
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
672
raise MergeModifiedFormatError()
673
except StopIteration:
674
raise MergeModifiedFormatError()
675
for s in RioReader(hashfile):
676
file_id = s.get("file_id")
677
if file_id not in self.inventory:
680
if hash == self.get_file_sha1(file_id):
681
merge_hashes[file_id] = hash
684
def get_symlink_target(self, file_id):
685
return os.readlink(self.id2abspath(file_id))
119
687
def file_class(self, filename):
120
688
if self.path2id(filename):
173
760
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
762
# make a last minute entry
764
yield fp[1:], c, fk, f_ie.file_id, f_ie
767
yield fp[1:], c, fk, None, fk_entries[fk]()
769
yield fp[1:], c, fk, None, TreeEntry()
177
772
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):
775
# But do this child first
776
new_children = os.listdir(fap)
778
new_children = collections.deque(new_children)
779
stack.append((f_ie.file_id, fp, fap, new_children))
780
# Break out of inner loop, so that we start outer loop with child
783
# if we finished all children, pop it off the stack
788
def move(self, from_paths, to_name):
791
to_name must exist in the inventory.
793
If to_name exists and is a directory, the files are moved into
794
it, keeping their old names.
796
Note that to_name is only the last component of the new name;
797
this doesn't change the directory.
799
This returns a list of (from_path, to_path) pairs for each
803
## TODO: Option to move IDs only
804
assert not isinstance(from_paths, basestring)
806
to_abs = self.abspath(to_name)
807
if not isdir(to_abs):
808
raise BzrError("destination %r is not a directory" % to_abs)
809
if not self.has_filename(to_name):
810
raise BzrError("destination %r not in working directory" % to_abs)
811
to_dir_id = inv.path2id(to_name)
812
if to_dir_id == None and to_name != '':
813
raise BzrError("destination %r is not a versioned directory" % to_name)
814
to_dir_ie = inv[to_dir_id]
815
if to_dir_ie.kind not in ('directory', 'root_directory'):
816
raise BzrError("destination %r is not a directory" % to_abs)
818
to_idpath = inv.get_idpath(to_dir_id)
821
if not self.has_filename(f):
822
raise BzrError("%r does not exist in working tree" % f)
823
f_id = inv.path2id(f)
825
raise BzrError("%r is not versioned" % f)
826
name_tail = splitpath(f)[-1]
827
dest_path = pathjoin(to_name, name_tail)
828
if self.has_filename(dest_path):
829
raise BzrError("destination %r already exists" % dest_path)
830
if f_id in to_idpath:
831
raise BzrError("can't move %r to a subdirectory of itself" % f)
833
# OK, so there's a race here, it's possible that someone will
834
# create a file in this interval and then the rename might be
835
# left half-done. But we should have caught most problems.
836
orig_inv = deepcopy(self.inventory)
839
name_tail = splitpath(f)[-1]
840
dest_path = pathjoin(to_name, name_tail)
841
result.append((f, dest_path))
842
inv.rename(inv.path2id(f), to_dir_id, name_tail)
844
rename(self.abspath(f), self.abspath(dest_path))
846
raise BzrError("failed to rename %r to %r: %s" %
847
(f, dest_path, e[1]),
848
["rename rolled back"])
850
# restore the inventory on error
851
self._set_inventory(orig_inv)
853
self._write_inventory(inv)
857
def rename_one(self, from_rel, to_rel):
860
This can change the directory or the filename or both.
863
if not self.has_filename(from_rel):
864
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
865
if self.has_filename(to_rel):
866
raise BzrError("can't rename: new working file %r already exists" % to_rel)
868
file_id = inv.path2id(from_rel)
870
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
873
from_parent = entry.parent_id
874
from_name = entry.name
876
if inv.path2id(to_rel):
877
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
879
to_dir, to_tail = os.path.split(to_rel)
880
to_dir_id = inv.path2id(to_dir)
881
if to_dir_id == None and to_dir != '':
882
raise BzrError("can't determine destination directory id for %r" % to_dir)
884
mutter("rename_one:")
885
mutter(" file_id {%s}" % file_id)
886
mutter(" from_rel %r" % from_rel)
887
mutter(" to_rel %r" % to_rel)
888
mutter(" to_dir %r" % to_dir)
889
mutter(" to_dir_id {%s}" % to_dir_id)
891
inv.rename(file_id, to_dir_id, to_tail)
893
from_abs = self.abspath(from_rel)
894
to_abs = self.abspath(to_rel)
896
rename(from_abs, to_abs)
898
inv.rename(file_id, from_parent, from_name)
899
raise BzrError("failed to rename %r to %r: %s"
900
% (from_abs, to_abs, e[1]),
901
["rename rolled back"])
902
self._write_inventory(inv)
192
905
def unknowns(self):
906
"""Return all unknown files.
908
These are files in the working directory that are not versioned or
909
control files or ignored.
911
>>> from bzrlib.bzrdir import ScratchDir
912
>>> d = ScratchDir(files=['foo', 'foo~'])
913
>>> b = d.open_branch()
914
>>> tree = d.open_workingtree()
915
>>> map(str, tree.unknowns())
918
>>> list(b.unknowns())
920
>>> tree.remove('foo')
921
>>> list(b.unknowns())
193
924
for subp in self.extras():
194
925
if not self.is_ignored(subp):
928
@deprecated_method(zero_eight)
929
def iter_conflicts(self):
930
"""List all files in the tree that have text or content conflicts.
931
DEPRECATED. Use conflicts instead."""
932
return self._iter_conflicts()
934
def _iter_conflicts(self):
936
for info in self.list_files():
938
stem = get_conflicted_stem(path)
941
if stem not in conflicted:
946
def pull(self, source, overwrite=False, stop_revision=None):
947
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
950
pp = ProgressPhase("Pull phase", 2, top_pb)
952
old_revision_history = self.branch.revision_history()
953
basis_tree = self.basis_tree()
954
count = self.branch.pull(source, overwrite, stop_revision)
955
new_revision_history = self.branch.revision_history()
956
if new_revision_history != old_revision_history:
958
if len(old_revision_history):
959
other_revision = old_revision_history[-1]
961
other_revision = None
962
repository = self.branch.repository
963
pb = bzrlib.ui.ui_factory.nested_progress_bar()
965
merge_inner(self.branch,
966
self.branch.basis_tree(),
972
self.set_last_revision(self.branch.last_revision())
198
978
def extras(self):
199
979
"""Yield all unknown files in this WorkingTree.
268
1109
# treat dotfiles correctly and allows * to match /.
269
1110
# 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] == '.\\'):
1113
rules = self._get_ignore_rules_as_regex()
1114
for regex, mapping in rules:
1115
match = regex.match(filename)
1116
if match is not None:
1117
# one or more of the groups in mapping will have a non-None group
1119
groups = match.groups()
1120
rules = [mapping[group] for group in
1121
mapping if groups[group] is not None]
1125
def kind(self, file_id):
1126
return file_kind(self.id2abspath(file_id))
1129
def last_revision(self):
1130
"""Return the last revision id of this working tree.
1132
In early branch formats this was == the branch last_revision,
1133
but that cannot be relied upon - for working tree operations,
1134
always use tree.last_revision().
1136
return self.branch.last_revision()
1138
def is_locked(self):
1139
return self._control_files.is_locked()
1141
def lock_read(self):
1142
"""See Branch.lock_read, and WorkingTree.unlock."""
1143
self.branch.lock_read()
1145
return self._control_files.lock_read()
1147
self.branch.unlock()
1150
def lock_write(self):
1151
"""See Branch.lock_write, and WorkingTree.unlock."""
1152
self.branch.lock_write()
1154
return self._control_files.lock_write()
1156
self.branch.unlock()
1159
def get_physical_lock_status(self):
1160
return self._control_files.get_physical_lock_status()
1162
def _basis_inventory_name(self):
1163
return 'basis-inventory'
1166
def set_last_revision(self, new_revision):
1167
"""Change the last revision in the working tree."""
1168
if self._change_last_revision(new_revision):
1169
self._cache_basis_inventory(new_revision)
1171
def _change_last_revision(self, new_revision):
1172
"""Template method part of set_last_revision to perform the change.
1174
This is used to allow WorkingTree3 instances to not affect branch
1175
when their last revision is set.
1177
if new_revision is None:
1178
self.branch.set_revision_history([])
1180
# current format is locked in with the branch
1181
revision_history = self.branch.revision_history()
1183
position = revision_history.index(new_revision)
1185
raise errors.NoSuchRevision(self.branch, new_revision)
1186
self.branch.set_revision_history(revision_history[:position + 1])
1189
def _cache_basis_inventory(self, new_revision):
1190
"""Cache new_revision as the basis inventory."""
1192
# this double handles the inventory - unpack and repack -
1193
# but is easier to understand. We can/should put a conditional
1194
# in here based on whether the inventory is in the latest format
1195
# - perhaps we should repack all inventories on a repository
1197
inv = self.branch.repository.get_inventory(new_revision)
1198
inv.revision_id = new_revision
1199
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1201
path = self._basis_inventory_name()
1202
self._control_files.put_utf8(path, xml)
1203
except WeaveRevisionNotPresent:
1206
def read_basis_inventory(self):
1207
"""Read the cached basis inventory."""
1208
path = self._basis_inventory_name()
1209
return self._control_files.get_utf8(path).read()
1212
def read_working_inventory(self):
1213
"""Read the working inventory."""
1214
# ElementTree does its own conversion from UTF-8, so open in
1216
result = bzrlib.xml5.serializer_v5.read_inventory(
1217
self._control_files.get('inventory'))
1218
self._set_inventory(result)
1222
def remove(self, files, verbose=False):
1223
"""Remove nominated files from the working inventory..
1225
This does not remove their text. This does not run on XXX on what? RBC
1227
TODO: Refuse to remove modified files unless --force is given?
1229
TODO: Do something useful with directories.
1231
TODO: Should this remove the text or not? Tough call; not
1232
removing may be useful and the user can just use use rm, and
1233
is the opposite of add. Removing it is consistent with most
1234
other tools. Maybe an option.
1236
## TODO: Normalize names
1237
## TODO: Remove nested loops; better scalability
1238
if isinstance(files, basestring):
1241
inv = self.inventory
1243
# do this before any modifications
1245
fid = inv.path2id(f)
1247
# TODO: Perhaps make this just a warning, and continue?
1248
# This tends to happen when
1249
raise NotVersionedError(path=f)
1250
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1252
# having remove it, it must be either ignored or unknown
1253
if self.is_ignored(f):
286
if fnmatch.fnmatchcase(filename, newpat):
1257
show_status(new_status, inv[fid].kind, quotefn(f))
1260
self._write_inventory(inv)
1263
def revert(self, filenames, old_tree=None, backups=True,
1264
pb=DummyProgress()):
1265
from transform import revert
1266
from conflicts import resolve
1267
if old_tree is None:
1268
old_tree = self.basis_tree()
1269
conflicts = revert(self, old_tree, filenames, backups, pb)
1270
if not len(filenames):
1271
self.set_pending_merges([])
1274
resolve(self, filenames, ignore_misses=True)
1277
# XXX: This method should be deprecated in favour of taking in a proper
1278
# new Inventory object.
1280
def set_inventory(self, new_inventory_list):
1281
from bzrlib.inventory import (Inventory,
1286
inv = Inventory(self.get_root_id())
1287
for path, file_id, parent, kind in new_inventory_list:
1288
name = os.path.basename(path)
1291
# fixme, there should be a factory function inv,add_??
1292
if kind == 'directory':
1293
inv.add(InventoryDirectory(file_id, name, parent))
1294
elif kind == 'file':
1295
inv.add(InventoryFile(file_id, name, parent))
1296
elif kind == 'symlink':
1297
inv.add(InventoryLink(file_id, name, parent))
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1299
raise BzrError("unknown kind %r" % kind)
1300
self._write_inventory(inv)
1303
def set_root_id(self, file_id):
1304
"""Set the root id for this tree."""
1305
inv = self.read_working_inventory()
1306
orig_root_id = inv.root.file_id
1307
del inv._byid[inv.root.file_id]
1308
inv.root.file_id = file_id
1309
inv._byid[inv.root.file_id] = inv.root
1312
if entry.parent_id == orig_root_id:
1313
entry.parent_id = inv.root.file_id
1314
self._write_inventory(inv)
1317
"""See Branch.unlock.
1319
WorkingTree locking just uses the Branch locking facilities.
1320
This is current because all working trees have an embedded branch
1321
within them. IF in the future, we were to make branch data shareable
1322
between multiple working trees, i.e. via shared storage, then we
1323
would probably want to lock both the local tree, and the branch.
1325
# FIXME: We want to write out the hashcache only when the last lock on
1326
# this working copy is released. Peeking at the lock count is a bit
1327
# of a nasty hack; probably it's better to have a transaction object,
1328
# which can do some finalization when it's either successfully or
1329
# unsuccessfully completed. (Denys's original patch did that.)
1330
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1331
# wrongly. Hookinh into unllock on the control files object is fine though.
1333
# TODO: split this per format so there is no ugly if block
1334
if self._hashcache.needs_write and (
1335
# dedicated lock files
1336
self._control_files._lock_count==1 or
1338
(self._control_files is self.branch.control_files and
1339
self._control_files._lock_count==3)):
1340
self._hashcache.write()
1341
# reverse order of locking.
1343
return self._control_files.unlock()
1345
self.branch.unlock()
1349
"""Update a working tree along its branch.
1351
This will update the branch if its bound too, which means we have multiple trees involved:
1352
The new basis tree of the master.
1353
The old basis tree of the branch.
1354
The old basis tree of the working tree.
1355
The current working tree state.
1356
pathologically all three may be different, and non ancestors of each other.
1357
Conceptually we want to:
1358
Preserve the wt.basis->wt.state changes
1359
Transform the wt.basis to the new master basis.
1360
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1361
Restore the wt.basis->wt.state changes.
1363
There isn't a single operation at the moment to do that, so we:
1364
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1365
Do a 'normal' merge of the old branch basis if it is relevant.
1367
old_tip = self.branch.update()
1368
if old_tip is not None:
1369
self.add_pending_merge(old_tip)
1370
self.branch.lock_read()
1373
if self.last_revision() != self.branch.last_revision():
1374
# merge tree state up to new branch tip.
1375
basis = self.basis_tree()
1376
to_tree = self.branch.basis_tree()
1377
result += merge_inner(self.branch,
1381
self.set_last_revision(self.branch.last_revision())
1382
if old_tip and old_tip != self.last_revision():
1383
# our last revision was not the prior branch last reivison
1384
# and we have converted that last revision to a pending merge.
1385
# base is somewhere between the branch tip now
1386
# and the now pending merge
1387
from bzrlib.revision import common_ancestor
1389
base_rev_id = common_ancestor(self.branch.last_revision(),
1391
self.branch.repository)
1392
except errors.NoCommonAncestor:
1394
base_tree = self.branch.repository.revision_tree(base_rev_id)
1395
other_tree = self.branch.repository.revision_tree(old_tip)
1396
result += merge_inner(self.branch,
1402
self.branch.unlock()
1405
def _write_inventory(self, inv):
1406
"""Write inventory as the current inventory."""
1408
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1410
self._control_files.put('inventory', sio)
1411
self._set_inventory(inv)
1412
mutter('wrote working inventory')
1414
def set_conflicts(self, arg):
1415
raise UnsupportedOperation(self.set_conflicts, self)
1418
def conflicts(self):
1419
conflicts = ConflictList()
1420
for conflicted in self._iter_conflicts():
1423
if file_kind(self.abspath(conflicted)) != "file":
1426
if e.errno == errno.ENOENT:
1431
for suffix in ('.THIS', '.OTHER'):
1433
kind = file_kind(self.abspath(conflicted+suffix))
1435
if e.errno == errno.ENOENT:
1443
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1444
conflicts.append(Conflict.factory(ctype, path=conflicted,
1445
file_id=self.path2id(conflicted)))
1449
class WorkingTree3(WorkingTree):
1450
"""This is the Format 3 working tree.
1452
This differs from the base WorkingTree by:
1453
- having its own file lock
1454
- having its own last-revision property.
1456
This is new in bzr 0.8
1460
def last_revision(self):
1461
"""See WorkingTree.last_revision."""
1463
return self._control_files.get_utf8('last-revision').read()
b'\\ No newline at end of file'
1467
def _change_last_revision(self, revision_id):
1468
"""See WorkingTree._change_last_revision."""
1469
if revision_id is None or revision_id == NULL_REVISION:
1471
self._control_files._transport.delete('last-revision')
1472
except errors.NoSuchFile:
1477
self.branch.revision_history().index(revision_id)
1479
raise errors.NoSuchRevision(self.branch, revision_id)
1480
self._control_files.put_utf8('last-revision', revision_id)
1484
def set_conflicts(self, conflicts):
1485
self._put_rio('conflicts', conflicts.to_stanzas(),
1489
def conflicts(self):
1491
confile = self._control_files.get('conflicts')
1493
return ConflictList()
1495
if confile.next() != CONFLICT_HEADER_1 + '\n':
1496
raise ConflictFormatError()
1497
except StopIteration:
1498
raise ConflictFormatError()
1499
return ConflictList.from_stanzas(RioReader(confile))
1502
def get_conflicted_stem(path):
1503
for suffix in CONFLICT_SUFFIXES:
1504
if path.endswith(suffix):
1505
return path[:-len(suffix)]
1507
@deprecated_function(zero_eight)
1508
def is_control_file(filename):
1509
"""See WorkingTree.is_control_filename(filename)."""
1510
## FIXME: better check
1511
filename = normpath(filename)
1512
while filename != '':
1513
head, tail = os.path.split(filename)
1514
## mutter('check %r for control file' % ((head, tail),))
1517
if filename == head:
1523
class WorkingTreeFormat(object):
1524
"""An encapsulation of the initialization and open routines for a format.
1526
Formats provide three things:
1527
* An initialization routine,
1531
Formats are placed in an dict by their format string for reference
1532
during workingtree opening. Its not required that these be instances, they
1533
can be classes themselves with class methods - it simply depends on
1534
whether state is needed for a given format or not.
1536
Once a format is deprecated, just deprecate the initialize and open
1537
methods on the format class. Do not deprecate the object, as the
1538
object will be created every time regardless.
1541
_default_format = None
1542
"""The default format used for new trees."""
1545
"""The known formats."""
1548
def find_format(klass, a_bzrdir):
1549
"""Return the format for the working tree object in a_bzrdir."""
1551
transport = a_bzrdir.get_workingtree_transport(None)
1552
format_string = transport.get("format").read()
1553
return klass._formats[format_string]
1555
raise errors.NoWorkingTree(base=transport.base)
1557
raise errors.UnknownFormatError(format_string)
1560
def get_default_format(klass):
1561
"""Return the current default format."""
1562
return klass._default_format
1564
def get_format_string(self):
1565
"""Return the ASCII format string that identifies this format."""
1566
raise NotImplementedError(self.get_format_string)
1568
def get_format_description(self):
1569
"""Return the short description for this format."""
1570
raise NotImplementedError(self.get_format_description)
1572
def is_supported(self):
1573
"""Is this format supported?
1575
Supported formats can be initialized and opened.
1576
Unsupported formats may not support initialization or committing or
1577
some other features depending on the reason for not being supported.
1582
def register_format(klass, format):
1583
klass._formats[format.get_format_string()] = format
1586
def set_default_format(klass, format):
1587
klass._default_format = format
1590
def unregister_format(klass, format):
1591
assert klass._formats[format.get_format_string()] is format
1592
del klass._formats[format.get_format_string()]
1596
class WorkingTreeFormat2(WorkingTreeFormat):
1597
"""The second working tree format.
1599
This format modified the hash cache from the format 1 hash cache.
1602
def get_format_description(self):
1603
"""See WorkingTreeFormat.get_format_description()."""
1604
return "Working tree format 2"
1606
def stub_initialize_remote(self, control_files):
1607
"""As a special workaround create critical control files for a remote working tree
1609
This ensures that it can later be updated and dealt with locally,
1610
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1611
no working tree. (See bug #43064).
1615
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1617
control_files.put('inventory', sio)
1619
control_files.put_utf8('pending-merges', '')
1622
def initialize(self, a_bzrdir, revision_id=None):
1623
"""See WorkingTreeFormat.initialize()."""
1624
if not isinstance(a_bzrdir.transport, LocalTransport):
1625
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1626
branch = a_bzrdir.open_branch()
1627
if revision_id is not None:
1630
revision_history = branch.revision_history()
1632
position = revision_history.index(revision_id)
1634
raise errors.NoSuchRevision(branch, revision_id)
1635
branch.set_revision_history(revision_history[:position + 1])
1638
revision = branch.last_revision()
1640
wt = WorkingTree(a_bzrdir.root_transport.base,
1646
wt._write_inventory(inv)
1647
wt.set_root_id(inv.root.file_id)
1648
wt.set_last_revision(revision)
1649
wt.set_pending_merges([])
1650
build_tree(wt.basis_tree(), wt)
1654
super(WorkingTreeFormat2, self).__init__()
1655
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1657
def open(self, a_bzrdir, _found=False):
1658
"""Return the WorkingTree object for a_bzrdir
1660
_found is a private parameter, do not use it. It is used to indicate
1661
if format probing has already been done.
1664
# we are being called directly and must probe.
1665
raise NotImplementedError
1666
if not isinstance(a_bzrdir.transport, LocalTransport):
1667
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1668
return WorkingTree(a_bzrdir.root_transport.base,
1674
class WorkingTreeFormat3(WorkingTreeFormat):
1675
"""The second working tree format updated to record a format marker.
1678
- exists within a metadir controlling .bzr
1679
- includes an explicit version marker for the workingtree control
1680
files, separate from the BzrDir format
1681
- modifies the hash cache format
1683
- uses a LockDir to guard access to the repository
1686
def get_format_string(self):
1687
"""See WorkingTreeFormat.get_format_string()."""
1688
return "Bazaar-NG Working Tree format 3"
1690
def get_format_description(self):
1691
"""See WorkingTreeFormat.get_format_description()."""
1692
return "Working tree format 3"
1694
_lock_file_name = 'lock'
1695
_lock_class = LockDir
1697
def _open_control_files(self, a_bzrdir):
1698
transport = a_bzrdir.get_workingtree_transport(None)
1699
return LockableFiles(transport, self._lock_file_name,
1702
def initialize(self, a_bzrdir, revision_id=None):
1703
"""See WorkingTreeFormat.initialize().
1705
revision_id allows creating a working tree at a differnet
1706
revision than the branch is at.
1708
if not isinstance(a_bzrdir.transport, LocalTransport):
1709
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1710
transport = a_bzrdir.get_workingtree_transport(self)
1711
control_files = self._open_control_files(a_bzrdir)
1712
control_files.create_lock()
1713
control_files.lock_write()
1714
control_files.put_utf8('format', self.get_format_string())
1715
branch = a_bzrdir.open_branch()
1716
if revision_id is None:
1717
revision_id = branch.last_revision()
1719
wt = WorkingTree3(a_bzrdir.root_transport.base,
1725
_control_files=control_files)
1728
wt._write_inventory(inv)
1729
wt.set_root_id(inv.root.file_id)
1730
wt.set_last_revision(revision_id)
1731
wt.set_pending_merges([])
1732
build_tree(wt.basis_tree(), wt)
1735
control_files.unlock()
1739
super(WorkingTreeFormat3, self).__init__()
1740
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1742
def open(self, a_bzrdir, _found=False):
1743
"""Return the WorkingTree object for a_bzrdir
1745
_found is a private parameter, do not use it. It is used to indicate
1746
if format probing has already been done.
1749
# we are being called directly and must probe.
1750
raise NotImplementedError
1751
if not isinstance(a_bzrdir.transport, LocalTransport):
1752
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1753
control_files = self._open_control_files(a_bzrdir)
1754
return WorkingTree3(a_bzrdir.root_transport.base,
1758
_control_files=control_files)
1761
return self.get_format_string()
1764
# formats which have no format string are not discoverable
1765
# and not independently creatable, so are not registered.
1766
__default_format = WorkingTreeFormat3()
1767
WorkingTreeFormat.register_format(__default_format)
1768
WorkingTreeFormat.set_default_format(__default_format)
1769
_legacy_formats = [WorkingTreeFormat2(),
1773
class WorkingTreeTestProviderAdapter(object):
1774
"""A tool to generate a suite testing multiple workingtree formats at once.
1776
This is done by copying the test once for each transport and injecting
1777
the transport_server, transport_readonly_server, and workingtree_format
1778
classes into each copy. Each copy is also given a new id() to make it
1782
def __init__(self, transport_server, transport_readonly_server, formats):
1783
self._transport_server = transport_server
1784
self._transport_readonly_server = transport_readonly_server
1785
self._formats = formats
1787
def adapt(self, test):
1788
from bzrlib.tests import TestSuite
1789
result = TestSuite()
1790
for workingtree_format, bzrdir_format in self._formats:
1791
new_test = deepcopy(test)
1792
new_test.transport_server = self._transport_server
1793
new_test.transport_readonly_server = self._transport_readonly_server
1794
new_test.bzrdir_format = bzrdir_format
1795
new_test.workingtree_format = workingtree_format
1796
def make_new_test_id():
1797
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1798
return lambda: new_id
1799
new_test.id = make_new_test_id()
1800
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
