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 copy import deepcopy
43
from cStringIO import StringIO
50
from bzrlib.atomicfile import AtomicFile
51
from bzrlib.branch import (Branch,
53
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
import bzrlib.bzrdir as bzrdir
55
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
import bzrlib.errors as errors
57
from bzrlib.errors import (BzrCheckError,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError,
68
from bzrlib.inventory import InventoryEntry, Inventory
69
from bzrlib.lockable_files import LockableFiles, TransportLock
70
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
72
from bzrlib.osutils import (
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 *
94
from bzrlib.textui import show_status
26
from errors import BzrCheckError
27
from trace import mutter
96
from bzrlib.trace import mutter
97
from bzrlib.transform import build_tree
98
from bzrlib.transport import get_transport
99
from bzrlib.transport.local import LocalTransport
104
def gen_file_id(name):
105
"""Return new file id.
107
This should probably generate proper UUIDs, but for the moment we
108
cope with just randomness because running uuidgen every time is
111
from binascii import hexlify
112
from time import time
115
idx = name.rfind('/')
117
name = name[idx+1 : ]
118
idx = name.rfind('\\')
120
name = name[idx+1 : ]
122
# make it not a hidden file
123
name = name.lstrip('.')
125
# remove any wierd characters; we don't escape them but rather
127
name = re.sub(r'[^\w.]', '', name)
129
s = hexlify(rand_bytes(8))
130
return '-'.join((name, compact_date(time()), s))
134
"""Return a new tree-root file id."""
135
return gen_file_id('TREE_ROOT')
138
class TreeEntry(object):
139
"""An entry that implements the minium interface used by commands.
141
This needs further inspection, it may be better to have
142
InventoryEntries without ids - though that seems wrong. For now,
143
this is a parallel hierarchy to InventoryEntry, and needs to become
144
one of several things: decorates to that hierarchy, children of, or
146
Another note is that these objects are currently only used when there is
147
no InventoryEntry available - i.e. for unversioned objects.
148
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
151
def __eq__(self, other):
152
# yes, this us ugly, TODO: best practice __eq__ style.
153
return (isinstance(other, TreeEntry)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeDirectory(TreeEntry):
161
"""See TreeEntry. This is a directory in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeDirectory)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class TreeFile(TreeEntry):
172
"""See TreeEntry. This is a regular file in a working tree."""
174
def __eq__(self, other):
175
return (isinstance(other, TreeFile)
176
and other.__class__ == self.__class__)
178
def kind_character(self):
182
class TreeLink(TreeEntry):
183
"""See TreeEntry. This is a symlink in a working tree."""
185
def __eq__(self, other):
186
return (isinstance(other, TreeLink)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
29
193
class WorkingTree(bzrlib.tree.Tree):
30
194
"""Working copy tree.
35
199
It is possible for a `WorkingTree` to have a filename which is
36
200
not listed in the Inventory and vice versa.
38
def __init__(self, basedir, inv):
203
def __init__(self, basedir='.',
204
branch=DEPRECATED_PARAMETER,
210
"""Construct a WorkingTree for basedir.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
217
self._format = _format
218
self.bzrdir = _bzrdir
220
# not created via open etc.
221
warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self.branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
39
233
from bzrlib.hashcache import HashCache
40
234
from bzrlib.trace import note, mutter
43
self.basedir = basedir
44
self.path2id = inv.path2id
235
assert isinstance(basedir, basestring), \
236
"base directory %r is not a string" % basedir
237
basedir = safe_unicode(basedir)
238
mutter("opening working tree %r", basedir)
239
if deprecated_passed(branch):
241
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
" Please use bzrdir.open_workingtree() or"
243
" WorkingTree.open().",
249
self.branch = self.bzrdir.open_branch()
250
assert isinstance(self.branch, Branch), \
251
"branch %r is not a Branch" % self.branch
252
self.basedir = realpath(basedir)
253
# if branch is at our basedir and is a format 6 or less
254
if isinstance(self._format, WorkingTreeFormat2):
255
# share control object
256
self._control_files = self.branch.control_files
258
# only ready for format 3
259
assert isinstance(self._format, WorkingTreeFormat3)
260
assert isinstance(_control_files, LockableFiles), \
261
"_control_files must be a LockableFiles, not %r" \
263
self._control_files = _control_files
46
264
# update the whole cache up front and write to disk if anything changed;
47
265
# in the future we might want to do this more selectively
48
hc = self._hashcache = HashCache(basedir)
266
# two possible ways offer themselves : in self._unlock, write the cache
267
# if needed, or, when the cache sees a change, append it to the hash
268
# cache file, and have the parser take the most recent entry for a
270
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
273
# is this scan needed ? it makes things kinda slow.
52
276
if hc.needs_write:
53
277
mutter("write hc")
58
if self._hashcache.needs_write:
59
self._hashcache.write()
280
if _inventory is None:
281
self._set_inventory(self.read_working_inventory())
283
self._set_inventory(_inventory)
285
def _set_inventory(self, inv):
286
self._inventory = inv
287
self.path2id = self._inventory.path2id
289
def is_control_filename(self, filename):
290
"""True if filename is the name of a control file in this tree.
292
This is true IF and ONLY IF the filename is part of the meta data
293
that bzr controls in this tree. I.E. a random .bzr directory placed
294
on disk will not be a control file for this tree.
297
self.bzrdir.transport.relpath(self.abspath(filename))
299
except errors.PathNotChild:
303
def open(path=None, _unsupported=False):
304
"""Open an existing working tree at path.
308
path = os.path.getcwdu()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
313
def open_containing(path=None):
314
"""Open an existing working tree which has its root about path.
316
This probes for a working tree at path and searches upwards from there.
318
Basically we keep looking up until we find the control directory or
319
run into /. If there isn't one, raises NotBranchError.
320
TODO: give this a new exception.
321
If there is one, it is returned, along with the unused portion of path.
325
control, relpath = bzrdir.BzrDir.open_containing(path)
326
return control.open_workingtree(), relpath
329
def open_downlevel(path=None):
330
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
334
return WorkingTree.open(path, _unsupported=True)
62
336
def __iter__(self):
63
337
"""Iterate through file_ids for this tree.
89
417
def get_file_byname(self, filename):
90
418
return file(self.abspath(filename), 'rb')
420
def get_root_id(self):
421
"""Return the id of this trees root"""
422
inv = self.read_working_inventory()
423
return inv.root.file_id
92
425
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))
426
## XXX: badly named; this is not in the store at all
427
return self.abspath(self.id2path(file_id))
430
def clone(self, to_bzrdir, revision_id=None, basis=None):
431
"""Duplicate this working tree into to_bzr, including all state.
433
Specifically modified files are kept as modified, but
434
ignored and unknown files are discarded.
436
If you want to make a new line of development, see bzrdir.sprout()
439
If not None, the cloned tree will have its last revision set to
440
revision, and and difference between the source trees last revision
441
and this one merged in.
444
If not None, a closer copy of a tree which may have some files in
445
common, and which file content should be preferentially copied from.
447
# assumes the target bzr dir format is compatible.
448
result = self._format.initialize(to_bzrdir)
449
self.copy_content_into(result, revision_id)
453
def copy_content_into(self, tree, revision_id=None):
454
"""Copy the current content and user files of this tree into tree."""
455
if revision_id is None:
456
transform_tree(tree, self)
458
# TODO now merge from tree.last_revision to revision
459
transform_tree(tree, self)
460
tree.set_last_revision(revision_id)
463
def commit(self, message=None, revprops=None, *args, **kwargs):
464
# avoid circular imports
465
from bzrlib.commit import Commit
468
if not 'branch-nick' in revprops:
469
revprops['branch-nick'] = self.branch.nick
470
# args for wt.commit start at message from the Commit.commit method,
471
# but with branch a kwarg now, passing in args as is results in the
472
#message being used for the branch
473
args = (DEPRECATED_PARAMETER, message, ) + args
474
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
self._set_inventory(self.read_working_inventory())
477
def id2abspath(self, file_id):
478
return self.abspath(self.id2path(file_id))
97
480
def has_id(self, file_id):
98
481
# files that have been deleted are excluded
99
482
inv = self._inventory
100
483
if not inv.has_id(file_id):
102
485
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
486
return bzrlib.osutils.lexists(self.abspath(path))
488
def has_or_had_id(self, file_id):
489
if file_id == self.inventory.root.file_id:
491
return self.inventory.has_id(file_id)
106
493
__contains__ = has_id
109
495
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
496
return os.path.getsize(self.id2abspath(file_id))
114
499
def get_file_sha1(self, file_id):
115
500
path = self._inventory.id2path(file_id)
116
501
return self._hashcache.get_sha1(path)
503
def is_executable(self, file_id):
504
if not supports_executable():
505
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
508
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
512
def add(self, files, ids=None):
513
"""Make files versioned.
515
Note that the command line normally calls smart_add instead,
516
which can automatically recurse.
518
This adds the files to the inventory, so that they will be
519
recorded by the next commit.
522
List of paths to add, relative to the base of the tree.
525
If set, use these instead of automatically generated ids.
526
Must be the same length as the list of files, but may
527
contain None for ids that are to be autogenerated.
529
TODO: Perhaps have an option to add the ids even if the files do
532
TODO: Perhaps callback with the ids and paths as they're added.
534
# TODO: Re-adding a file that is removed in the working copy
535
# should probably put it back with the previous ID.
536
if isinstance(files, basestring):
537
assert(ids is None or isinstance(ids, basestring))
543
ids = [None] * len(files)
545
assert(len(ids) == len(files))
547
inv = self.read_working_inventory()
548
for f,file_id in zip(files, ids):
549
if self.is_control_filename(f):
550
raise BzrError("cannot add control file %s" % quotefn(f))
555
raise BzrError("cannot add top-level %r" % f)
557
fullpath = normpath(self.abspath(f))
560
kind = file_kind(fullpath)
562
if e.errno == errno.ENOENT:
563
raise NoSuchFile(fullpath)
564
# maybe something better?
565
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
567
if not InventoryEntry.versionable_kind(kind):
568
raise BzrError('cannot add: not a versionable file ('
569
'i.e. regular file, symlink or directory): %s' % quotefn(f))
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
self._write_inventory(inv)
579
def add_pending_merge(self, *revision_ids):
580
# TODO: Perhaps should check at this point that the
581
# history of the revision is actually present?
582
p = self.pending_merges()
584
for rev_id in revision_ids:
590
self.set_pending_merges(p)
593
def pending_merges(self):
594
"""Return a list of pending merges.
596
These are revisions that have been merged into the working
597
directory but not yet committed.
600
merges_file = self._control_files.get_utf8('pending-merges')
602
if e.errno != errno.ENOENT:
606
for l in merges_file.readlines():
607
p.append(l.rstrip('\n'))
611
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
615
def set_merge_modified(self, modified_hashes):
617
for file_id, hash in modified_hashes.iteritems():
618
yield Stanza(file_id=file_id, hash=hash)
619
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
622
def _put_rio(self, filename, stanzas, header):
623
my_file = rio_file(stanzas, header)
624
self._control_files.put(filename, my_file)
627
def merge_modified(self):
629
hashfile = self._control_files.get('merge-hashes')
634
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
636
except StopIteration:
637
raise MergeModifiedFormatError()
638
for s in RioReader(hashfile):
639
file_id = s.get("file_id")
641
if hash == self.get_file_sha1(file_id):
642
merge_hashes[file_id] = hash
645
def get_symlink_target(self, file_id):
646
return os.readlink(self.id2abspath(file_id))
119
648
def file_class(self, filename):
120
649
if self.path2id(filename):
184
724
for ff in descend(fp, f_ie.file_id, fap):
187
for f in descend('', inv.root.file_id, self.basedir):
727
for f in descend(u'', inv.root.file_id, self.basedir):
731
def move(self, from_paths, to_name):
734
to_name must exist in the inventory.
736
If to_name exists and is a directory, the files are moved into
737
it, keeping their old names.
739
Note that to_name is only the last component of the new name;
740
this doesn't change the directory.
742
This returns a list of (from_path, to_path) pairs for each
746
## TODO: Option to move IDs only
747
assert not isinstance(from_paths, basestring)
749
to_abs = self.abspath(to_name)
750
if not isdir(to_abs):
751
raise BzrError("destination %r is not a directory" % to_abs)
752
if not self.has_filename(to_name):
753
raise BzrError("destination %r not in working directory" % to_abs)
754
to_dir_id = inv.path2id(to_name)
755
if to_dir_id == None and to_name != '':
756
raise BzrError("destination %r is not a versioned directory" % to_name)
757
to_dir_ie = inv[to_dir_id]
758
if to_dir_ie.kind not in ('directory', 'root_directory'):
759
raise BzrError("destination %r is not a directory" % to_abs)
761
to_idpath = inv.get_idpath(to_dir_id)
764
if not self.has_filename(f):
765
raise BzrError("%r does not exist in working tree" % f)
766
f_id = inv.path2id(f)
768
raise BzrError("%r is not versioned" % f)
769
name_tail = splitpath(f)[-1]
770
dest_path = appendpath(to_name, name_tail)
771
if self.has_filename(dest_path):
772
raise BzrError("destination %r already exists" % dest_path)
773
if f_id in to_idpath:
774
raise BzrError("can't move %r to a subdirectory of itself" % f)
776
# OK, so there's a race here, it's possible that someone will
777
# create a file in this interval and then the rename might be
778
# left half-done. But we should have caught most problems.
779
orig_inv = deepcopy(self.inventory)
782
name_tail = splitpath(f)[-1]
783
dest_path = appendpath(to_name, name_tail)
784
result.append((f, dest_path))
785
inv.rename(inv.path2id(f), to_dir_id, name_tail)
787
rename(self.abspath(f), self.abspath(dest_path))
789
raise BzrError("failed to rename %r to %r: %s" %
790
(f, dest_path, e[1]),
791
["rename rolled back"])
793
# restore the inventory on error
794
self._set_inventory(orig_inv)
796
self._write_inventory(inv)
800
def rename_one(self, from_rel, to_rel):
803
This can change the directory or the filename or both.
806
if not self.has_filename(from_rel):
807
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
808
if self.has_filename(to_rel):
809
raise BzrError("can't rename: new working file %r already exists" % to_rel)
811
file_id = inv.path2id(from_rel)
813
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
from_parent = entry.parent_id
817
from_name = entry.name
819
if inv.path2id(to_rel):
820
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
822
to_dir, to_tail = os.path.split(to_rel)
823
to_dir_id = inv.path2id(to_dir)
824
if to_dir_id == None and to_dir != '':
825
raise BzrError("can't determine destination directory id for %r" % to_dir)
827
mutter("rename_one:")
828
mutter(" file_id {%s}" % file_id)
829
mutter(" from_rel %r" % from_rel)
830
mutter(" to_rel %r" % to_rel)
831
mutter(" to_dir %r" % to_dir)
832
mutter(" to_dir_id {%s}" % to_dir_id)
834
inv.rename(file_id, to_dir_id, to_tail)
836
from_abs = self.abspath(from_rel)
837
to_abs = self.abspath(to_rel)
839
rename(from_abs, to_abs)
841
inv.rename(file_id, from_parent, from_name)
842
raise BzrError("failed to rename %r to %r: %s"
843
% (from_abs, to_abs, e[1]),
844
["rename rolled back"])
845
self._write_inventory(inv)
192
848
def unknowns(self):
849
"""Return all unknown files.
851
These are files in the working directory that are not versioned or
852
control files or ignored.
854
>>> from bzrlib.bzrdir import ScratchDir
855
>>> d = ScratchDir(files=['foo', 'foo~'])
856
>>> b = d.open_branch()
857
>>> tree = d.open_workingtree()
858
>>> map(str, tree.unknowns())
861
>>> list(b.unknowns())
863
>>> tree.remove('foo')
864
>>> list(b.unknowns())
193
867
for subp in self.extras():
194
868
if not self.is_ignored(subp):
871
@deprecated_method(zero_eight)
872
def iter_conflicts(self):
873
"""List all files in the tree that have text or content conflicts.
874
DEPRECATED. Use conflicts instead."""
875
return self._iter_conflicts()
877
def _iter_conflicts(self):
879
for path in (s[0] for s in self.list_files()):
880
stem = get_conflicted_stem(path)
883
if stem not in conflicted:
888
def pull(self, source, overwrite=False, stop_revision=None):
889
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
892
pp = ProgressPhase("Pull phase", 2, top_pb)
894
old_revision_history = self.branch.revision_history()
895
basis_tree = self.basis_tree()
896
count = self.branch.pull(source, overwrite, stop_revision)
897
new_revision_history = self.branch.revision_history()
898
if new_revision_history != old_revision_history:
900
if len(old_revision_history):
901
other_revision = old_revision_history[-1]
903
other_revision = None
904
repository = self.branch.repository
905
pb = bzrlib.ui.ui_factory.nested_progress_bar()
907
merge_inner(self.branch,
908
self.branch.basis_tree(),
914
self.set_last_revision(self.branch.last_revision())
198
920
def extras(self):
199
921
"""Yield all unknown files in this WorkingTree.
b'\\ No newline at end of file'
1011
def kind(self, file_id):
1012
return file_kind(self.id2abspath(file_id))
1015
def last_revision(self):
1016
"""Return the last revision id of this working tree.
1018
In early branch formats this was == the branch last_revision,
1019
but that cannot be relied upon - for working tree operations,
1020
always use tree.last_revision().
1022
return self.branch.last_revision()
1024
def lock_read(self):
1025
"""See Branch.lock_read, and WorkingTree.unlock."""
1026
self.branch.lock_read()
1028
return self._control_files.lock_read()
1030
self.branch.unlock()
1033
def lock_write(self):
1034
"""See Branch.lock_write, and WorkingTree.unlock."""
1035
self.branch.lock_write()
1037
return self._control_files.lock_write()
1039
self.branch.unlock()
1042
def _basis_inventory_name(self):
1043
return 'basis-inventory'
1046
def set_last_revision(self, new_revision):
1047
"""Change the last revision in the working tree."""
1048
if self._change_last_revision(new_revision):
1049
self._cache_basis_inventory(new_revision)
1051
def _change_last_revision(self, new_revision):
1052
"""Template method part of set_last_revision to perform the change.
1054
This is used to allow WorkingTree3 instances to not affect branch
1055
when their last revision is set.
1057
if new_revision is None:
1058
self.branch.set_revision_history([])
1060
# current format is locked in with the branch
1061
revision_history = self.branch.revision_history()
1063
position = revision_history.index(new_revision)
1065
raise errors.NoSuchRevision(self.branch, new_revision)
1066
self.branch.set_revision_history(revision_history[:position + 1])
1069
def _cache_basis_inventory(self, new_revision):
1070
"""Cache new_revision as the basis inventory."""
1072
# this double handles the inventory - unpack and repack -
1073
# but is easier to understand. We can/should put a conditional
1074
# in here based on whether the inventory is in the latest format
1075
# - perhaps we should repack all inventories on a repository
1077
inv = self.branch.repository.get_inventory(new_revision)
1078
inv.revision_id = new_revision
1079
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1081
path = self._basis_inventory_name()
1082
self._control_files.put_utf8(path, xml)
1083
except WeaveRevisionNotPresent:
1086
def read_basis_inventory(self):
1087
"""Read the cached basis inventory."""
1088
path = self._basis_inventory_name()
1089
return self._control_files.get_utf8(path).read()
1092
def read_working_inventory(self):
1093
"""Read the working inventory."""
1094
# ElementTree does its own conversion from UTF-8, so open in
1096
result = bzrlib.xml5.serializer_v5.read_inventory(
1097
self._control_files.get('inventory'))
1098
self._set_inventory(result)
1102
def remove(self, files, verbose=False):
1103
"""Remove nominated files from the working inventory..
1105
This does not remove their text. This does not run on XXX on what? RBC
1107
TODO: Refuse to remove modified files unless --force is given?
1109
TODO: Do something useful with directories.
1111
TODO: Should this remove the text or not? Tough call; not
1112
removing may be useful and the user can just use use rm, and
1113
is the opposite of add. Removing it is consistent with most
1114
other tools. Maybe an option.
1116
## TODO: Normalize names
1117
## TODO: Remove nested loops; better scalability
1118
if isinstance(files, basestring):
1121
inv = self.inventory
1123
# do this before any modifications
1125
fid = inv.path2id(f)
1127
# TODO: Perhaps make this just a warning, and continue?
1128
# This tends to happen when
1129
raise NotVersionedError(path=f)
1130
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1132
# having remove it, it must be either ignored or unknown
1133
if self.is_ignored(f):
1137
show_status(new_status, inv[fid].kind, quotefn(f))
1140
self._write_inventory(inv)
1143
def revert(self, filenames, old_tree=None, backups=True,
1144
pb=DummyProgress()):
1145
from transform import revert
1146
from conflicts import resolve
1147
if old_tree is None:
1148
old_tree = self.basis_tree()
1149
conflicts = revert(self, old_tree, filenames, backups, pb)
1150
if not len(filenames):
1151
self.set_pending_merges([])
1154
resolve(self, filenames, ignore_misses=True)
1158
def set_inventory(self, new_inventory_list):
1159
from bzrlib.inventory import (Inventory,
1164
inv = Inventory(self.get_root_id())
1165
for path, file_id, parent, kind in new_inventory_list:
1166
name = os.path.basename(path)
1169
# fixme, there should be a factory function inv,add_??
1170
if kind == 'directory':
1171
inv.add(InventoryDirectory(file_id, name, parent))
1172
elif kind == 'file':
1173
inv.add(InventoryFile(file_id, name, parent))
1174
elif kind == 'symlink':
1175
inv.add(InventoryLink(file_id, name, parent))
1177
raise BzrError("unknown kind %r" % kind)
1178
self._write_inventory(inv)
1181
def set_root_id(self, file_id):
1182
"""Set the root id for this tree."""
1183
inv = self.read_working_inventory()
1184
orig_root_id = inv.root.file_id
1185
del inv._byid[inv.root.file_id]
1186
inv.root.file_id = file_id
1187
inv._byid[inv.root.file_id] = inv.root
1190
if entry.parent_id == orig_root_id:
1191
entry.parent_id = inv.root.file_id
1192
self._write_inventory(inv)
1195
"""See Branch.unlock.
1197
WorkingTree locking just uses the Branch locking facilities.
1198
This is current because all working trees have an embedded branch
1199
within them. IF in the future, we were to make branch data shareable
1200
between multiple working trees, i.e. via shared storage, then we
1201
would probably want to lock both the local tree, and the branch.
1203
# FIXME: We want to write out the hashcache only when the last lock on
1204
# this working copy is released. Peeking at the lock count is a bit
1205
# of a nasty hack; probably it's better to have a transaction object,
1206
# which can do some finalization when it's either successfully or
1207
# unsuccessfully completed. (Denys's original patch did that.)
1208
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1209
# wrongly. Hookinh into unllock on the control files object is fine though.
1211
# TODO: split this per format so there is no ugly if block
1212
if self._hashcache.needs_write and (
1213
# dedicated lock files
1214
self._control_files._lock_count==1 or
1216
(self._control_files is self.branch.control_files and
1217
self._control_files._lock_count==3)):
1218
self._hashcache.write()
1219
# reverse order of locking.
1220
result = self._control_files.unlock()
1222
self.branch.unlock()
1228
"""Update a working tree along its branch.
1230
This will update the branch if its bound too, which means we have multiple trees involved:
1231
The new basis tree of the master.
1232
The old basis tree of the branch.
1233
The old basis tree of the working tree.
1234
The current working tree state.
1235
pathologically all three may be different, and non ancestors of each other.
1236
Conceptually we want to:
1237
Preserve the wt.basis->wt.state changes
1238
Transform the wt.basis to the new master basis.
1239
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1240
Restore the wt.basis->wt.state changes.
1242
There isn't a single operation at the moment to do that, so we:
1243
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1244
Do a 'normal' merge of the old branch basis if it is relevant.
1246
old_tip = self.branch.update()
1247
if old_tip is not None:
1248
self.add_pending_merge(old_tip)
1249
self.branch.lock_read()
1252
if self.last_revision() != self.branch.last_revision():
1253
# merge tree state up to new branch tip.
1254
basis = self.basis_tree()
1255
to_tree = self.branch.basis_tree()
1256
result += merge_inner(self.branch,
1260
self.set_last_revision(self.branch.last_revision())
1261
if old_tip and old_tip != self.last_revision():
1262
# our last revision was not the prior branch last reivison
1263
# and we have converted that last revision to a pending merge.
1264
# base is somewhere between the branch tip now
1265
# and the now pending merge
1266
from bzrlib.revision import common_ancestor
1268
base_rev_id = common_ancestor(self.branch.last_revision(),
1270
self.branch.repository)
1271
except errors.NoCommonAncestor:
1273
base_tree = self.branch.repository.revision_tree(base_rev_id)
1274
other_tree = self.branch.repository.revision_tree(old_tip)
1275
result += merge_inner(self.branch,
1281
self.branch.unlock()
1284
def _write_inventory(self, inv):
1285
"""Write inventory as the current inventory."""
1287
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1289
self._control_files.put('inventory', sio)
1290
self._set_inventory(inv)
1291
mutter('wrote working inventory')
1293
def set_conflicts(self, arg):
1294
raise UnsupportedOperation(self.set_conflicts, self)
1297
def conflicts(self):
1298
conflicts = ConflictList()
1299
for conflicted in self._iter_conflicts():
1302
if file_kind(self.abspath(conflicted)) != "file":
1305
if e.errno == errno.ENOENT:
1310
for suffix in ('.THIS', '.OTHER'):
1312
kind = file_kind(self.abspath(conflicted+suffix))
1314
if e.errno == errno.ENOENT:
1322
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1323
conflicts.append(Conflict.factory(ctype, path=conflicted,
1324
file_id=self.path2id(conflicted)))
1328
class WorkingTree3(WorkingTree):
1329
"""This is the Format 3 working tree.
1331
This differs from the base WorkingTree by:
1332
- having its own file lock
1333
- having its own last-revision property.
1335
This is new in bzr 0.8
1339
def last_revision(self):
1340
"""See WorkingTree.last_revision."""
1342
return self._control_files.get_utf8('last-revision').read()
1346
def _change_last_revision(self, revision_id):
1347
"""See WorkingTree._change_last_revision."""
1348
if revision_id is None or revision_id == NULL_REVISION:
1350
self._control_files._transport.delete('last-revision')
1351
except errors.NoSuchFile:
1356
self.branch.revision_history().index(revision_id)
1358
raise errors.NoSuchRevision(self.branch, revision_id)
1359
self._control_files.put_utf8('last-revision', revision_id)
1363
def set_conflicts(self, conflicts):
1364
self._put_rio('conflicts', conflicts.to_stanzas(),
1368
def conflicts(self):
1370
confile = self._control_files.get('conflicts')
1372
return ConflictList()
1374
if confile.next() != CONFLICT_HEADER_1 + '\n':
1375
raise ConflictFormatError()
1376
except StopIteration:
1377
raise ConflictFormatError()
1378
return ConflictList.from_stanzas(RioReader(confile))
1381
def get_conflicted_stem(path):
1382
for suffix in CONFLICT_SUFFIXES:
1383
if path.endswith(suffix):
1384
return path[:-len(suffix)]
1386
@deprecated_function(zero_eight)
1387
def is_control_file(filename):
1388
"""See WorkingTree.is_control_filename(filename)."""
1389
## FIXME: better check
1390
filename = normpath(filename)
1391
while filename != '':
1392
head, tail = os.path.split(filename)
1393
## mutter('check %r for control file' % ((head, tail),))
1396
if filename == head:
1402
class WorkingTreeFormat(object):
1403
"""An encapsulation of the initialization and open routines for a format.
1405
Formats provide three things:
1406
* An initialization routine,
1410
Formats are placed in an dict by their format string for reference
1411
during workingtree opening. Its not required that these be instances, they
1412
can be classes themselves with class methods - it simply depends on
1413
whether state is needed for a given format or not.
1415
Once a format is deprecated, just deprecate the initialize and open
1416
methods on the format class. Do not deprecate the object, as the
1417
object will be created every time regardless.
1420
_default_format = None
1421
"""The default format used for new trees."""
1424
"""The known formats."""
1427
def find_format(klass, a_bzrdir):
1428
"""Return the format for the working tree object in a_bzrdir."""
1430
transport = a_bzrdir.get_workingtree_transport(None)
1431
format_string = transport.get("format").read()
1432
return klass._formats[format_string]
1434
raise errors.NoWorkingTree(base=transport.base)
1436
raise errors.UnknownFormatError(format_string)
1439
def get_default_format(klass):
1440
"""Return the current default format."""
1441
return klass._default_format
1443
def get_format_string(self):
1444
"""Return the ASCII format string that identifies this format."""
1445
raise NotImplementedError(self.get_format_string)
1447
def get_format_description(self):
1448
"""Return the short description for this format."""
1449
raise NotImplementedError(self.get_format_description)
1451
def is_supported(self):
1452
"""Is this format supported?
1454
Supported formats can be initialized and opened.
1455
Unsupported formats may not support initialization or committing or
1456
some other features depending on the reason for not being supported.
1461
def register_format(klass, format):
1462
klass._formats[format.get_format_string()] = format
1465
def set_default_format(klass, format):
1466
klass._default_format = format
1469
def unregister_format(klass, format):
1470
assert klass._formats[format.get_format_string()] is format
1471
del klass._formats[format.get_format_string()]
1475
class WorkingTreeFormat2(WorkingTreeFormat):
1476
"""The second working tree format.
1478
This format modified the hash cache from the format 1 hash cache.
1481
def get_format_description(self):
1482
"""See WorkingTreeFormat.get_format_description()."""
1483
return "Working tree format 2"
1485
def initialize(self, a_bzrdir, revision_id=None):
1486
"""See WorkingTreeFormat.initialize()."""
1487
if not isinstance(a_bzrdir.transport, LocalTransport):
1488
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1489
branch = a_bzrdir.open_branch()
1490
if revision_id is not None:
1493
revision_history = branch.revision_history()
1495
position = revision_history.index(revision_id)
1497
raise errors.NoSuchRevision(branch, revision_id)
1498
branch.set_revision_history(revision_history[:position + 1])
1501
revision = branch.last_revision()
1503
wt = WorkingTree(a_bzrdir.root_transport.base,
1509
wt._write_inventory(inv)
1510
wt.set_root_id(inv.root.file_id)
1511
wt.set_last_revision(revision)
1512
wt.set_pending_merges([])
1513
build_tree(wt.basis_tree(), wt)
1517
super(WorkingTreeFormat2, self).__init__()
1518
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1520
def open(self, a_bzrdir, _found=False):
1521
"""Return the WorkingTree object for a_bzrdir
1523
_found is a private parameter, do not use it. It is used to indicate
1524
if format probing has already been done.
1527
# we are being called directly and must probe.
1528
raise NotImplementedError
1529
if not isinstance(a_bzrdir.transport, LocalTransport):
1530
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1531
return WorkingTree(a_bzrdir.root_transport.base,
1537
class WorkingTreeFormat3(WorkingTreeFormat):
1538
"""The second working tree format updated to record a format marker.
1541
- exists within a metadir controlling .bzr
1542
- includes an explicit version marker for the workingtree control
1543
files, separate from the BzrDir format
1544
- modifies the hash cache format
1546
- uses a LockDir to guard access to the repository
1549
def get_format_string(self):
1550
"""See WorkingTreeFormat.get_format_string()."""
1551
return "Bazaar-NG Working Tree format 3"
1553
def get_format_description(self):
1554
"""See WorkingTreeFormat.get_format_description()."""
1555
return "Working tree format 3"
1557
_lock_file_name = 'lock'
1558
_lock_class = LockDir
1560
def _open_control_files(self, a_bzrdir):
1561
transport = a_bzrdir.get_workingtree_transport(None)
1562
return LockableFiles(transport, self._lock_file_name,
1565
def initialize(self, a_bzrdir, revision_id=None):
1566
"""See WorkingTreeFormat.initialize().
1568
revision_id allows creating a working tree at a differnet
1569
revision than the branch is at.
1571
if not isinstance(a_bzrdir.transport, LocalTransport):
1572
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1573
transport = a_bzrdir.get_workingtree_transport(self)
1574
control_files = self._open_control_files(a_bzrdir)
1575
control_files.create_lock()
1576
control_files.put_utf8('format', self.get_format_string())
1577
branch = a_bzrdir.open_branch()
1578
if revision_id is None:
1579
revision_id = branch.last_revision()
1581
wt = WorkingTree3(a_bzrdir.root_transport.base,
1587
_control_files=control_files)
1588
wt._write_inventory(inv)
1589
wt.set_root_id(inv.root.file_id)
1590
wt.set_last_revision(revision_id)
1591
wt.set_pending_merges([])
1592
build_tree(wt.basis_tree(), wt)
1596
super(WorkingTreeFormat3, self).__init__()
1597
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1599
def open(self, a_bzrdir, _found=False):
1600
"""Return the WorkingTree object for a_bzrdir
1602
_found is a private parameter, do not use it. It is used to indicate
1603
if format probing has already been done.
1606
# we are being called directly and must probe.
1607
raise NotImplementedError
1608
if not isinstance(a_bzrdir.transport, LocalTransport):
1609
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1610
control_files = self._open_control_files(a_bzrdir)
1611
return WorkingTree3(a_bzrdir.root_transport.base,
1615
_control_files=control_files)
1618
return self.get_format_string()
1621
# formats which have no format string are not discoverable
1622
# and not independently creatable, so are not registered.
1623
__default_format = WorkingTreeFormat3()
1624
WorkingTreeFormat.register_format(__default_format)
1625
WorkingTreeFormat.set_default_format(__default_format)
1626
_legacy_formats = [WorkingTreeFormat2(),
1630
class WorkingTreeTestProviderAdapter(object):
1631
"""A tool to generate a suite testing multiple workingtree formats at once.
1633
This is done by copying the test once for each transport and injecting
1634
the transport_server, transport_readonly_server, and workingtree_format
1635
classes into each copy. Each copy is also given a new id() to make it
1639
def __init__(self, transport_server, transport_readonly_server, formats):
1640
self._transport_server = transport_server
1641
self._transport_readonly_server = transport_readonly_server
1642
self._formats = formats
1644
def adapt(self, test):
1645
from bzrlib.tests import TestSuite
1646
result = TestSuite()
1647
for workingtree_format, bzrdir_format in self._formats:
1648
new_test = deepcopy(test)
1649
new_test.transport_server = self._transport_server
1650
new_test.transport_readonly_server = self._transport_readonly_server
1651
new_test.bzrdir_format = bzrdir_format
1652
new_test.workingtree_format = workingtree_format
1653
def make_new_test_id():
1654
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1655
return lambda: new_id
1656
new_test.id = make_new_test_id()
1657
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
