1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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"
34
# TODO: Give the workingtree sole responsibility for the working inventory;
35
# remove the variable and references to it from the branch. This may require
36
# updating the commit code so as to update the inventory within the working
37
# copy, and making sure there's only one WorkingTree for any directory on disk.
38
# At the moment they may alias the inventory and have old copies of it in
39
# memory. (Now done? -- mbp 20060309)
41
from copy import deepcopy
42
from cStringIO import StringIO
49
from bzrlib.atomicfile import AtomicFile
50
from bzrlib.branch import (Branch,
52
import bzrlib.bzrdir as bzrdir
53
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
import bzrlib.errors as errors
55
from bzrlib.errors import (BzrCheckError,
58
WeaveRevisionNotPresent,
62
MergeModifiedFormatError)
63
from bzrlib.inventory import InventoryEntry, Inventory
64
from bzrlib.lockable_files import LockableFiles, TransportLock
65
from bzrlib.lockdir import LockDir
66
from bzrlib.merge import merge_inner, transform_tree
67
from bzrlib.osutils import (
85
from bzrlib.progress import DummyProgress, ProgressPhase
86
from bzrlib.revision import NULL_REVISION
87
from bzrlib.rio import RioReader, RioWriter, Stanza
88
from bzrlib.symbol_versioning import *
89
from bzrlib.textui import show_status
91
from bzrlib.transform import build_tree
92
from bzrlib.trace import mutter, note
93
from bzrlib.transport import get_transport
94
from bzrlib.transport.local import LocalTransport
99
def gen_file_id(name):
100
"""Return new file id.
102
This should probably generate proper UUIDs, but for the moment we
103
cope with just randomness because running uuidgen every time is
106
from binascii import hexlify
107
from time import time
110
idx = name.rfind('/')
112
name = name[idx+1 : ]
113
idx = name.rfind('\\')
115
name = name[idx+1 : ]
117
# make it not a hidden file
118
name = name.lstrip('.')
120
# remove any wierd characters; we don't escape them but rather
122
name = re.sub(r'[^\w.]', '', name)
124
s = hexlify(rand_bytes(8))
125
return '-'.join((name, compact_date(time()), s))
129
"""Return a new tree-root file id."""
130
return gen_file_id('TREE_ROOT')
133
class TreeEntry(object):
134
"""An entry that implements the minium interface used by commands.
136
This needs further inspection, it may be better to have
137
InventoryEntries without ids - though that seems wrong. For now,
138
this is a parallel hierarchy to InventoryEntry, and needs to become
139
one of several things: decorates to that hierarchy, children of, or
141
Another note is that these objects are currently only used when there is
142
no InventoryEntry available - i.e. for unversioned objects.
143
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
146
def __eq__(self, other):
147
# yes, this us ugly, TODO: best practice __eq__ style.
148
return (isinstance(other, TreeEntry)
149
and other.__class__ == self.__class__)
151
def kind_character(self):
155
class TreeDirectory(TreeEntry):
156
"""See TreeEntry. This is a directory in a working tree."""
158
def __eq__(self, other):
159
return (isinstance(other, TreeDirectory)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeFile(TreeEntry):
167
"""See TreeEntry. This is a regular file in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeFile)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeLink(TreeEntry):
178
"""See TreeEntry. This is a symlink in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeLink)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class WorkingTree(bzrlib.tree.Tree):
189
"""Working copy tree.
191
The inventory is held in the `Branch` working-inventory, and the
192
files are in a directory on disk.
194
It is possible for a `WorkingTree` to have a filename which is
195
not listed in the Inventory and vice versa.
198
def __init__(self, basedir='.',
199
branch=DEPRECATED_PARAMETER,
205
"""Construct a WorkingTree for basedir.
207
If the branch is not supplied, it is opened automatically.
208
If the branch is supplied, it must be the branch for this basedir.
209
(branch.base is not cross checked, because for remote branches that
210
would be meaningless).
212
self._format = _format
213
self.bzrdir = _bzrdir
215
# not created via open etc.
216
warn("WorkingTree() is deprecated as of bzr version 0.8. "
217
"Please use bzrdir.open_workingtree or WorkingTree.open().",
220
wt = WorkingTree.open(basedir)
221
self.branch = wt.branch
222
self.basedir = wt.basedir
223
self._control_files = wt._control_files
224
self._hashcache = wt._hashcache
225
self._set_inventory(wt._inventory)
226
self._format = wt._format
227
self.bzrdir = wt.bzrdir
228
from bzrlib.hashcache import HashCache
229
from bzrlib.trace import note, mutter
230
assert isinstance(basedir, basestring), \
231
"base directory %r is not a string" % basedir
232
basedir = safe_unicode(basedir)
233
mutter("opening working tree %r", basedir)
234
if deprecated_passed(branch):
236
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
237
" Please use bzrdir.open_workingtree() or WorkingTree.open().",
243
self.branch = self.bzrdir.open_branch()
244
assert isinstance(self.branch, Branch), \
245
"branch %r is not a Branch" % self.branch
246
self.basedir = realpath(basedir)
247
# if branch is at our basedir and is a format 6 or less
248
if isinstance(self._format, WorkingTreeFormat2):
249
# share control object
250
self._control_files = self.branch.control_files
252
# only ready for format 3
253
assert isinstance(self._format, WorkingTreeFormat3)
254
assert isinstance(_control_files, LockableFiles), \
255
"_control_files must be a LockableFiles, not %r" \
257
self._control_files = _control_files
258
# update the whole cache up front and write to disk if anything changed;
259
# in the future we might want to do this more selectively
260
# two possible ways offer themselves : in self._unlock, write the cache
261
# if needed, or, when the cache sees a change, append it to the hash
262
# cache file, and have the parser take the most recent entry for a
264
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
265
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
267
# is this scan needed ? it makes things kinda slow.
274
if _inventory is None:
275
self._set_inventory(self.read_working_inventory())
277
self._set_inventory(_inventory)
279
def _set_inventory(self, inv):
280
self._inventory = inv
281
self.path2id = self._inventory.path2id
283
def is_control_filename(self, filename):
284
"""True if filename is the name of a control file in this tree.
286
This is true IF and ONLY IF the filename is part of the meta data
287
that bzr controls in this tree. I.E. a random .bzr directory placed
288
on disk will not be a control file for this tree.
291
self.bzrdir.transport.relpath(self.abspath(filename))
293
except errors.PathNotChild:
297
def open(path=None, _unsupported=False):
298
"""Open an existing working tree at path.
302
path = os.path.getcwdu()
303
control = bzrdir.BzrDir.open(path, _unsupported)
304
return control.open_workingtree(_unsupported)
307
def open_containing(path=None):
308
"""Open an existing working tree which has its root about path.
310
This probes for a working tree at path and searches upwards from there.
312
Basically we keep looking up until we find the control directory or
313
run into /. If there isn't one, raises NotBranchError.
314
TODO: give this a new exception.
315
If there is one, it is returned, along with the unused portion of path.
319
control, relpath = bzrdir.BzrDir.open_containing(path)
320
return control.open_workingtree(), relpath
323
def open_downlevel(path=None):
324
"""Open an unsupported working tree.
326
Only intended for advanced situations like upgrading part of a bzrdir.
328
return WorkingTree.open(path, _unsupported=True)
331
"""Iterate through file_ids for this tree.
333
file_ids are in a WorkingTree if they are in the working inventory
334
and the working file exists.
336
inv = self._inventory
337
for path, ie in inv.iter_entries():
338
if bzrlib.osutils.lexists(self.abspath(path)):
342
return "<%s of %s>" % (self.__class__.__name__,
343
getattr(self, 'basedir', None))
345
def abspath(self, filename):
346
return pathjoin(self.basedir, filename)
348
def basis_tree(self):
349
"""Return RevisionTree for the current last revision."""
350
revision_id = self.last_revision()
351
if revision_id is not None:
353
xml = self.read_basis_inventory(revision_id)
354
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
355
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
359
return self.branch.repository.revision_tree(revision_id)
362
@deprecated_method(zero_eight)
363
def create(branch, directory):
364
"""Create a workingtree for branch at directory.
366
If existing_directory already exists it must have a .bzr directory.
367
If it does not exist, it will be created.
369
This returns a new WorkingTree object for the new checkout.
371
TODO FIXME RBC 20060124 when we have checkout formats in place this
372
should accept an optional revisionid to checkout [and reject this if
373
checking out into the same dir as a pre-checkout-aware branch format.]
375
XXX: When BzrDir is present, these should be created through that
378
warn('delete WorkingTree.create', stacklevel=3)
379
transport = get_transport(directory)
380
if branch.bzrdir.root_transport.base == transport.base:
382
return branch.bzrdir.create_workingtree()
383
# different directory,
384
# create a branch reference
385
# and now a working tree.
386
raise NotImplementedError
389
@deprecated_method(zero_eight)
390
def create_standalone(directory):
391
"""Create a checkout and a branch and a repo at directory.
393
Directory must exist and be empty.
395
please use BzrDir.create_standalone_workingtree
397
return bzrdir.BzrDir.create_standalone_workingtree(directory)
399
def relpath(self, abs):
400
"""Return the local path portion from a given absolute path."""
401
return relpath(self.basedir, abs)
403
def has_filename(self, filename):
404
return bzrlib.osutils.lexists(self.abspath(filename))
406
def get_file(self, file_id):
407
return self.get_file_byname(self.id2path(file_id))
409
def get_file_byname(self, filename):
410
return file(self.abspath(filename), 'rb')
412
def get_root_id(self):
413
"""Return the id of this trees root"""
414
inv = self.read_working_inventory()
415
return inv.root.file_id
417
def _get_store_filename(self, file_id):
418
## XXX: badly named; this is not in the store at all
419
return self.abspath(self.id2path(file_id))
422
def clone(self, to_bzrdir, revision_id=None, basis=None):
423
"""Duplicate this working tree into to_bzr, including all state.
425
Specifically modified files are kept as modified, but
426
ignored and unknown files are discarded.
428
If you want to make a new line of development, see bzrdir.sprout()
431
If not None, the cloned tree will have its last revision set to
432
revision, and and difference between the source trees last revision
433
and this one merged in.
436
If not None, a closer copy of a tree which may have some files in
437
common, and which file content should be preferentially copied from.
439
# assumes the target bzr dir format is compatible.
440
result = self._format.initialize(to_bzrdir)
441
self.copy_content_into(result, revision_id)
445
def copy_content_into(self, tree, revision_id=None):
446
"""Copy the current content and user files of this tree into tree."""
447
if revision_id is None:
448
transform_tree(tree, self)
450
# TODO now merge from tree.last_revision to revision
451
transform_tree(tree, self)
452
tree.set_last_revision(revision_id)
455
def commit(self, message=None, revprops=None, *args, **kwargs):
456
# avoid circular imports
457
from bzrlib.commit import Commit
460
if not 'branch-nick' in revprops:
461
revprops['branch-nick'] = self.branch.nick
462
# args for wt.commit start at message from the Commit.commit method,
463
# but with branch a kwarg now, passing in args as is results in the
464
#message being used for the branch
465
args = (DEPRECATED_PARAMETER, message, ) + args
466
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
467
self._set_inventory(self.read_working_inventory())
469
def id2abspath(self, file_id):
470
return self.abspath(self.id2path(file_id))
472
def has_id(self, file_id):
473
# files that have been deleted are excluded
474
inv = self._inventory
475
if not inv.has_id(file_id):
477
path = inv.id2path(file_id)
478
return bzrlib.osutils.lexists(self.abspath(path))
480
def has_or_had_id(self, file_id):
481
if file_id == self.inventory.root.file_id:
483
return self.inventory.has_id(file_id)
485
__contains__ = has_id
487
def get_file_size(self, file_id):
488
return os.path.getsize(self.id2abspath(file_id))
491
def get_file_sha1(self, file_id):
492
path = self._inventory.id2path(file_id)
493
return self._hashcache.get_sha1(path)
495
def is_executable(self, file_id):
496
if not supports_executable():
497
return self._inventory[file_id].executable
499
path = self._inventory.id2path(file_id)
500
mode = os.lstat(self.abspath(path)).st_mode
501
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
504
def add(self, files, ids=None):
505
"""Make files versioned.
507
Note that the command line normally calls smart_add instead,
508
which can automatically recurse.
510
This adds the files to the inventory, so that they will be
511
recorded by the next commit.
514
List of paths to add, relative to the base of the tree.
517
If set, use these instead of automatically generated ids.
518
Must be the same length as the list of files, but may
519
contain None for ids that are to be autogenerated.
521
TODO: Perhaps have an option to add the ids even if the files do
524
TODO: Perhaps callback with the ids and paths as they're added.
526
# TODO: Re-adding a file that is removed in the working copy
527
# should probably put it back with the previous ID.
528
if isinstance(files, basestring):
529
assert(ids is None or isinstance(ids, basestring))
535
ids = [None] * len(files)
537
assert(len(ids) == len(files))
539
inv = self.read_working_inventory()
540
for f,file_id in zip(files, ids):
541
if self.is_control_filename(f):
542
raise BzrError("cannot add control file %s" % quotefn(f))
547
raise BzrError("cannot add top-level %r" % f)
549
fullpath = normpath(self.abspath(f))
552
kind = file_kind(fullpath)
554
if e.errno == errno.ENOENT:
555
raise NoSuchFile(fullpath)
556
# maybe something better?
557
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
559
if not InventoryEntry.versionable_kind(kind):
560
raise BzrError('cannot add: not a versionable file ('
561
'i.e. regular file, symlink or directory): %s' % quotefn(f))
564
file_id = gen_file_id(f)
565
inv.add_path(f, kind=kind, file_id=file_id)
567
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
568
self._write_inventory(inv)
571
def add_pending_merge(self, *revision_ids):
572
# TODO: Perhaps should check at this point that the
573
# history of the revision is actually present?
574
p = self.pending_merges()
576
for rev_id in revision_ids:
582
self.set_pending_merges(p)
585
def pending_merges(self):
586
"""Return a list of pending merges.
588
These are revisions that have been merged into the working
589
directory but not yet committed.
592
merges_file = self._control_files.get_utf8('pending-merges')
594
if e.errno != errno.ENOENT:
598
for l in merges_file.readlines():
599
p.append(l.rstrip('\n'))
603
def set_pending_merges(self, rev_list):
604
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
607
def set_merge_modified(self, modified_hashes):
609
my_file.write(MERGE_MODIFIED_HEADER_1 + '\n')
610
writer = RioWriter(my_file)
611
for file_id, hash in modified_hashes.iteritems():
612
s = Stanza(file_id=file_id, hash=hash)
613
writer.write_stanza(s)
615
self._control_files.put('merge-hashes', my_file)
618
def merge_modified(self):
620
hashfile = self._control_files.get('merge-hashes')
625
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
626
raise MergeModifiedFormatError()
627
except StopIteration:
628
raise MergeModifiedFormatError()
629
for s in RioReader(hashfile):
630
file_id = s.get("file_id")
632
if hash == self.get_file_sha1(file_id):
633
merge_hashes[file_id] = hash
636
def get_symlink_target(self, file_id):
637
return os.readlink(self.id2abspath(file_id))
639
def file_class(self, filename):
640
if self.path2id(filename):
642
elif self.is_ignored(filename):
647
def list_files(self):
648
"""Recursively list all files as (path, class, kind, id).
650
Lists, but does not descend into unversioned directories.
652
This does not include files that have been deleted in this
655
Skips the control directory.
657
inv = self._inventory
659
def descend(from_dir_relpath, from_dir_id, dp):
663
## TODO: If we find a subdirectory with its own .bzr
664
## directory, then that is a separate tree and we
665
## should exclude it.
667
# the bzrdir for this tree
668
if self.bzrdir.transport.base.endswith(f + '/'):
672
fp = appendpath(from_dir_relpath, f)
675
fap = appendpath(dp, f)
677
f_ie = inv.get_child(from_dir_id, f)
680
elif self.is_ignored(fp):
689
raise BzrCheckError("file %r entered as kind %r id %r, "
691
% (fap, f_ie.kind, f_ie.file_id, fk))
693
# make a last minute entry
697
if fk == 'directory':
698
entry = TreeDirectory()
701
elif fk == 'symlink':
706
yield fp, c, fk, (f_ie and f_ie.file_id), entry
708
if fk != 'directory':
712
# don't descend unversioned directories
715
for ff in descend(fp, f_ie.file_id, fap):
718
for f in descend(u'', inv.root.file_id, self.basedir):
722
def move(self, from_paths, to_name):
725
to_name must exist in the inventory.
727
If to_name exists and is a directory, the files are moved into
728
it, keeping their old names.
730
Note that to_name is only the last component of the new name;
731
this doesn't change the directory.
733
This returns a list of (from_path, to_path) pairs for each
737
## TODO: Option to move IDs only
738
assert not isinstance(from_paths, basestring)
740
to_abs = self.abspath(to_name)
741
if not isdir(to_abs):
742
raise BzrError("destination %r is not a directory" % to_abs)
743
if not self.has_filename(to_name):
744
raise BzrError("destination %r not in working directory" % to_abs)
745
to_dir_id = inv.path2id(to_name)
746
if to_dir_id == None and to_name != '':
747
raise BzrError("destination %r is not a versioned directory" % to_name)
748
to_dir_ie = inv[to_dir_id]
749
if to_dir_ie.kind not in ('directory', 'root_directory'):
750
raise BzrError("destination %r is not a directory" % to_abs)
752
to_idpath = inv.get_idpath(to_dir_id)
755
if not self.has_filename(f):
756
raise BzrError("%r does not exist in working tree" % f)
757
f_id = inv.path2id(f)
759
raise BzrError("%r is not versioned" % f)
760
name_tail = splitpath(f)[-1]
761
dest_path = appendpath(to_name, name_tail)
762
if self.has_filename(dest_path):
763
raise BzrError("destination %r already exists" % dest_path)
764
if f_id in to_idpath:
765
raise BzrError("can't move %r to a subdirectory of itself" % f)
767
# OK, so there's a race here, it's possible that someone will
768
# create a file in this interval and then the rename might be
769
# left half-done. But we should have caught most problems.
770
orig_inv = deepcopy(self.inventory)
773
name_tail = splitpath(f)[-1]
774
dest_path = appendpath(to_name, name_tail)
775
result.append((f, dest_path))
776
inv.rename(inv.path2id(f), to_dir_id, name_tail)
778
rename(self.abspath(f), self.abspath(dest_path))
780
raise BzrError("failed to rename %r to %r: %s" %
781
(f, dest_path, e[1]),
782
["rename rolled back"])
784
# restore the inventory on error
785
self._set_inventory(orig_inv)
787
self._write_inventory(inv)
791
def rename_one(self, from_rel, to_rel):
794
This can change the directory or the filename or both.
797
if not self.has_filename(from_rel):
798
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
799
if self.has_filename(to_rel):
800
raise BzrError("can't rename: new working file %r already exists" % to_rel)
802
file_id = inv.path2id(from_rel)
804
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
807
from_parent = entry.parent_id
808
from_name = entry.name
810
if inv.path2id(to_rel):
811
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
813
to_dir, to_tail = os.path.split(to_rel)
814
to_dir_id = inv.path2id(to_dir)
815
if to_dir_id == None and to_dir != '':
816
raise BzrError("can't determine destination directory id for %r" % to_dir)
818
mutter("rename_one:")
819
mutter(" file_id {%s}" % file_id)
820
mutter(" from_rel %r" % from_rel)
821
mutter(" to_rel %r" % to_rel)
822
mutter(" to_dir %r" % to_dir)
823
mutter(" to_dir_id {%s}" % to_dir_id)
825
inv.rename(file_id, to_dir_id, to_tail)
827
from_abs = self.abspath(from_rel)
828
to_abs = self.abspath(to_rel)
830
rename(from_abs, to_abs)
832
inv.rename(file_id, from_parent, from_name)
833
raise BzrError("failed to rename %r to %r: %s"
834
% (from_abs, to_abs, e[1]),
835
["rename rolled back"])
836
self._write_inventory(inv)
840
"""Return all unknown files.
842
These are files in the working directory that are not versioned or
843
control files or ignored.
845
>>> from bzrlib.bzrdir import ScratchDir
846
>>> d = ScratchDir(files=['foo', 'foo~'])
847
>>> b = d.open_branch()
848
>>> tree = d.open_workingtree()
849
>>> map(str, tree.unknowns())
852
>>> list(b.unknowns())
854
>>> tree.remove('foo')
855
>>> list(b.unknowns())
858
for subp in self.extras():
859
if not self.is_ignored(subp):
862
def iter_conflicts(self):
864
for path in (s[0] for s in self.list_files()):
865
stem = get_conflicted_stem(path)
868
if stem not in conflicted:
873
def pull(self, source, overwrite=False, stop_revision=None):
874
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
877
pp = ProgressPhase("Pull phase", 2, top_pb)
879
old_revision_history = self.branch.revision_history()
880
basis_tree = self.basis_tree()
881
count = self.branch.pull(source, overwrite, stop_revision)
882
new_revision_history = self.branch.revision_history()
883
if new_revision_history != old_revision_history:
885
if len(old_revision_history):
886
other_revision = old_revision_history[-1]
888
other_revision = None
889
repository = self.branch.repository
890
pb = bzrlib.ui.ui_factory.nested_progress_bar()
892
merge_inner(self.branch,
893
self.branch.basis_tree(),
899
self.set_last_revision(self.branch.last_revision())
906
"""Yield all unknown files in this WorkingTree.
908
If there are any unknown directories then only the directory is
909
returned, not all its children. But if there are unknown files
910
under a versioned subdirectory, they are returned.
912
Currently returned depth-first, sorted by name within directories.
914
## TODO: Work from given directory downwards
915
for path, dir_entry in self.inventory.directories():
916
mutter("search for unknowns in %r", path)
917
dirabs = self.abspath(path)
918
if not isdir(dirabs):
919
# e.g. directory deleted
923
for subf in os.listdir(dirabs):
925
and (subf not in dir_entry.children)):
930
subp = appendpath(path, subf)
934
def ignored_files(self):
935
"""Yield list of PATH, IGNORE_PATTERN"""
936
for subp in self.extras():
937
pat = self.is_ignored(subp)
942
def get_ignore_list(self):
943
"""Return list of ignore patterns.
945
Cached in the Tree object after the first call.
947
if hasattr(self, '_ignorelist'):
948
return self._ignorelist
950
l = bzrlib.DEFAULT_IGNORE[:]
951
if self.has_filename(bzrlib.IGNORE_FILENAME):
952
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
953
l.extend([line.rstrip("\n\r") for line in f.readlines()])
958
def is_ignored(self, filename):
959
r"""Check whether the filename matches an ignore pattern.
961
Patterns containing '/' or '\' need to match the whole path;
962
others match against only the last component.
964
If the file is ignored, returns the pattern which caused it to
965
be ignored, otherwise None. So this can simply be used as a
966
boolean if desired."""
968
# TODO: Use '**' to match directories, and other extended
969
# globbing stuff from cvs/rsync.
971
# XXX: fnmatch is actually not quite what we want: it's only
972
# approximately the same as real Unix fnmatch, and doesn't
973
# treat dotfiles correctly and allows * to match /.
974
# Eventually it should be replaced with something more
977
for pat in self.get_ignore_list():
978
if '/' in pat or '\\' in pat:
980
# as a special case, you can put ./ at the start of a
981
# pattern; this is good to match in the top-level
984
if (pat[:2] == './') or (pat[:2] == '.\\'):
988
if fnmatch.fnmatchcase(filename, newpat):
991
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
996
def kind(self, file_id):
997
return file_kind(self.id2abspath(file_id))
1000
def last_revision(self):
1001
"""Return the last revision id of this working tree.
1003
In early branch formats this was == the branch last_revision,
1004
but that cannot be relied upon - for working tree operations,
1005
always use tree.last_revision().
1007
return self.branch.last_revision()
1009
def lock_read(self):
1010
"""See Branch.lock_read, and WorkingTree.unlock."""
1011
self.branch.lock_read()
1013
return self._control_files.lock_read()
1015
self.branch.unlock()
1018
def lock_write(self):
1019
"""See Branch.lock_write, and WorkingTree.unlock."""
1020
self.branch.lock_write()
1022
return self._control_files.lock_write()
1024
self.branch.unlock()
1027
def _basis_inventory_name(self, revision_id):
1028
return 'basis-inventory.%s' % revision_id
1031
def set_last_revision(self, new_revision, old_revision=None):
1032
"""Change the last revision in the working tree."""
1033
self._remove_old_basis(old_revision)
1034
if self._change_last_revision(new_revision):
1035
self._cache_basis_inventory(new_revision)
1037
def _change_last_revision(self, new_revision):
1038
"""Template method part of set_last_revision to perform the change."""
1039
if new_revision is None:
1040
self.branch.set_revision_history([])
1042
# current format is locked in with the branch
1043
revision_history = self.branch.revision_history()
1045
position = revision_history.index(new_revision)
1047
raise errors.NoSuchRevision(self.branch, new_revision)
1048
self.branch.set_revision_history(revision_history[:position + 1])
1051
def _cache_basis_inventory(self, new_revision):
1052
"""Cache new_revision as the basis inventory."""
1054
xml = self.branch.repository.get_inventory_xml(new_revision)
1055
path = self._basis_inventory_name(new_revision)
1056
self._control_files.put_utf8(path, xml)
1057
except WeaveRevisionNotPresent:
1060
def _remove_old_basis(self, old_revision):
1061
"""Remove the old basis inventory 'old_revision'."""
1062
if old_revision is not None:
1064
path = self._basis_inventory_name(old_revision)
1065
path = self._control_files._escape(path)
1066
self._control_files._transport.delete(path)
1070
def read_basis_inventory(self, revision_id):
1071
"""Read the cached basis inventory."""
1072
path = self._basis_inventory_name(revision_id)
1073
return self._control_files.get_utf8(path).read()
1076
def read_working_inventory(self):
1077
"""Read the working inventory."""
1078
# ElementTree does its own conversion from UTF-8, so open in
1080
result = bzrlib.xml5.serializer_v5.read_inventory(
1081
self._control_files.get('inventory'))
1082
self._set_inventory(result)
1086
def remove(self, files, verbose=False):
1087
"""Remove nominated files from the working inventory..
1089
This does not remove their text. This does not run on XXX on what? RBC
1091
TODO: Refuse to remove modified files unless --force is given?
1093
TODO: Do something useful with directories.
1095
TODO: Should this remove the text or not? Tough call; not
1096
removing may be useful and the user can just use use rm, and
1097
is the opposite of add. Removing it is consistent with most
1098
other tools. Maybe an option.
1100
## TODO: Normalize names
1101
## TODO: Remove nested loops; better scalability
1102
if isinstance(files, basestring):
1105
inv = self.inventory
1107
# do this before any modifications
1109
fid = inv.path2id(f)
1111
# TODO: Perhaps make this just a warning, and continue?
1112
# This tends to happen when
1113
raise NotVersionedError(path=f)
1114
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1116
# having remove it, it must be either ignored or unknown
1117
if self.is_ignored(f):
1121
show_status(new_status, inv[fid].kind, quotefn(f))
1124
self._write_inventory(inv)
1127
def revert(self, filenames, old_tree=None, backups=True,
1128
pb=DummyProgress()):
1129
from transform import revert
1130
if old_tree is None:
1131
old_tree = self.basis_tree()
1132
revert(self, old_tree, filenames, backups, pb)
1133
if not len(filenames):
1134
self.set_pending_merges([])
1137
def set_inventory(self, new_inventory_list):
1138
from bzrlib.inventory import (Inventory,
1143
inv = Inventory(self.get_root_id())
1144
for path, file_id, parent, kind, executable in new_inventory_list:
1145
name = os.path.basename(path)
1148
# fixme, there should be a factory function inv,add_??
1149
if kind == 'directory':
1150
inv.add(InventoryDirectory(file_id, name, parent))
1151
elif kind == 'file':
1152
ie = InventoryFile(file_id, name, parent)
1153
ie.executable = executable
1155
elif kind == 'symlink':
1156
inv.add(InventoryLink(file_id, name, parent))
1158
raise BzrError("unknown kind %r" % kind)
1159
self._write_inventory(inv)
1162
def set_root_id(self, file_id):
1163
"""Set the root id for this tree."""
1164
inv = self.read_working_inventory()
1165
orig_root_id = inv.root.file_id
1166
del inv._byid[inv.root.file_id]
1167
inv.root.file_id = file_id
1168
inv._byid[inv.root.file_id] = inv.root
1171
if entry.parent_id == orig_root_id:
1172
entry.parent_id = inv.root.file_id
1173
self._write_inventory(inv)
1176
"""See Branch.unlock.
1178
WorkingTree locking just uses the Branch locking facilities.
1179
This is current because all working trees have an embedded branch
1180
within them. IF in the future, we were to make branch data shareable
1181
between multiple working trees, i.e. via shared storage, then we
1182
would probably want to lock both the local tree, and the branch.
1184
# FIXME: We want to write out the hashcache only when the last lock on
1185
# this working copy is released. Peeking at the lock count is a bit
1186
# of a nasty hack; probably it's better to have a transaction object,
1187
# which can do some finalization when it's either successfully or
1188
# unsuccessfully completed. (Denys's original patch did that.)
1189
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1190
# wrongly. Hookinh into unllock on the control files object is fine though.
1192
# TODO: split this per format so there is no ugly if block
1193
if self._hashcache.needs_write and (
1194
# dedicated lock files
1195
self._control_files._lock_count==1 or
1197
(self._control_files is self.branch.control_files and
1198
self._control_files._lock_count==3)):
1199
self._hashcache.write()
1200
# reverse order of locking.
1201
result = self._control_files.unlock()
1203
self.branch.unlock()
1209
"""Update a working tree along its branch.
1211
This will update the branch if its bound too, which means we have multiple trees involved:
1212
The new basis tree of the master.
1213
The old basis tree of the branch.
1214
The old basis tree of the working tree.
1215
The current working tree state.
1216
pathologically all three may be different, and non ancestors of each other.
1217
Conceptually we want to:
1218
Preserve the wt.basis->wt.state changes
1219
Transform the wt.basis to the new master basis.
1220
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1221
Restore the wt.basis->wt.state changes.
1223
There isn't a single operation at the moment to do that, so we:
1224
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1225
Do a 'normal' merge of the old branch basis if it is relevant.
1227
old_tip = self.branch.update()
1228
if old_tip is not None:
1229
self.add_pending_merge(old_tip)
1230
self.branch.lock_read()
1233
if self.last_revision() != self.branch.last_revision():
1234
# merge tree state up to new branch tip.
1235
basis = self.basis_tree()
1236
to_tree = self.branch.basis_tree()
1237
result += merge_inner(self.branch,
1241
self.set_last_revision(self.branch.last_revision())
1242
if old_tip and old_tip != self.last_revision():
1243
# our last revision was not the prior branch last reivison
1244
# and we have converted that last revision to a pending merge.
1245
# base is somewhere between the branch tip now
1246
# and the now pending merge
1247
from bzrlib.revision import common_ancestor
1249
base_rev_id = common_ancestor(self.branch.last_revision(),
1251
self.branch.repository)
1252
except errors.NoCommonAncestor:
1254
base_tree = self.branch.repository.revision_tree(base_rev_id)
1255
other_tree = self.branch.repository.revision_tree(old_tip)
1256
result += merge_inner(self.branch,
1262
self.branch.unlock()
1265
def _write_inventory(self, inv):
1266
"""Write inventory as the current inventory."""
1268
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1270
self._control_files.put('inventory', sio)
1271
self._set_inventory(inv)
1272
mutter('wrote working inventory')
1275
class WorkingTree3(WorkingTree):
1276
"""This is the Format 3 working tree.
1278
This differs from the base WorkingTree by:
1279
- having its own file lock
1280
- having its own last-revision property.
1282
This is new in bzr 0.8
1286
def last_revision(self):
1287
"""See WorkingTree.last_revision."""
1289
return self._control_files.get_utf8('last-revision').read()
1293
def _change_last_revision(self, revision_id):
1294
"""See WorkingTree._change_last_revision."""
1295
if revision_id is None or revision_id == NULL_REVISION:
1297
self._control_files._transport.delete('last-revision')
1298
except errors.NoSuchFile:
1303
self.branch.revision_history().index(revision_id)
1305
raise errors.NoSuchRevision(self.branch, revision_id)
1306
self._control_files.put_utf8('last-revision', revision_id)
1310
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1311
def get_conflicted_stem(path):
1312
for suffix in CONFLICT_SUFFIXES:
1313
if path.endswith(suffix):
1314
return path[:-len(suffix)]
1316
@deprecated_function(zero_eight)
1317
def is_control_file(filename):
1318
"""See WorkingTree.is_control_filename(filename)."""
1319
## FIXME: better check
1320
filename = normpath(filename)
1321
while filename != '':
1322
head, tail = os.path.split(filename)
1323
## mutter('check %r for control file' % ((head, tail),))
1326
if filename == head:
1332
class WorkingTreeFormat(object):
1333
"""An encapsulation of the initialization and open routines for a format.
1335
Formats provide three things:
1336
* An initialization routine,
1340
Formats are placed in an dict by their format string for reference
1341
during workingtree opening. Its not required that these be instances, they
1342
can be classes themselves with class methods - it simply depends on
1343
whether state is needed for a given format or not.
1345
Once a format is deprecated, just deprecate the initialize and open
1346
methods on the format class. Do not deprecate the object, as the
1347
object will be created every time regardless.
1350
_default_format = None
1351
"""The default format used for new trees."""
1354
"""The known formats."""
1357
def find_format(klass, a_bzrdir):
1358
"""Return the format for the working tree object in a_bzrdir."""
1360
transport = a_bzrdir.get_workingtree_transport(None)
1361
format_string = transport.get("format").read()
1362
return klass._formats[format_string]
1364
raise errors.NoWorkingTree(base=transport.base)
1366
raise errors.UnknownFormatError(format_string)
1369
def get_default_format(klass):
1370
"""Return the current default format."""
1371
return klass._default_format
1373
def get_format_string(self):
1374
"""Return the ASCII format string that identifies this format."""
1375
raise NotImplementedError(self.get_format_string)
1377
def is_supported(self):
1378
"""Is this format supported?
1380
Supported formats can be initialized and opened.
1381
Unsupported formats may not support initialization or committing or
1382
some other features depending on the reason for not being supported.
1387
def register_format(klass, format):
1388
klass._formats[format.get_format_string()] = format
1391
def set_default_format(klass, format):
1392
klass._default_format = format
1395
def unregister_format(klass, format):
1396
assert klass._formats[format.get_format_string()] is format
1397
del klass._formats[format.get_format_string()]
1401
class WorkingTreeFormat2(WorkingTreeFormat):
1402
"""The second working tree format.
1404
This format modified the hash cache from the format 1 hash cache.
1407
def initialize(self, a_bzrdir, revision_id=None):
1408
"""See WorkingTreeFormat.initialize()."""
1409
if not isinstance(a_bzrdir.transport, LocalTransport):
1410
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1411
branch = a_bzrdir.open_branch()
1412
if revision_id is not None:
1415
revision_history = branch.revision_history()
1417
position = revision_history.index(revision_id)
1419
raise errors.NoSuchRevision(branch, revision_id)
1420
branch.set_revision_history(revision_history[:position + 1])
1423
revision = branch.last_revision()
1425
wt = WorkingTree(a_bzrdir.root_transport.base,
1431
wt._write_inventory(inv)
1432
wt.set_root_id(inv.root.file_id)
1433
wt.set_last_revision(revision)
1434
wt.set_pending_merges([])
1435
build_tree(wt.basis_tree(), wt)
1439
super(WorkingTreeFormat2, self).__init__()
1440
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1442
def open(self, a_bzrdir, _found=False):
1443
"""Return the WorkingTree object for a_bzrdir
1445
_found is a private parameter, do not use it. It is used to indicate
1446
if format probing has already been done.
1449
# we are being called directly and must probe.
1450
raise NotImplementedError
1451
if not isinstance(a_bzrdir.transport, LocalTransport):
1452
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1453
return WorkingTree(a_bzrdir.root_transport.base,
1459
class WorkingTreeFormat3(WorkingTreeFormat):
1460
"""The second working tree format updated to record a format marker.
1463
- exists within a metadir controlling .bzr
1464
- includes an explicit version marker for the workingtree control
1465
files, separate from the BzrDir format
1466
- modifies the hash cache format
1468
- uses a LockDir to guard access to the repository
1471
def get_format_string(self):
1472
"""See WorkingTreeFormat.get_format_string()."""
1473
return "Bazaar-NG Working Tree format 3"
1475
_lock_file_name = 'lock'
1476
_lock_class = LockDir
1478
def _open_control_files(self, a_bzrdir):
1479
transport = a_bzrdir.get_workingtree_transport(None)
1480
return LockableFiles(transport, self._lock_file_name,
1483
def initialize(self, a_bzrdir, revision_id=None):
1484
"""See WorkingTreeFormat.initialize().
1486
revision_id allows creating a working tree at a differnet
1487
revision than the branch is at.
1489
if not isinstance(a_bzrdir.transport, LocalTransport):
1490
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1491
transport = a_bzrdir.get_workingtree_transport(self)
1492
control_files = self._open_control_files(a_bzrdir)
1493
control_files.create_lock()
1494
control_files.put_utf8('format', self.get_format_string())
1495
branch = a_bzrdir.open_branch()
1496
if revision_id is None:
1497
revision_id = branch.last_revision()
1499
wt = WorkingTree3(a_bzrdir.root_transport.base,
1505
_control_files=control_files)
1506
wt._write_inventory(inv)
1507
wt.set_root_id(inv.root.file_id)
1508
wt.set_last_revision(revision_id)
1509
wt.set_pending_merges([])
1510
build_tree(wt.basis_tree(), wt)
1514
super(WorkingTreeFormat3, self).__init__()
1515
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1517
def open(self, a_bzrdir, _found=False):
1518
"""Return the WorkingTree object for a_bzrdir
1520
_found is a private parameter, do not use it. It is used to indicate
1521
if format probing has already been done.
1524
# we are being called directly and must probe.
1525
raise NotImplementedError
1526
if not isinstance(a_bzrdir.transport, LocalTransport):
1527
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1528
control_files = self._open_control_files(a_bzrdir)
1529
return WorkingTree3(a_bzrdir.root_transport.base,
1533
_control_files=control_files)
1536
return self.get_format_string()
1539
# formats which have no format string are not discoverable
1540
# and not independently creatable, so are not registered.
1541
__default_format = WorkingTreeFormat3()
1542
WorkingTreeFormat.register_format(__default_format)
1543
WorkingTreeFormat.set_default_format(__default_format)
1544
_legacy_formats = [WorkingTreeFormat2(),
1548
class WorkingTreeTestProviderAdapter(object):
1549
"""A tool to generate a suite testing multiple workingtree formats at once.
1551
This is done by copying the test once for each transport and injecting
1552
the transport_server, transport_readonly_server, and workingtree_format
1553
classes into each copy. Each copy is also given a new id() to make it
1557
def __init__(self, transport_server, transport_readonly_server, formats):
1558
self._transport_server = transport_server
1559
self._transport_readonly_server = transport_readonly_server
1560
self._formats = formats
1562
def adapt(self, test):
1563
from bzrlib.tests import TestSuite
1564
result = TestSuite()
1565
for workingtree_format, bzrdir_format in self._formats:
1566
new_test = deepcopy(test)
1567
new_test.transport_server = self._transport_server
1568
new_test.transport_readonly_server = self._transport_readonly_server
1569
new_test.bzrdir_format = bzrdir_format
1570
new_test.workingtree_format = workingtree_format
1571
def make_new_test_id():
1572
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1573
return lambda: new_id
1574
new_test.id = make_new_test_id()
1575
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
