1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
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
"""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
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.
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import (deprecated_passed,
100
from bzrlib.trace import mutter, note
101
from bzrlib.transform import build_tree
102
from bzrlib.transport import get_transport
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.textui import show_status
105
25
import bzrlib.tree
110
# the regex removes any weird characters; we don't escape them
111
# but rather just pull them out
112
_gen_file_id_re = re.compile(r'[^\w.]')
113
_gen_id_suffix = None
117
def _next_id_suffix():
118
"""Create a new file id suffix that is reasonably unique.
120
On the first call we combine the current time with 64 bits of randomness
121
to give a highly probably globally unique number. Then each call in the same
122
process adds 1 to a serial number we append to that unique value.
124
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
125
# than having to move the id randomness out of the inner loop like this.
126
# XXX TODO: for the global randomness this uses we should add the thread-id
127
# before the serial #.
128
global _gen_id_suffix, _gen_id_serial
129
if _gen_id_suffix is None:
130
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
132
return _gen_id_suffix + str(_gen_id_serial)
135
def gen_file_id(name):
136
"""Return new file id for the basename 'name'.
138
The uniqueness is supplied from _next_id_suffix.
140
# The real randomness is in the _next_id_suffix, the
141
# rest of the identifier is just to be nice.
143
# 1) Remove non-ascii word characters to keep the ids portable
144
# 2) squash to lowercase, so the file id doesn't have to
145
# be escaped (case insensitive filesystems would bork for ids
146
# that only differred in case without escaping).
147
# 3) truncate the filename to 20 chars. Long filenames also bork on some
149
# 4) Removing starting '.' characters to prevent the file ids from
150
# being considered hidden.
151
ascii_word_only = _gen_file_id_re.sub('', name.lower())
152
short_no_dots = ascii_word_only.lstrip('.')[:20]
153
return short_no_dots + _next_id_suffix()
157
"""Return a new tree-root file id."""
158
return gen_file_id('TREE_ROOT')
161
class TreeEntry(object):
162
"""An entry that implements the minimum interface used by commands.
164
This needs further inspection, it may be better to have
165
InventoryEntries without ids - though that seems wrong. For now,
166
this is a parallel hierarchy to InventoryEntry, and needs to become
167
one of several things: decorates to that hierarchy, children of, or
169
Another note is that these objects are currently only used when there is
170
no InventoryEntry available - i.e. for unversioned objects.
171
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
174
def __eq__(self, other):
175
# yes, this us ugly, TODO: best practice __eq__ style.
176
return (isinstance(other, TreeEntry)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeDirectory(TreeEntry):
184
"""See TreeEntry. This is a directory in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeDirectory)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class TreeFile(TreeEntry):
195
"""See TreeEntry. This is a regular file in a working tree."""
197
def __eq__(self, other):
198
return (isinstance(other, TreeFile)
199
and other.__class__ == self.__class__)
201
def kind_character(self):
205
class TreeLink(TreeEntry):
206
"""See TreeEntry. This is a symlink in a working tree."""
208
def __eq__(self, other):
209
return (isinstance(other, TreeLink)
210
and other.__class__ == self.__class__)
212
def kind_character(self):
26
from errors import BzrCheckError
27
from trace import mutter
216
29
class WorkingTree(bzrlib.tree.Tree):
217
30
"""Working copy tree.
222
35
It is possible for a `WorkingTree` to have a filename which is
223
36
not listed in the Inventory and vice versa.
226
def __init__(self, basedir='.',
227
branch=DEPRECATED_PARAMETER,
233
"""Construct a WorkingTree for basedir.
235
If the branch is not supplied, it is opened automatically.
236
If the branch is supplied, it must be the branch for this basedir.
237
(branch.base is not cross checked, because for remote branches that
238
would be meaningless).
240
self._format = _format
241
self.bzrdir = _bzrdir
243
# not created via open etc.
244
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
245
"Please use bzrdir.open_workingtree or WorkingTree.open().",
248
wt = WorkingTree.open(basedir)
249
self._branch = wt.branch
250
self.basedir = wt.basedir
251
self._control_files = wt._control_files
252
self._hashcache = wt._hashcache
253
self._set_inventory(wt._inventory)
254
self._format = wt._format
255
self.bzrdir = wt.bzrdir
38
def __init__(self, basedir, inv):
256
39
from bzrlib.hashcache import HashCache
257
40
from bzrlib.trace import note, mutter
258
assert isinstance(basedir, basestring), \
259
"base directory %r is not a string" % basedir
260
basedir = safe_unicode(basedir)
261
mutter("opening working tree %r", basedir)
262
if deprecated_passed(branch):
264
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
265
" Please use bzrdir.open_workingtree() or"
266
" WorkingTree.open().",
270
self._branch = branch
272
self._branch = self.bzrdir.open_branch()
273
self.basedir = realpath(basedir)
274
# if branch is at our basedir and is a format 6 or less
275
if isinstance(self._format, WorkingTreeFormat2):
276
# share control object
277
self._control_files = self.branch.control_files
279
# assume all other formats have their own control files.
280
assert isinstance(_control_files, LockableFiles), \
281
"_control_files must be a LockableFiles, not %r" \
283
self._control_files = _control_files
43
self.basedir = basedir
44
self.path2id = inv.path2id
284
46
# update the whole cache up front and write to disk if anything changed;
285
47
# in the future we might want to do this more selectively
286
# two possible ways offer themselves : in self._unlock, write the cache
287
# if needed, or, when the cache sees a change, append it to the hash
288
# cache file, and have the parser take the most recent entry for a
290
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
291
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
48
hc = self._hashcache = HashCache(basedir)
293
# is this scan needed ? it makes things kinda slow.
296
52
if hc.needs_write:
297
53
mutter("write hc")
300
if _inventory is None:
301
self._set_inventory(self.read_working_inventory())
303
self._set_inventory(_inventory)
306
fget=lambda self: self._branch,
307
doc="""The branch this WorkingTree is connected to.
309
This cannot be set - it is reflective of the actual disk structure
310
the working tree has been constructed from.
313
def break_lock(self):
314
"""Break a lock if one is present from another instance.
316
Uses the ui factory to ask for confirmation if the lock may be from
319
This will probe the repository for its lock as well.
321
self._control_files.break_lock()
322
self.branch.break_lock()
324
def _set_inventory(self, inv):
325
self._inventory = inv
326
self.path2id = self._inventory.path2id
328
def is_control_filename(self, filename):
329
"""True if filename is the name of a control file in this tree.
331
:param filename: A filename within the tree. This is a relative path
332
from the root of this tree.
334
This is true IF and ONLY IF the filename is part of the meta data
335
that bzr controls in this tree. I.E. a random .bzr directory placed
336
on disk will not be a control file for this tree.
338
return self.bzrdir.is_control_filename(filename)
341
def open(path=None, _unsupported=False):
342
"""Open an existing working tree at path.
346
path = os.path.getcwdu()
347
control = bzrdir.BzrDir.open(path, _unsupported)
348
return control.open_workingtree(_unsupported)
351
def open_containing(path=None):
352
"""Open an existing working tree which has its root about path.
354
This probes for a working tree at path and searches upwards from there.
356
Basically we keep looking up until we find the control directory or
357
run into /. If there isn't one, raises NotBranchError.
358
TODO: give this a new exception.
359
If there is one, it is returned, along with the unused portion of path.
361
:return: The WorkingTree that contains 'path', and the rest of path
364
path = osutils.getcwd()
365
control, relpath = bzrdir.BzrDir.open_containing(path)
367
return control.open_workingtree(), relpath
370
def open_downlevel(path=None):
371
"""Open an unsupported working tree.
373
Only intended for advanced situations like upgrading part of a bzrdir.
375
return WorkingTree.open(path, _unsupported=True)
58
if self._hashcache.needs_write:
59
self._hashcache.write()
377
62
def __iter__(self):
378
63
"""Iterate through file_ids for this tree.
383
68
inv = self._inventory
384
69
for path, ie in inv.iter_entries():
385
if osutils.lexists(self.abspath(path)):
70
if os.path.exists(self.abspath(path)):
388
74
def __repr__(self):
389
75
return "<%s of %s>" % (self.__class__.__name__,
390
76
getattr(self, 'basedir', None))
392
80
def abspath(self, filename):
393
return pathjoin(self.basedir, filename)
395
def basis_tree(self):
396
"""Return RevisionTree for the current last revision."""
397
revision_id = self.last_revision()
398
if revision_id is not None:
400
xml = self.read_basis_inventory()
401
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
404
if inv is not None and inv.revision_id == revision_id:
405
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
407
# FIXME? RBC 20060403 should we cache the inventory here ?
408
return self.branch.repository.revision_tree(revision_id)
411
@deprecated_method(zero_eight)
412
def create(branch, directory):
413
"""Create a workingtree for branch at directory.
415
If existing_directory already exists it must have a .bzr directory.
416
If it does not exist, it will be created.
418
This returns a new WorkingTree object for the new checkout.
420
TODO FIXME RBC 20060124 when we have checkout formats in place this
421
should accept an optional revisionid to checkout [and reject this if
422
checking out into the same dir as a pre-checkout-aware branch format.]
424
XXX: When BzrDir is present, these should be created through that
427
warnings.warn('delete WorkingTree.create', stacklevel=3)
428
transport = get_transport(directory)
429
if branch.bzrdir.root_transport.base == transport.base:
431
return branch.bzrdir.create_workingtree()
432
# different directory,
433
# create a branch reference
434
# and now a working tree.
435
raise NotImplementedError
438
@deprecated_method(zero_eight)
439
def create_standalone(directory):
440
"""Create a checkout and a branch and a repo at directory.
442
Directory must exist and be empty.
444
please use BzrDir.create_standalone_workingtree
446
return bzrdir.BzrDir.create_standalone_workingtree(directory)
448
def relpath(self, path):
449
"""Return the local path portion from a given path.
451
The path may be absolute or relative. If its a relative path it is
452
interpreted relative to the python current working directory.
454
return relpath(self.basedir, path)
81
return os.path.join(self.basedir, filename)
456
83
def has_filename(self, filename):
457
return osutils.lexists(self.abspath(filename))
84
return os.path.exists(self.abspath(filename))
459
86
def get_file(self, file_id):
460
87
return self.get_file_byname(self.id2path(file_id))
462
def get_file_text(self, file_id):
463
return self.get_file(file_id).read()
465
89
def get_file_byname(self, filename):
466
90
return file(self.abspath(filename), 'rb')
468
def get_parent_ids(self):
469
"""See Tree.get_parent_ids.
471
This implementation reads the pending merges list and last_revision
472
value and uses that to decide what the parents list should be.
474
last_rev = self.last_revision()
479
other_parents = self.pending_merges()
480
return parents + other_parents
482
def get_root_id(self):
483
"""Return the id of this trees root"""
484
inv = self.read_working_inventory()
485
return inv.root.file_id
487
92
def _get_store_filename(self, file_id):
488
## XXX: badly named; this is not in the store at all
489
return self.abspath(self.id2path(file_id))
492
def clone(self, to_bzrdir, revision_id=None, basis=None):
493
"""Duplicate this working tree into to_bzr, including all state.
495
Specifically modified files are kept as modified, but
496
ignored and unknown files are discarded.
498
If you want to make a new line of development, see bzrdir.sprout()
501
If not None, the cloned tree will have its last revision set to
502
revision, and and difference between the source trees last revision
503
and this one merged in.
506
If not None, a closer copy of a tree which may have some files in
507
common, and which file content should be preferentially copied from.
509
# assumes the target bzr dir format is compatible.
510
result = self._format.initialize(to_bzrdir)
511
self.copy_content_into(result, revision_id)
515
def copy_content_into(self, tree, revision_id=None):
516
"""Copy the current content and user files of this tree into tree."""
517
if revision_id is None:
518
transform_tree(tree, self)
520
# TODO now merge from tree.last_revision to revision
521
transform_tree(tree, self)
522
tree.set_last_revision(revision_id)
525
def commit(self, message=None, revprops=None, *args, **kwargs):
526
# avoid circular imports
527
from bzrlib.commit import Commit
530
if not 'branch-nick' in revprops:
531
revprops['branch-nick'] = self.branch.nick
532
# args for wt.commit start at message from the Commit.commit method,
533
# but with branch a kwarg now, passing in args as is results in the
534
#message being used for the branch
535
args = (DEPRECATED_PARAMETER, message, ) + args
536
committed_id = Commit().commit( working_tree=self, revprops=revprops,
538
self._set_inventory(self.read_working_inventory())
541
def id2abspath(self, file_id):
542
return self.abspath(self.id2path(file_id))
93
## XXX: badly named; this isn't in the store at all
94
return self.abspath(self.id2path(file_id))
544
97
def has_id(self, file_id):
545
98
# files that have been deleted are excluded
546
99
inv = self._inventory
547
100
if not inv.has_id(file_id):
549
102
path = inv.id2path(file_id)
550
return osutils.lexists(self.abspath(path))
103
return os.path.exists(self.abspath(path))
552
def has_or_had_id(self, file_id):
553
if file_id == self.inventory.root.file_id:
555
return self.inventory.has_id(file_id)
557
106
__contains__ = has_id
559
109
def get_file_size(self, file_id):
560
return os.path.getsize(self.id2abspath(file_id))
563
def get_file_sha1(self, file_id, path=None):
565
path = self._inventory.id2path(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)
566
116
return self._hashcache.get_sha1(path)
568
def get_file_mtime(self, file_id, path=None):
570
path = self._inventory.id2path(file_id)
571
return os.lstat(self.abspath(path)).st_mtime
573
if not supports_executable():
574
def is_executable(self, file_id, path=None):
575
return self._inventory[file_id].executable
577
def is_executable(self, file_id, path=None):
579
path = self._inventory.id2path(file_id)
580
mode = os.lstat(self.abspath(path)).st_mode
581
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
584
def add(self, files, ids=None):
585
"""Make files versioned.
587
Note that the command line normally calls smart_add instead,
588
which can automatically recurse.
590
This adds the files to the inventory, so that they will be
591
recorded by the next commit.
594
List of paths to add, relative to the base of the tree.
597
If set, use these instead of automatically generated ids.
598
Must be the same length as the list of files, but may
599
contain None for ids that are to be autogenerated.
601
TODO: Perhaps have an option to add the ids even if the files do
604
TODO: Perhaps callback with the ids and paths as they're added.
606
# TODO: Re-adding a file that is removed in the working copy
607
# should probably put it back with the previous ID.
608
if isinstance(files, basestring):
609
assert(ids is None or isinstance(ids, basestring))
615
ids = [None] * len(files)
617
assert(len(ids) == len(files))
619
inv = self.read_working_inventory()
620
for f,file_id in zip(files, ids):
621
if self.is_control_filename(f):
622
raise errors.ForbiddenControlFileError(filename=f)
627
raise BzrError("cannot add top-level %r" % f)
629
fullpath = normpath(self.abspath(f))
631
kind = file_kind(fullpath)
633
if e.errno == errno.ENOENT:
634
raise NoSuchFile(fullpath)
635
if not InventoryEntry.versionable_kind(kind):
636
raise errors.BadFileKindError(filename=f, kind=kind)
638
inv.add_path(f, kind=kind)
640
inv.add_path(f, kind=kind, file_id=file_id)
642
self._write_inventory(inv)
645
def add_pending_merge(self, *revision_ids):
646
# TODO: Perhaps should check at this point that the
647
# history of the revision is actually present?
648
p = self.pending_merges()
650
for rev_id in revision_ids:
656
self.set_pending_merges(p)
659
def pending_merges(self):
660
"""Return a list of pending merges.
662
These are revisions that have been merged into the working
663
directory but not yet committed.
666
merges_file = self._control_files.get_utf8('pending-merges')
670
for l in merges_file.readlines():
671
p.append(l.rstrip('\n'))
675
def set_pending_merges(self, rev_list):
676
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
679
def set_merge_modified(self, modified_hashes):
681
for file_id, hash in modified_hashes.iteritems():
682
yield Stanza(file_id=file_id, hash=hash)
683
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
686
def _put_rio(self, filename, stanzas, header):
687
my_file = rio_file(stanzas, header)
688
self._control_files.put(filename, my_file)
691
def merge_modified(self):
693
hashfile = self._control_files.get('merge-hashes')
698
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
699
raise MergeModifiedFormatError()
700
except StopIteration:
701
raise MergeModifiedFormatError()
702
for s in RioReader(hashfile):
703
file_id = s.get("file_id")
704
if file_id not in self.inventory:
707
if hash == self.get_file_sha1(file_id):
708
merge_hashes[file_id] = hash
711
def get_symlink_target(self, file_id):
712
return os.readlink(self.id2abspath(file_id))
714
119
def file_class(self, filename):
715
120
if self.path2id(filename):
805
173
% (fap, f_ie.kind, f_ie.file_id, fk))
807
# make a last minute entry
809
yield fp[1:], c, fk, f_ie.file_id, f_ie
812
yield fp[1:], c, fk, None, fk_entries[fk]()
814
yield fp[1:], c, fk, None, TreeEntry()
175
yield fp, c, fk, (f_ie and f_ie.file_id)
817
177
if fk != 'directory':
820
# But do this child first
821
new_children = os.listdir(fap)
823
new_children = collections.deque(new_children)
824
stack.append((f_ie.file_id, fp, fap, new_children))
825
# Break out of inner loop, so that we start outer loop with child
828
# if we finished all children, pop it off the stack
833
def move(self, from_paths, to_name):
836
to_name must exist in the inventory.
838
If to_name exists and is a directory, the files are moved into
839
it, keeping their old names.
841
Note that to_name is only the last component of the new name;
842
this doesn't change the directory.
844
This returns a list of (from_path, to_path) pairs for each
848
## TODO: Option to move IDs only
849
assert not isinstance(from_paths, basestring)
851
to_abs = self.abspath(to_name)
852
if not isdir(to_abs):
853
raise BzrError("destination %r is not a directory" % to_abs)
854
if not self.has_filename(to_name):
855
raise BzrError("destination %r not in working directory" % to_abs)
856
to_dir_id = inv.path2id(to_name)
857
if to_dir_id == None and to_name != '':
858
raise BzrError("destination %r is not a versioned directory" % to_name)
859
to_dir_ie = inv[to_dir_id]
860
if to_dir_ie.kind not in ('directory', 'root_directory'):
861
raise BzrError("destination %r is not a directory" % to_abs)
863
to_idpath = inv.get_idpath(to_dir_id)
866
if not self.has_filename(f):
867
raise BzrError("%r does not exist in working tree" % f)
868
f_id = inv.path2id(f)
870
raise BzrError("%r is not versioned" % f)
871
name_tail = splitpath(f)[-1]
872
dest_path = pathjoin(to_name, name_tail)
873
if self.has_filename(dest_path):
874
raise BzrError("destination %r already exists" % dest_path)
875
if f_id in to_idpath:
876
raise BzrError("can't move %r to a subdirectory of itself" % f)
878
# OK, so there's a race here, it's possible that someone will
879
# create a file in this interval and then the rename might be
880
# left half-done. But we should have caught most problems.
881
orig_inv = deepcopy(self.inventory)
884
name_tail = splitpath(f)[-1]
885
dest_path = pathjoin(to_name, name_tail)
886
result.append((f, dest_path))
887
inv.rename(inv.path2id(f), to_dir_id, name_tail)
889
rename(self.abspath(f), self.abspath(dest_path))
891
raise BzrError("failed to rename %r to %r: %s" %
892
(f, dest_path, e[1]),
893
["rename rolled back"])
895
# restore the inventory on error
896
self._set_inventory(orig_inv)
898
self._write_inventory(inv)
902
def rename_one(self, from_rel, to_rel):
905
This can change the directory or the filename or both.
908
if not self.has_filename(from_rel):
909
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
910
if self.has_filename(to_rel):
911
raise BzrError("can't rename: new working file %r already exists" % to_rel)
913
file_id = inv.path2id(from_rel)
915
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
918
from_parent = entry.parent_id
919
from_name = entry.name
921
if inv.path2id(to_rel):
922
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
924
to_dir, to_tail = os.path.split(to_rel)
925
to_dir_id = inv.path2id(to_dir)
926
if to_dir_id == None and to_dir != '':
927
raise BzrError("can't determine destination directory id for %r" % to_dir)
929
mutter("rename_one:")
930
mutter(" file_id {%s}" % file_id)
931
mutter(" from_rel %r" % from_rel)
932
mutter(" to_rel %r" % to_rel)
933
mutter(" to_dir %r" % to_dir)
934
mutter(" to_dir_id {%s}" % to_dir_id)
936
inv.rename(file_id, to_dir_id, to_tail)
938
from_abs = self.abspath(from_rel)
939
to_abs = self.abspath(to_rel)
941
rename(from_abs, to_abs)
943
inv.rename(file_id, from_parent, from_name)
944
raise BzrError("failed to rename %r to %r: %s"
945
% (from_abs, to_abs, e[1]),
946
["rename rolled back"])
947
self._write_inventory(inv)
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):
950
192
def unknowns(self):
951
"""Return all unknown files.
953
These are files in the working directory that are not versioned or
954
control files or ignored.
956
193
for subp in self.extras():
957
194
if not self.is_ignored(subp):
960
@deprecated_method(zero_eight)
961
def iter_conflicts(self):
962
"""List all files in the tree that have text or content conflicts.
963
DEPRECATED. Use conflicts instead."""
964
return self._iter_conflicts()
966
def _iter_conflicts(self):
968
for info in self.list_files():
970
stem = get_conflicted_stem(path)
973
if stem not in conflicted:
978
def pull(self, source, overwrite=False, stop_revision=None):
979
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
982
pp = ProgressPhase("Pull phase", 2, top_pb)
984
old_revision_history = self.branch.revision_history()
985
basis_tree = self.basis_tree()
986
count = self.branch.pull(source, overwrite, stop_revision)
987
new_revision_history = self.branch.revision_history()
988
if new_revision_history != old_revision_history:
990
if len(old_revision_history):
991
other_revision = old_revision_history[-1]
993
other_revision = None
994
repository = self.branch.repository
995
pb = bzrlib.ui.ui_factory.nested_progress_bar()
997
merge_inner(self.branch,
998
self.branch.basis_tree(),
1004
self.set_last_revision(self.branch.last_revision())
1010
198
def extras(self):
1011
199
"""Yield all unknown files in this WorkingTree.
1156
268
# treat dotfiles correctly and allows * to match /.
1157
269
# Eventually it should be replaced with something more
1160
rules = self._get_ignore_rules_as_regex()
1161
for regex, mapping in rules:
1162
match = regex.match(filename)
1163
if match is not None:
1164
# one or more of the groups in mapping will have a non-None group
1166
groups = match.groups()
1167
rules = [mapping[group] for group in
1168
mapping if groups[group] is not None]
1172
def kind(self, file_id):
1173
return file_kind(self.id2abspath(file_id))
1176
def last_revision(self):
1177
"""Return the last revision id of this working tree.
1179
In early branch formats this was == the branch last_revision,
1180
but that cannot be relied upon - for working tree operations,
1181
always use tree.last_revision().
1183
return self.branch.last_revision()
1185
def is_locked(self):
1186
return self._control_files.is_locked()
1188
def lock_read(self):
1189
"""See Branch.lock_read, and WorkingTree.unlock."""
1190
self.branch.lock_read()
1192
return self._control_files.lock_read()
1194
self.branch.unlock()
1197
def lock_write(self):
1198
"""See Branch.lock_write, and WorkingTree.unlock."""
1199
self.branch.lock_write()
1201
return self._control_files.lock_write()
1203
self.branch.unlock()
1206
def get_physical_lock_status(self):
1207
return self._control_files.get_physical_lock_status()
1209
def _basis_inventory_name(self):
1210
return 'basis-inventory'
1213
def set_last_revision(self, new_revision):
1214
"""Change the last revision in the working tree."""
1215
if self._change_last_revision(new_revision):
1216
self._cache_basis_inventory(new_revision)
1218
def _change_last_revision(self, new_revision):
1219
"""Template method part of set_last_revision to perform the change.
1221
This is used to allow WorkingTree3 instances to not affect branch
1222
when their last revision is set.
1224
if new_revision is None:
1225
self.branch.set_revision_history([])
1227
# current format is locked in with the branch
1228
revision_history = self.branch.revision_history()
1230
position = revision_history.index(new_revision)
1232
raise errors.NoSuchRevision(self.branch, new_revision)
1233
self.branch.set_revision_history(revision_history[:position + 1])
1236
def _cache_basis_inventory(self, new_revision):
1237
"""Cache new_revision as the basis inventory."""
1238
# TODO: this should allow the ready-to-use inventory to be passed in,
1239
# as commit already has that ready-to-use [while the format is the
1242
# this double handles the inventory - unpack and repack -
1243
# but is easier to understand. We can/should put a conditional
1244
# in here based on whether the inventory is in the latest format
1245
# - perhaps we should repack all inventories on a repository
1247
# the fast path is to copy the raw xml from the repository. If the
1248
# xml contains 'revision_id="', then we assume the right
1249
# revision_id is set. We must check for this full string, because a
1250
# root node id can legitimately look like 'revision_id' but cannot
1252
xml = self.branch.repository.get_inventory_xml(new_revision)
1253
if not 'revision_id="' in xml.split('\n', 1)[0]:
1254
inv = self.branch.repository.deserialise_inventory(
1256
inv.revision_id = new_revision
1257
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1258
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1259
path = self._basis_inventory_name()
1261
self._control_files.put(path, sio)
1262
except WeaveRevisionNotPresent:
1265
def read_basis_inventory(self):
1266
"""Read the cached basis inventory."""
1267
path = self._basis_inventory_name()
1268
return self._control_files.get(path).read()
1271
def read_working_inventory(self):
1272
"""Read the working inventory."""
1273
# ElementTree does its own conversion from UTF-8, so open in
1275
result = bzrlib.xml5.serializer_v5.read_inventory(
1276
self._control_files.get('inventory'))
1277
self._set_inventory(result)
1281
def remove(self, files, verbose=False, to_file=None):
1282
"""Remove nominated files from the working inventory..
1284
This does not remove their text. This does not run on XXX on what? RBC
1286
TODO: Refuse to remove modified files unless --force is given?
1288
TODO: Do something useful with directories.
1290
TODO: Should this remove the text or not? Tough call; not
1291
removing may be useful and the user can just use use rm, and
1292
is the opposite of add. Removing it is consistent with most
1293
other tools. Maybe an option.
1295
## TODO: Normalize names
1296
## TODO: Remove nested loops; better scalability
1297
if isinstance(files, basestring):
1300
inv = self.inventory
1302
# do this before any modifications
1304
fid = inv.path2id(f)
1306
# TODO: Perhaps make this just a warning, and continue?
1307
# This tends to happen when
1308
raise NotVersionedError(path=f)
1310
# having remove it, it must be either ignored or unknown
1311
if self.is_ignored(f):
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] == '.\\'):
1315
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1318
self._write_inventory(inv)
1321
def revert(self, filenames, old_tree=None, backups=True,
1322
pb=DummyProgress()):
1323
from transform import revert
1324
from conflicts import resolve
1325
if old_tree is None:
1326
old_tree = self.basis_tree()
1327
conflicts = revert(self, old_tree, filenames, backups, pb)
1328
if not len(filenames):
1329
self.set_pending_merges([])
286
if fnmatch.fnmatchcase(filename, newpat):
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1332
resolve(self, filenames, ignore_misses=True)
1335
# XXX: This method should be deprecated in favour of taking in a proper
1336
# new Inventory object.
1338
def set_inventory(self, new_inventory_list):
1339
from bzrlib.inventory import (Inventory,
1344
inv = Inventory(self.get_root_id())
1345
for path, file_id, parent, kind in new_inventory_list:
1346
name = os.path.basename(path)
1349
# fixme, there should be a factory function inv,add_??
1350
if kind == 'directory':
1351
inv.add(InventoryDirectory(file_id, name, parent))
1352
elif kind == 'file':
1353
inv.add(InventoryFile(file_id, name, parent))
1354
elif kind == 'symlink':
1355
inv.add(InventoryLink(file_id, name, parent))
1357
raise BzrError("unknown kind %r" % kind)
1358
self._write_inventory(inv)
1361
def set_root_id(self, file_id):
1362
"""Set the root id for this tree."""
1363
inv = self.read_working_inventory()
1364
orig_root_id = inv.root.file_id
1365
del inv._byid[inv.root.file_id]
1366
inv.root.file_id = file_id
1367
inv._byid[inv.root.file_id] = inv.root
1370
if entry.parent_id == orig_root_id:
1371
entry.parent_id = inv.root.file_id
1372
self._write_inventory(inv)
1375
"""See Branch.unlock.
1377
WorkingTree locking just uses the Branch locking facilities.
1378
This is current because all working trees have an embedded branch
1379
within them. IF in the future, we were to make branch data shareable
1380
between multiple working trees, i.e. via shared storage, then we
1381
would probably want to lock both the local tree, and the branch.
1383
raise NotImplementedError(self.unlock)
1387
"""Update a working tree along its branch.
1389
This will update the branch if its bound too, which means we have multiple trees involved:
1390
The new basis tree of the master.
1391
The old basis tree of the branch.
1392
The old basis tree of the working tree.
1393
The current working tree state.
1394
pathologically all three may be different, and non ancestors of each other.
1395
Conceptually we want to:
1396
Preserve the wt.basis->wt.state changes
1397
Transform the wt.basis to the new master basis.
1398
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1399
Restore the wt.basis->wt.state changes.
1401
There isn't a single operation at the moment to do that, so we:
1402
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1403
Do a 'normal' merge of the old branch basis if it is relevant.
1405
old_tip = self.branch.update()
1406
if old_tip is not None:
1407
self.add_pending_merge(old_tip)
1408
self.branch.lock_read()
1411
if self.last_revision() != self.branch.last_revision():
1412
# merge tree state up to new branch tip.
1413
basis = self.basis_tree()
1414
to_tree = self.branch.basis_tree()
1415
result += merge_inner(self.branch,
1419
self.set_last_revision(self.branch.last_revision())
1420
if old_tip and old_tip != self.last_revision():
1421
# our last revision was not the prior branch last revision
1422
# and we have converted that last revision to a pending merge.
1423
# base is somewhere between the branch tip now
1424
# and the now pending merge
1425
from bzrlib.revision import common_ancestor
1427
base_rev_id = common_ancestor(self.branch.last_revision(),
1429
self.branch.repository)
1430
except errors.NoCommonAncestor:
1432
base_tree = self.branch.repository.revision_tree(base_rev_id)
1433
other_tree = self.branch.repository.revision_tree(old_tip)
1434
result += merge_inner(self.branch,
1440
self.branch.unlock()
1443
def _write_inventory(self, inv):
1444
"""Write inventory as the current inventory."""
1446
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1448
self._control_files.put('inventory', sio)
1449
self._set_inventory(inv)
1450
mutter('wrote working inventory')
1452
def set_conflicts(self, arg):
1453
raise UnsupportedOperation(self.set_conflicts, self)
1455
def add_conflicts(self, arg):
1456
raise UnsupportedOperation(self.add_conflicts, self)
1459
def conflicts(self):
1460
conflicts = ConflictList()
1461
for conflicted in self._iter_conflicts():
1464
if file_kind(self.abspath(conflicted)) != "file":
1466
except errors.NoSuchFile:
1469
for suffix in ('.THIS', '.OTHER'):
1471
kind = file_kind(self.abspath(conflicted+suffix))
1474
except errors.NoSuchFile:
1478
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1479
conflicts.append(Conflict.factory(ctype, path=conflicted,
1480
file_id=self.path2id(conflicted)))
1484
class WorkingTree2(WorkingTree):
1485
"""This is the Format 2 working tree.
1487
This was the first weave based working tree.
1488
- uses os locks for locking.
1489
- uses the branch last-revision.
1493
# we share control files:
1494
if self._hashcache.needs_write and self._control_files._lock_count==3:
1495
self._hashcache.write()
1496
# reverse order of locking.
1498
return self._control_files.unlock()
1500
self.branch.unlock()
1503
class WorkingTree3(WorkingTree):
1504
"""This is the Format 3 working tree.
1506
This differs from the base WorkingTree by:
1507
- having its own file lock
1508
- having its own last-revision property.
1510
This is new in bzr 0.8
1514
def last_revision(self):
1515
"""See WorkingTree.last_revision."""
1517
return self._control_files.get_utf8('last-revision').read()
1521
def _change_last_revision(self, revision_id):
1522
"""See WorkingTree._change_last_revision."""
1523
if revision_id is None or revision_id == NULL_REVISION:
1525
self._control_files._transport.delete('last-revision')
1526
except errors.NoSuchFile:
1531
self.branch.revision_history().index(revision_id)
1533
raise errors.NoSuchRevision(self.branch, revision_id)
1534
self._control_files.put_utf8('last-revision', revision_id)
1538
def set_conflicts(self, conflicts):
1539
self._put_rio('conflicts', conflicts.to_stanzas(),
1543
def add_conflicts(self, new_conflicts):
1544
conflict_set = set(self.conflicts())
1545
conflict_set.update(set(list(new_conflicts)))
1546
self.set_conflicts(ConflictList(sorted(conflict_set,
1547
key=Conflict.sort_key)))
1550
def conflicts(self):
1552
confile = self._control_files.get('conflicts')
1554
return ConflictList()
1556
if confile.next() != CONFLICT_HEADER_1 + '\n':
1557
raise ConflictFormatError()
1558
except StopIteration:
1559
raise ConflictFormatError()
1560
return ConflictList.from_stanzas(RioReader(confile))
1563
if self._hashcache.needs_write and self._control_files._lock_count==1:
1564
self._hashcache.write()
1565
# reverse order of locking.
1567
return self._control_files.unlock()
1569
self.branch.unlock()
1572
def get_conflicted_stem(path):
1573
for suffix in CONFLICT_SUFFIXES:
1574
if path.endswith(suffix):
1575
return path[:-len(suffix)]
1577
@deprecated_function(zero_eight)
1578
def is_control_file(filename):
1579
"""See WorkingTree.is_control_filename(filename)."""
1580
## FIXME: better check
1581
filename = normpath(filename)
1582
while filename != '':
1583
head, tail = os.path.split(filename)
1584
## mutter('check %r for control file' % ((head, tail),))
1587
if filename == head:
1593
class WorkingTreeFormat(object):
1594
"""An encapsulation of the initialization and open routines for a format.
1596
Formats provide three things:
1597
* An initialization routine,
1601
Formats are placed in an dict by their format string for reference
1602
during workingtree opening. Its not required that these be instances, they
1603
can be classes themselves with class methods - it simply depends on
1604
whether state is needed for a given format or not.
1606
Once a format is deprecated, just deprecate the initialize and open
1607
methods on the format class. Do not deprecate the object, as the
1608
object will be created every time regardless.
1611
_default_format = None
1612
"""The default format used for new trees."""
1615
"""The known formats."""
1618
def find_format(klass, a_bzrdir):
1619
"""Return the format for the working tree object in a_bzrdir."""
1621
transport = a_bzrdir.get_workingtree_transport(None)
1622
format_string = transport.get("format").read()
1623
return klass._formats[format_string]
1625
raise errors.NoWorkingTree(base=transport.base)
1627
raise errors.UnknownFormatError(format=format_string)
1630
def get_default_format(klass):
1631
"""Return the current default format."""
1632
return klass._default_format
1634
def get_format_string(self):
1635
"""Return the ASCII format string that identifies this format."""
1636
raise NotImplementedError(self.get_format_string)
1638
def get_format_description(self):
1639
"""Return the short description for this format."""
1640
raise NotImplementedError(self.get_format_description)
1642
def is_supported(self):
1643
"""Is this format supported?
1645
Supported formats can be initialized and opened.
1646
Unsupported formats may not support initialization or committing or
1647
some other features depending on the reason for not being supported.
1652
def register_format(klass, format):
1653
klass._formats[format.get_format_string()] = format
1656
def set_default_format(klass, format):
1657
klass._default_format = format
1660
def unregister_format(klass, format):
1661
assert klass._formats[format.get_format_string()] is format
1662
del klass._formats[format.get_format_string()]
1666
class WorkingTreeFormat2(WorkingTreeFormat):
1667
"""The second working tree format.
1669
This format modified the hash cache from the format 1 hash cache.
1672
def get_format_description(self):
1673
"""See WorkingTreeFormat.get_format_description()."""
1674
return "Working tree format 2"
1676
def stub_initialize_remote(self, control_files):
1677
"""As a special workaround create critical control files for a remote working tree
1679
This ensures that it can later be updated and dealt with locally,
1680
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1681
no working tree. (See bug #43064).
1685
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1687
control_files.put('inventory', sio)
1689
control_files.put_utf8('pending-merges', '')
1692
def initialize(self, a_bzrdir, revision_id=None):
1693
"""See WorkingTreeFormat.initialize()."""
1694
if not isinstance(a_bzrdir.transport, LocalTransport):
1695
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1696
branch = a_bzrdir.open_branch()
1697
if revision_id is not None:
1700
revision_history = branch.revision_history()
1702
position = revision_history.index(revision_id)
1704
raise errors.NoSuchRevision(branch, revision_id)
1705
branch.set_revision_history(revision_history[:position + 1])
1708
revision = branch.last_revision()
1710
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1716
wt._write_inventory(inv)
1717
wt.set_root_id(inv.root.file_id)
1718
wt.set_last_revision(revision)
1719
wt.set_pending_merges([])
1720
build_tree(wt.basis_tree(), wt)
1724
super(WorkingTreeFormat2, self).__init__()
1725
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1727
def open(self, a_bzrdir, _found=False):
1728
"""Return the WorkingTree object for a_bzrdir
1730
_found is a private parameter, do not use it. It is used to indicate
1731
if format probing has already been done.
1734
# we are being called directly and must probe.
1735
raise NotImplementedError
1736
if not isinstance(a_bzrdir.transport, LocalTransport):
1737
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1738
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1744
class WorkingTreeFormat3(WorkingTreeFormat):
1745
"""The second working tree format updated to record a format marker.
1748
- exists within a metadir controlling .bzr
1749
- includes an explicit version marker for the workingtree control
1750
files, separate from the BzrDir format
1751
- modifies the hash cache format
1753
- uses a LockDir to guard access for writes.
1756
def get_format_string(self):
1757
"""See WorkingTreeFormat.get_format_string()."""
1758
return "Bazaar-NG Working Tree format 3"
1760
def get_format_description(self):
1761
"""See WorkingTreeFormat.get_format_description()."""
1762
return "Working tree format 3"
1764
_lock_file_name = 'lock'
1765
_lock_class = LockDir
1767
def _open_control_files(self, a_bzrdir):
1768
transport = a_bzrdir.get_workingtree_transport(None)
1769
return LockableFiles(transport, self._lock_file_name,
1772
def initialize(self, a_bzrdir, revision_id=None):
1773
"""See WorkingTreeFormat.initialize().
1775
revision_id allows creating a working tree at a different
1776
revision than the branch is at.
1778
if not isinstance(a_bzrdir.transport, LocalTransport):
1779
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1780
transport = a_bzrdir.get_workingtree_transport(self)
1781
control_files = self._open_control_files(a_bzrdir)
1782
control_files.create_lock()
1783
control_files.lock_write()
1784
control_files.put_utf8('format', self.get_format_string())
1785
branch = a_bzrdir.open_branch()
1786
if revision_id is None:
1787
revision_id = branch.last_revision()
1789
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1795
_control_files=control_files)
1798
wt._write_inventory(inv)
1799
wt.set_root_id(inv.root.file_id)
1800
wt.set_last_revision(revision_id)
1801
wt.set_pending_merges([])
1802
build_tree(wt.basis_tree(), wt)
1805
control_files.unlock()
1809
super(WorkingTreeFormat3, self).__init__()
1810
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1812
def open(self, a_bzrdir, _found=False):
1813
"""Return the WorkingTree object for a_bzrdir
1815
_found is a private parameter, do not use it. It is used to indicate
1816
if format probing has already been done.
1819
# we are being called directly and must probe.
1820
raise NotImplementedError
1821
if not isinstance(a_bzrdir.transport, LocalTransport):
1822
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1823
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1825
def _open(self, a_bzrdir, control_files):
1826
"""Open the tree itself.
1828
:param a_bzrdir: the dir for the tree.
1829
:param control_files: the control files for the tree.
1831
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1835
_control_files=control_files)
1838
return self.get_format_string()
1841
# formats which have no format string are not discoverable
1842
# and not independently creatable, so are not registered.
1843
__default_format = WorkingTreeFormat3()
1844
WorkingTreeFormat.register_format(__default_format)
1845
WorkingTreeFormat.set_default_format(__default_format)
1846
_legacy_formats = [WorkingTreeFormat2(),
1850
class WorkingTreeTestProviderAdapter(object):
1851
"""A tool to generate a suite testing multiple workingtree formats at once.
1853
This is done by copying the test once for each transport and injecting
1854
the transport_server, transport_readonly_server, and workingtree_format
1855
classes into each copy. Each copy is also given a new id() to make it
1859
def __init__(self, transport_server, transport_readonly_server, formats):
1860
self._transport_server = transport_server
1861
self._transport_readonly_server = transport_readonly_server
1862
self._formats = formats
1864
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
1865
"""Clone test for adaption."""
1866
new_test = deepcopy(test)
1867
new_test.transport_server = self._transport_server
1868
new_test.transport_readonly_server = self._transport_readonly_server
1869
new_test.bzrdir_format = bzrdir_format
1870
new_test.workingtree_format = workingtree_format
1871
def make_new_test_id():
1872
new_id = "%s(%s)" % (test.id(), variation)
1873
return lambda: new_id
1874
new_test.id = make_new_test_id()
1877
def adapt(self, test):
1878
from bzrlib.tests import TestSuite
1879
result = TestSuite()
1880
for workingtree_format, bzrdir_format in self._formats:
1881
new_test = self._clone_test(
1884
workingtree_format, workingtree_format.__class__.__name__)
1885
result.addTest(new_test)
b'\\ No newline at end of file'
added
removed
bzrlib/workingtree.py
