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"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from copy import deepcopy
43
from cStringIO import StringIO
50
from bzrlib.atomicfile import AtomicFile
51
from bzrlib.branch import (Branch,
53
from bzrlib.conflicts import (stanza_conflicts, conflict_stanzas, Conflict,
55
import bzrlib.bzrdir as bzrdir
56
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
import bzrlib.errors as errors
58
from bzrlib.errors import (BzrCheckError,
62
WeaveRevisionNotPresent,
66
MergeModifiedFormatError,
69
from bzrlib.inventory import InventoryEntry, Inventory
70
from bzrlib.lockable_files import LockableFiles, TransportLock
71
from bzrlib.lockdir import LockDir
72
from bzrlib.merge import merge_inner, transform_tree
73
from bzrlib.osutils import (
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 *
95
from bzrlib.textui import show_status
97
from bzrlib.trace import mutter
98
from bzrlib.transform import build_tree
99
from bzrlib.transport import get_transport
100
from bzrlib.transport.local import LocalTransport
105
def gen_file_id(name):
106
"""Return new file id.
108
This should probably generate proper UUIDs, but for the moment we
109
cope with just randomness because running uuidgen every time is
112
from binascii import hexlify
113
from time import time
116
idx = name.rfind('/')
118
name = name[idx+1 : ]
119
idx = name.rfind('\\')
121
name = name[idx+1 : ]
123
# make it not a hidden file
124
name = name.lstrip('.')
126
# remove any wierd characters; we don't escape them but rather
128
name = re.sub(r'[^\w.]', '', name)
130
s = hexlify(rand_bytes(8))
131
return '-'.join((name, compact_date(time()), s))
135
"""Return a new tree-root file id."""
136
return gen_file_id('TREE_ROOT')
139
class TreeEntry(object):
140
"""An entry that implements the minium interface used by commands.
142
This needs further inspection, it may be better to have
143
InventoryEntries without ids - though that seems wrong. For now,
144
this is a parallel hierarchy to InventoryEntry, and needs to become
145
one of several things: decorates to that hierarchy, children of, or
147
Another note is that these objects are currently only used when there is
148
no InventoryEntry available - i.e. for unversioned objects.
149
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
152
def __eq__(self, other):
153
# yes, this us ugly, TODO: best practice __eq__ style.
154
return (isinstance(other, TreeEntry)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class TreeDirectory(TreeEntry):
162
"""See TreeEntry. This is a directory in a working tree."""
164
def __eq__(self, other):
165
return (isinstance(other, TreeDirectory)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeFile(TreeEntry):
173
"""See TreeEntry. This is a regular file in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeFile)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeLink(TreeEntry):
184
"""See TreeEntry. This is a symlink in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeLink)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class WorkingTree(bzrlib.tree.Tree):
195
"""Working copy tree.
197
The inventory is held in the `Branch` working-inventory, and the
198
files are in a directory on disk.
200
It is possible for a `WorkingTree` to have a filename which is
201
not listed in the Inventory and vice versa.
204
def __init__(self, basedir='.',
205
branch=DEPRECATED_PARAMETER,
211
"""Construct a WorkingTree for basedir.
213
If the branch is not supplied, it is opened automatically.
214
If the branch is supplied, it must be the branch for this basedir.
215
(branch.base is not cross checked, because for remote branches that
216
would be meaningless).
218
self._format = _format
219
self.bzrdir = _bzrdir
221
# not created via open etc.
222
warn("WorkingTree() is deprecated as of bzr version 0.8. "
223
"Please use bzrdir.open_workingtree or WorkingTree.open().",
226
wt = WorkingTree.open(basedir)
227
self.branch = wt.branch
228
self.basedir = wt.basedir
229
self._control_files = wt._control_files
230
self._hashcache = wt._hashcache
231
self._set_inventory(wt._inventory)
232
self._format = wt._format
233
self.bzrdir = wt.bzrdir
234
from bzrlib.hashcache import HashCache
235
from bzrlib.trace import note, mutter
236
assert isinstance(basedir, basestring), \
237
"base directory %r is not a string" % basedir
238
basedir = safe_unicode(basedir)
239
mutter("opening working tree %r", basedir)
240
if deprecated_passed(branch):
242
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
243
" Please use bzrdir.open_workingtree() or"
244
" WorkingTree.open().",
250
self.branch = self.bzrdir.open_branch()
251
assert isinstance(self.branch, Branch), \
252
"branch %r is not a Branch" % self.branch
253
self.basedir = realpath(basedir)
254
# if branch is at our basedir and is a format 6 or less
255
if isinstance(self._format, WorkingTreeFormat2):
256
# share control object
257
self._control_files = self.branch.control_files
259
# only ready for format 3
260
assert isinstance(self._format, WorkingTreeFormat3)
261
assert isinstance(_control_files, LockableFiles), \
262
"_control_files must be a LockableFiles, not %r" \
264
self._control_files = _control_files
265
# update the whole cache up front and write to disk if anything changed;
266
# in the future we might want to do this more selectively
267
# two possible ways offer themselves : in self._unlock, write the cache
268
# if needed, or, when the cache sees a change, append it to the hash
269
# cache file, and have the parser take the most recent entry for a
271
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
272
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
274
# is this scan needed ? it makes things kinda slow.
281
if _inventory is None:
282
self._set_inventory(self.read_working_inventory())
284
self._set_inventory(_inventory)
286
def _set_inventory(self, inv):
287
self._inventory = inv
288
self.path2id = self._inventory.path2id
290
def is_control_filename(self, filename):
291
"""True if filename is the name of a control file in this tree.
293
This is true IF and ONLY IF the filename is part of the meta data
294
that bzr controls in this tree. I.E. a random .bzr directory placed
295
on disk will not be a control file for this tree.
298
self.bzrdir.transport.relpath(self.abspath(filename))
300
except errors.PathNotChild:
304
def open(path=None, _unsupported=False):
305
"""Open an existing working tree at path.
309
path = os.path.getcwdu()
310
control = bzrdir.BzrDir.open(path, _unsupported)
311
return control.open_workingtree(_unsupported)
314
def open_containing(path=None):
315
"""Open an existing working tree which has its root about path.
317
This probes for a working tree at path and searches upwards from there.
319
Basically we keep looking up until we find the control directory or
320
run into /. If there isn't one, raises NotBranchError.
321
TODO: give this a new exception.
322
If there is one, it is returned, along with the unused portion of path.
326
control, relpath = bzrdir.BzrDir.open_containing(path)
327
return control.open_workingtree(), relpath
330
def open_downlevel(path=None):
331
"""Open an unsupported working tree.
333
Only intended for advanced situations like upgrading part of a bzrdir.
335
return WorkingTree.open(path, _unsupported=True)
338
"""Iterate through file_ids for this tree.
340
file_ids are in a WorkingTree if they are in the working inventory
341
and the working file exists.
343
inv = self._inventory
344
for path, ie in inv.iter_entries():
345
if bzrlib.osutils.lexists(self.abspath(path)):
349
return "<%s of %s>" % (self.__class__.__name__,
350
getattr(self, 'basedir', None))
352
def abspath(self, filename):
353
return pathjoin(self.basedir, filename)
355
def basis_tree(self):
356
"""Return RevisionTree for the current last revision."""
357
revision_id = self.last_revision()
358
if revision_id is not None:
360
xml = self.read_basis_inventory(revision_id)
361
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
362
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
366
return self.branch.repository.revision_tree(revision_id)
369
@deprecated_method(zero_eight)
370
def create(branch, directory):
371
"""Create a workingtree for branch at directory.
373
If existing_directory already exists it must have a .bzr directory.
374
If it does not exist, it will be created.
376
This returns a new WorkingTree object for the new checkout.
378
TODO FIXME RBC 20060124 when we have checkout formats in place this
379
should accept an optional revisionid to checkout [and reject this if
380
checking out into the same dir as a pre-checkout-aware branch format.]
382
XXX: When BzrDir is present, these should be created through that
385
warn('delete WorkingTree.create', stacklevel=3)
386
transport = get_transport(directory)
387
if branch.bzrdir.root_transport.base == transport.base:
389
return branch.bzrdir.create_workingtree()
390
# different directory,
391
# create a branch reference
392
# and now a working tree.
393
raise NotImplementedError
396
@deprecated_method(zero_eight)
397
def create_standalone(directory):
398
"""Create a checkout and a branch and a repo at directory.
400
Directory must exist and be empty.
402
please use BzrDir.create_standalone_workingtree
404
return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
def relpath(self, abs):
407
"""Return the local path portion from a given absolute path."""
408
return relpath(self.basedir, abs)
410
def has_filename(self, filename):
411
return bzrlib.osutils.lexists(self.abspath(filename))
413
def get_file(self, file_id):
414
return self.get_file_byname(self.id2path(file_id))
416
def get_file_byname(self, filename):
417
return file(self.abspath(filename), 'rb')
419
def get_root_id(self):
420
"""Return the id of this trees root"""
421
inv = self.read_working_inventory()
422
return inv.root.file_id
424
def _get_store_filename(self, file_id):
425
## XXX: badly named; this is not in the store at all
426
return self.abspath(self.id2path(file_id))
429
def clone(self, to_bzrdir, revision_id=None, basis=None):
430
"""Duplicate this working tree into to_bzr, including all state.
432
Specifically modified files are kept as modified, but
433
ignored and unknown files are discarded.
435
If you want to make a new line of development, see bzrdir.sprout()
438
If not None, the cloned tree will have its last revision set to
439
revision, and and difference between the source trees last revision
440
and this one merged in.
443
If not None, a closer copy of a tree which may have some files in
444
common, and which file content should be preferentially copied from.
446
# assumes the target bzr dir format is compatible.
447
result = self._format.initialize(to_bzrdir)
448
self.copy_content_into(result, revision_id)
452
def copy_content_into(self, tree, revision_id=None):
453
"""Copy the current content and user files of this tree into tree."""
454
if revision_id is None:
455
transform_tree(tree, self)
457
# TODO now merge from tree.last_revision to revision
458
transform_tree(tree, self)
459
tree.set_last_revision(revision_id)
462
def commit(self, message=None, revprops=None, *args, **kwargs):
463
# avoid circular imports
464
from bzrlib.commit import Commit
467
if not 'branch-nick' in revprops:
468
revprops['branch-nick'] = self.branch.nick
469
# args for wt.commit start at message from the Commit.commit method,
470
# but with branch a kwarg now, passing in args as is results in the
471
#message being used for the branch
472
args = (DEPRECATED_PARAMETER, message, ) + args
473
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
474
self._set_inventory(self.read_working_inventory())
476
def id2abspath(self, file_id):
477
return self.abspath(self.id2path(file_id))
479
def has_id(self, file_id):
480
# files that have been deleted are excluded
481
inv = self._inventory
482
if not inv.has_id(file_id):
484
path = inv.id2path(file_id)
485
return bzrlib.osutils.lexists(self.abspath(path))
487
def has_or_had_id(self, file_id):
488
if file_id == self.inventory.root.file_id:
490
return self.inventory.has_id(file_id)
492
__contains__ = has_id
494
def get_file_size(self, file_id):
495
return os.path.getsize(self.id2abspath(file_id))
498
def get_file_sha1(self, file_id):
499
path = self._inventory.id2path(file_id)
500
return self._hashcache.get_sha1(path)
502
def is_executable(self, file_id):
503
if not supports_executable():
504
return self._inventory[file_id].executable
506
path = self._inventory.id2path(file_id)
507
mode = os.lstat(self.abspath(path)).st_mode
508
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
511
def add(self, files, ids=None):
512
"""Make files versioned.
514
Note that the command line normally calls smart_add instead,
515
which can automatically recurse.
517
This adds the files to the inventory, so that they will be
518
recorded by the next commit.
521
List of paths to add, relative to the base of the tree.
524
If set, use these instead of automatically generated ids.
525
Must be the same length as the list of files, but may
526
contain None for ids that are to be autogenerated.
528
TODO: Perhaps have an option to add the ids even if the files do
531
TODO: Perhaps callback with the ids and paths as they're added.
533
# TODO: Re-adding a file that is removed in the working copy
534
# should probably put it back with the previous ID.
535
if isinstance(files, basestring):
536
assert(ids is None or isinstance(ids, basestring))
542
ids = [None] * len(files)
544
assert(len(ids) == len(files))
546
inv = self.read_working_inventory()
547
for f,file_id in zip(files, ids):
548
if self.is_control_filename(f):
549
raise BzrError("cannot add control file %s" % quotefn(f))
554
raise BzrError("cannot add top-level %r" % f)
556
fullpath = normpath(self.abspath(f))
559
kind = file_kind(fullpath)
561
if e.errno == errno.ENOENT:
562
raise NoSuchFile(fullpath)
563
# maybe something better?
564
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
if not InventoryEntry.versionable_kind(kind):
567
raise BzrError('cannot add: not a versionable file ('
568
'i.e. regular file, symlink or directory): %s' % quotefn(f))
571
file_id = gen_file_id(f)
572
inv.add_path(f, kind=kind, file_id=file_id)
574
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
575
self._write_inventory(inv)
578
def add_pending_merge(self, *revision_ids):
579
# TODO: Perhaps should check at this point that the
580
# history of the revision is actually present?
581
p = self.pending_merges()
583
for rev_id in revision_ids:
589
self.set_pending_merges(p)
592
def pending_merges(self):
593
"""Return a list of pending merges.
595
These are revisions that have been merged into the working
596
directory but not yet committed.
599
merges_file = self._control_files.get_utf8('pending-merges')
601
if e.errno != errno.ENOENT:
605
for l in merges_file.readlines():
606
p.append(l.rstrip('\n'))
610
def set_pending_merges(self, rev_list):
611
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
614
def set_merge_modified(self, modified_hashes):
616
for file_id, hash in modified_hashes.iteritems():
617
yield Stanza(file_id=file_id, hash=hash)
618
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
621
def _put_rio(self, filename, stanzas, header):
622
my_file = rio_file(stanzas, header)
623
self._control_files.put(filename, my_file)
626
def merge_modified(self):
628
hashfile = self._control_files.get('merge-hashes')
633
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
634
raise MergeModifiedFormatError()
635
except StopIteration:
636
raise MergeModifiedFormatError()
637
for s in RioReader(hashfile):
638
file_id = s.get("file_id")
640
if hash == self.get_file_sha1(file_id):
641
merge_hashes[file_id] = hash
644
def get_symlink_target(self, file_id):
645
return os.readlink(self.id2abspath(file_id))
647
def file_class(self, filename):
648
if self.path2id(filename):
650
elif self.is_ignored(filename):
655
def list_files(self):
656
"""Recursively list all files as (path, class, kind, id).
658
Lists, but does not descend into unversioned directories.
660
This does not include files that have been deleted in this
663
Skips the control directory.
665
inv = self._inventory
667
def descend(from_dir_relpath, from_dir_id, dp):
671
## TODO: If we find a subdirectory with its own .bzr
672
## directory, then that is a separate tree and we
673
## should exclude it.
675
# the bzrdir for this tree
676
if self.bzrdir.transport.base.endswith(f + '/'):
680
fp = appendpath(from_dir_relpath, f)
683
fap = appendpath(dp, f)
685
f_ie = inv.get_child(from_dir_id, f)
688
elif self.is_ignored(fp):
697
raise BzrCheckError("file %r entered as kind %r id %r, "
699
% (fap, f_ie.kind, f_ie.file_id, fk))
701
# make a last minute entry
705
if fk == 'directory':
706
entry = TreeDirectory()
709
elif fk == 'symlink':
714
yield fp, c, fk, (f_ie and f_ie.file_id), entry
716
if fk != 'directory':
720
# don't descend unversioned directories
723
for ff in descend(fp, f_ie.file_id, fap):
726
for f in descend(u'', inv.root.file_id, self.basedir):
730
def move(self, from_paths, to_name):
733
to_name must exist in the inventory.
735
If to_name exists and is a directory, the files are moved into
736
it, keeping their old names.
738
Note that to_name is only the last component of the new name;
739
this doesn't change the directory.
741
This returns a list of (from_path, to_path) pairs for each
745
## TODO: Option to move IDs only
746
assert not isinstance(from_paths, basestring)
748
to_abs = self.abspath(to_name)
749
if not isdir(to_abs):
750
raise BzrError("destination %r is not a directory" % to_abs)
751
if not self.has_filename(to_name):
752
raise BzrError("destination %r not in working directory" % to_abs)
753
to_dir_id = inv.path2id(to_name)
754
if to_dir_id == None and to_name != '':
755
raise BzrError("destination %r is not a versioned directory" % to_name)
756
to_dir_ie = inv[to_dir_id]
757
if to_dir_ie.kind not in ('directory', 'root_directory'):
758
raise BzrError("destination %r is not a directory" % to_abs)
760
to_idpath = inv.get_idpath(to_dir_id)
763
if not self.has_filename(f):
764
raise BzrError("%r does not exist in working tree" % f)
765
f_id = inv.path2id(f)
767
raise BzrError("%r is not versioned" % f)
768
name_tail = splitpath(f)[-1]
769
dest_path = appendpath(to_name, name_tail)
770
if self.has_filename(dest_path):
771
raise BzrError("destination %r already exists" % dest_path)
772
if f_id in to_idpath:
773
raise BzrError("can't move %r to a subdirectory of itself" % f)
775
# OK, so there's a race here, it's possible that someone will
776
# create a file in this interval and then the rename might be
777
# left half-done. But we should have caught most problems.
778
orig_inv = deepcopy(self.inventory)
781
name_tail = splitpath(f)[-1]
782
dest_path = appendpath(to_name, name_tail)
783
result.append((f, dest_path))
784
inv.rename(inv.path2id(f), to_dir_id, name_tail)
786
rename(self.abspath(f), self.abspath(dest_path))
788
raise BzrError("failed to rename %r to %r: %s" %
789
(f, dest_path, e[1]),
790
["rename rolled back"])
792
# restore the inventory on error
793
self._set_inventory(orig_inv)
795
self._write_inventory(inv)
799
def rename_one(self, from_rel, to_rel):
802
This can change the directory or the filename or both.
805
if not self.has_filename(from_rel):
806
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
807
if self.has_filename(to_rel):
808
raise BzrError("can't rename: new working file %r already exists" % to_rel)
810
file_id = inv.path2id(from_rel)
812
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
815
from_parent = entry.parent_id
816
from_name = entry.name
818
if inv.path2id(to_rel):
819
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
821
to_dir, to_tail = os.path.split(to_rel)
822
to_dir_id = inv.path2id(to_dir)
823
if to_dir_id == None and to_dir != '':
824
raise BzrError("can't determine destination directory id for %r" % to_dir)
826
mutter("rename_one:")
827
mutter(" file_id {%s}" % file_id)
828
mutter(" from_rel %r" % from_rel)
829
mutter(" to_rel %r" % to_rel)
830
mutter(" to_dir %r" % to_dir)
831
mutter(" to_dir_id {%s}" % to_dir_id)
833
inv.rename(file_id, to_dir_id, to_tail)
835
from_abs = self.abspath(from_rel)
836
to_abs = self.abspath(to_rel)
838
rename(from_abs, to_abs)
840
inv.rename(file_id, from_parent, from_name)
841
raise BzrError("failed to rename %r to %r: %s"
842
% (from_abs, to_abs, e[1]),
843
["rename rolled back"])
844
self._write_inventory(inv)
848
"""Return all unknown files.
850
These are files in the working directory that are not versioned or
851
control files or ignored.
853
>>> from bzrlib.bzrdir import ScratchDir
854
>>> d = ScratchDir(files=['foo', 'foo~'])
855
>>> b = d.open_branch()
856
>>> tree = d.open_workingtree()
857
>>> map(str, tree.unknowns())
860
>>> list(b.unknowns())
862
>>> tree.remove('foo')
863
>>> list(b.unknowns())
866
for subp in self.extras():
867
if not self.is_ignored(subp):
870
@deprecated_method(zero_eight)
871
def iter_conflicts(self):
872
"""List all files in the tree that have text or content conflicts.
873
DEPRECATED. Use conflict_lines instead."""
874
return self._iter_conflicts()
876
def _iter_conflicts(self):
878
for path in (s[0] for s in self.list_files()):
879
stem = get_conflicted_stem(path)
882
if stem not in conflicted:
887
def pull(self, source, overwrite=False, stop_revision=None):
888
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
891
pp = ProgressPhase("Pull phase", 2, top_pb)
893
old_revision_history = self.branch.revision_history()
894
basis_tree = self.basis_tree()
895
count = self.branch.pull(source, overwrite, stop_revision)
896
new_revision_history = self.branch.revision_history()
897
if new_revision_history != old_revision_history:
899
if len(old_revision_history):
900
other_revision = old_revision_history[-1]
902
other_revision = None
903
repository = self.branch.repository
904
pb = bzrlib.ui.ui_factory.nested_progress_bar()
906
merge_inner(self.branch,
907
self.branch.basis_tree(),
913
self.set_last_revision(self.branch.last_revision())
920
"""Yield all unknown files in this WorkingTree.
922
If there are any unknown directories then only the directory is
923
returned, not all its children. But if there are unknown files
924
under a versioned subdirectory, they are returned.
926
Currently returned depth-first, sorted by name within directories.
928
## TODO: Work from given directory downwards
929
for path, dir_entry in self.inventory.directories():
930
mutter("search for unknowns in %r", path)
931
dirabs = self.abspath(path)
932
if not isdir(dirabs):
933
# e.g. directory deleted
937
for subf in os.listdir(dirabs):
939
and (subf not in dir_entry.children)):
944
subp = appendpath(path, subf)
948
def ignored_files(self):
949
"""Yield list of PATH, IGNORE_PATTERN"""
950
for subp in self.extras():
951
pat = self.is_ignored(subp)
956
def get_ignore_list(self):
957
"""Return list of ignore patterns.
959
Cached in the Tree object after the first call.
961
if hasattr(self, '_ignorelist'):
962
return self._ignorelist
964
l = bzrlib.DEFAULT_IGNORE[:]
965
if self.has_filename(bzrlib.IGNORE_FILENAME):
966
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
967
l.extend([line.rstrip("\n\r") for line in f.readlines()])
972
def is_ignored(self, filename):
973
r"""Check whether the filename matches an ignore pattern.
975
Patterns containing '/' or '\' need to match the whole path;
976
others match against only the last component.
978
If the file is ignored, returns the pattern which caused it to
979
be ignored, otherwise None. So this can simply be used as a
980
boolean if desired."""
982
# TODO: Use '**' to match directories, and other extended
983
# globbing stuff from cvs/rsync.
985
# XXX: fnmatch is actually not quite what we want: it's only
986
# approximately the same as real Unix fnmatch, and doesn't
987
# treat dotfiles correctly and allows * to match /.
988
# Eventually it should be replaced with something more
991
for pat in self.get_ignore_list():
992
if '/' in pat or '\\' in pat:
994
# as a special case, you can put ./ at the start of a
995
# pattern; this is good to match in the top-level
998
if (pat[:2] == './') or (pat[:2] == '.\\'):
1002
if fnmatch.fnmatchcase(filename, newpat):
1005
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1010
def kind(self, file_id):
1011
return file_kind(self.id2abspath(file_id))
1014
def last_revision(self):
1015
"""Return the last revision id of this working tree.
1017
In early branch formats this was == the branch last_revision,
1018
but that cannot be relied upon - for working tree operations,
1019
always use tree.last_revision().
1021
return self.branch.last_revision()
1023
def lock_read(self):
1024
"""See Branch.lock_read, and WorkingTree.unlock."""
1025
self.branch.lock_read()
1027
return self._control_files.lock_read()
1029
self.branch.unlock()
1032
def lock_write(self):
1033
"""See Branch.lock_write, and WorkingTree.unlock."""
1034
self.branch.lock_write()
1036
return self._control_files.lock_write()
1038
self.branch.unlock()
1041
def _basis_inventory_name(self, revision_id):
1042
return 'basis-inventory.%s' % revision_id
1045
def set_last_revision(self, new_revision, old_revision=None):
1046
"""Change the last revision in the working tree."""
1047
self._remove_old_basis(old_revision)
1048
if self._change_last_revision(new_revision):
1049
self._cache_basis_inventory(new_revision)
1051
def _change_last_revision(self, new_revision):
1052
"""Template method part of set_last_revision to perform the change."""
1053
if new_revision is None:
1054
self.branch.set_revision_history([])
1056
# current format is locked in with the branch
1057
revision_history = self.branch.revision_history()
1059
position = revision_history.index(new_revision)
1061
raise errors.NoSuchRevision(self.branch, new_revision)
1062
self.branch.set_revision_history(revision_history[:position + 1])
1065
def _cache_basis_inventory(self, new_revision):
1066
"""Cache new_revision as the basis inventory."""
1068
xml = self.branch.repository.get_inventory_xml(new_revision)
1069
path = self._basis_inventory_name(new_revision)
1070
self._control_files.put_utf8(path, xml)
1071
except WeaveRevisionNotPresent:
1074
def _remove_old_basis(self, old_revision):
1075
"""Remove the old basis inventory 'old_revision'."""
1076
if old_revision is not None:
1078
path = self._basis_inventory_name(old_revision)
1079
path = self._control_files._escape(path)
1080
self._control_files._transport.delete(path)
1084
def read_basis_inventory(self, revision_id):
1085
"""Read the cached basis inventory."""
1086
path = self._basis_inventory_name(revision_id)
1087
return self._control_files.get_utf8(path).read()
1090
def read_working_inventory(self):
1091
"""Read the working inventory."""
1092
# ElementTree does its own conversion from UTF-8, so open in
1094
result = bzrlib.xml5.serializer_v5.read_inventory(
1095
self._control_files.get('inventory'))
1096
self._set_inventory(result)
1100
def remove(self, files, verbose=False):
1101
"""Remove nominated files from the working inventory..
1103
This does not remove their text. This does not run on XXX on what? RBC
1105
TODO: Refuse to remove modified files unless --force is given?
1107
TODO: Do something useful with directories.
1109
TODO: Should this remove the text or not? Tough call; not
1110
removing may be useful and the user can just use use rm, and
1111
is the opposite of add. Removing it is consistent with most
1112
other tools. Maybe an option.
1114
## TODO: Normalize names
1115
## TODO: Remove nested loops; better scalability
1116
if isinstance(files, basestring):
1119
inv = self.inventory
1121
# do this before any modifications
1123
fid = inv.path2id(f)
1125
# TODO: Perhaps make this just a warning, and continue?
1126
# This tends to happen when
1127
raise NotVersionedError(path=f)
1128
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1130
# having remove it, it must be either ignored or unknown
1131
if self.is_ignored(f):
1135
show_status(new_status, inv[fid].kind, quotefn(f))
1138
self._write_inventory(inv)
1141
def revert(self, filenames, old_tree=None, backups=True,
1142
pb=DummyProgress()):
1143
from transform import revert
1144
from conflicts import resolve
1145
if old_tree is None:
1146
old_tree = self.basis_tree()
1147
revert(self, old_tree, filenames, backups, pb)
1148
if not len(filenames):
1149
self.set_pending_merges([])
1152
resolve(self, filenames, ignore_misses=True)
1155
def set_inventory(self, new_inventory_list):
1156
from bzrlib.inventory import (Inventory,
1161
inv = Inventory(self.get_root_id())
1162
for path, file_id, parent, kind in new_inventory_list:
1163
name = os.path.basename(path)
1166
# fixme, there should be a factory function inv,add_??
1167
if kind == 'directory':
1168
inv.add(InventoryDirectory(file_id, name, parent))
1169
elif kind == 'file':
1170
inv.add(InventoryFile(file_id, name, parent))
1171
elif kind == 'symlink':
1172
inv.add(InventoryLink(file_id, name, parent))
1174
raise BzrError("unknown kind %r" % kind)
1175
self._write_inventory(inv)
1178
def set_root_id(self, file_id):
1179
"""Set the root id for this tree."""
1180
inv = self.read_working_inventory()
1181
orig_root_id = inv.root.file_id
1182
del inv._byid[inv.root.file_id]
1183
inv.root.file_id = file_id
1184
inv._byid[inv.root.file_id] = inv.root
1187
if entry.parent_id == orig_root_id:
1188
entry.parent_id = inv.root.file_id
1189
self._write_inventory(inv)
1192
"""See Branch.unlock.
1194
WorkingTree locking just uses the Branch locking facilities.
1195
This is current because all working trees have an embedded branch
1196
within them. IF in the future, we were to make branch data shareable
1197
between multiple working trees, i.e. via shared storage, then we
1198
would probably want to lock both the local tree, and the branch.
1200
# FIXME: We want to write out the hashcache only when the last lock on
1201
# this working copy is released. Peeking at the lock count is a bit
1202
# of a nasty hack; probably it's better to have a transaction object,
1203
# which can do some finalization when it's either successfully or
1204
# unsuccessfully completed. (Denys's original patch did that.)
1205
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1206
# wrongly. Hookinh into unllock on the control files object is fine though.
1208
# TODO: split this per format so there is no ugly if block
1209
if self._hashcache.needs_write and (
1210
# dedicated lock files
1211
self._control_files._lock_count==1 or
1213
(self._control_files is self.branch.control_files and
1214
self._control_files._lock_count==3)):
1215
self._hashcache.write()
1216
# reverse order of locking.
1217
result = self._control_files.unlock()
1219
self.branch.unlock()
1225
"""Update a working tree along its branch.
1227
This will update the branch if its bound too, which means we have multiple trees involved:
1228
The new basis tree of the master.
1229
The old basis tree of the branch.
1230
The old basis tree of the working tree.
1231
The current working tree state.
1232
pathologically all three may be different, and non ancestors of each other.
1233
Conceptually we want to:
1234
Preserve the wt.basis->wt.state changes
1235
Transform the wt.basis to the new master basis.
1236
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1237
Restore the wt.basis->wt.state changes.
1239
There isn't a single operation at the moment to do that, so we:
1240
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1241
Do a 'normal' merge of the old branch basis if it is relevant.
1243
old_tip = self.branch.update()
1244
if old_tip is not None:
1245
self.add_pending_merge(old_tip)
1246
self.branch.lock_read()
1249
if self.last_revision() != self.branch.last_revision():
1250
# merge tree state up to new branch tip.
1251
basis = self.basis_tree()
1252
to_tree = self.branch.basis_tree()
1253
result += merge_inner(self.branch,
1257
self.set_last_revision(self.branch.last_revision())
1258
if old_tip and old_tip != self.last_revision():
1259
# our last revision was not the prior branch last reivison
1260
# and we have converted that last revision to a pending merge.
1261
# base is somewhere between the branch tip now
1262
# and the now pending merge
1263
from bzrlib.revision import common_ancestor
1265
base_rev_id = common_ancestor(self.branch.last_revision(),
1267
self.branch.repository)
1268
except errors.NoCommonAncestor:
1270
base_tree = self.branch.repository.revision_tree(base_rev_id)
1271
other_tree = self.branch.repository.revision_tree(old_tip)
1272
result += merge_inner(self.branch,
1278
self.branch.unlock()
1281
def _write_inventory(self, inv):
1282
"""Write inventory as the current inventory."""
1284
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1286
self._control_files.put('inventory', sio)
1287
self._set_inventory(inv)
1288
mutter('wrote working inventory')
1290
def set_conflict_lines(self, arg):
1291
raise UnsupportedOperation(self.set_conflict_lines, self)
1294
def conflict_lines(self):
1295
for conflicted in self._iter_conflicts():
1298
if file_kind(self.abspath(conflicted)) != "file":
1301
if e.errno == errno.ENOENT:
1306
for suffix in ('.THIS', '.OTHER'):
1308
kind = file_kind(self.abspath(conflicted+suffix))
1310
if e.errno == errno.ENOENT:
1318
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1319
yield Conflict.factory(ctype, path=conflicted,
1320
file_id=self.path2id(conflicted))
1322
class WorkingTree3(WorkingTree):
1323
"""This is the Format 3 working tree.
1325
This differs from the base WorkingTree by:
1326
- having its own file lock
1327
- having its own last-revision property.
1329
This is new in bzr 0.8
1333
def last_revision(self):
1334
"""See WorkingTree.last_revision."""
1336
return self._control_files.get_utf8('last-revision').read()
1340
def _change_last_revision(self, revision_id):
1341
"""See WorkingTree._change_last_revision."""
1342
if revision_id is None or revision_id == NULL_REVISION:
1344
self._control_files._transport.delete('last-revision')
1345
except errors.NoSuchFile:
1350
self.branch.revision_history().index(revision_id)
1352
raise errors.NoSuchRevision(self.branch, revision_id)
1353
self._control_files.put_utf8('last-revision', revision_id)
1357
def set_conflict_lines(self, lines):
1358
self._put_rio('conflicts', conflict_stanzas(lines), CONFLICT_HEADER_1)
1361
def conflict_lines(self):
1363
confile = self._control_files.get('conflicts')
1367
if confile.next() != CONFLICT_HEADER_1 + '\n':
1368
raise ConflictFormatError()
1369
except StopIteration:
1370
raise ConflictFormatError()
1371
return stanza_conflicts(RioReader(confile))
1374
def get_conflicted_stem(path):
1375
for suffix in CONFLICT_SUFFIXES:
1376
if path.endswith(suffix):
1377
return path[:-len(suffix)]
1379
@deprecated_function(zero_eight)
1380
def is_control_file(filename):
1381
"""See WorkingTree.is_control_filename(filename)."""
1382
## FIXME: better check
1383
filename = normpath(filename)
1384
while filename != '':
1385
head, tail = os.path.split(filename)
1386
## mutter('check %r for control file' % ((head, tail),))
1389
if filename == head:
1395
class WorkingTreeFormat(object):
1396
"""An encapsulation of the initialization and open routines for a format.
1398
Formats provide three things:
1399
* An initialization routine,
1403
Formats are placed in an dict by their format string for reference
1404
during workingtree opening. Its not required that these be instances, they
1405
can be classes themselves with class methods - it simply depends on
1406
whether state is needed for a given format or not.
1408
Once a format is deprecated, just deprecate the initialize and open
1409
methods on the format class. Do not deprecate the object, as the
1410
object will be created every time regardless.
1413
_default_format = None
1414
"""The default format used for new trees."""
1417
"""The known formats."""
1420
def find_format(klass, a_bzrdir):
1421
"""Return the format for the working tree object in a_bzrdir."""
1423
transport = a_bzrdir.get_workingtree_transport(None)
1424
format_string = transport.get("format").read()
1425
return klass._formats[format_string]
1427
raise errors.NoWorkingTree(base=transport.base)
1429
raise errors.UnknownFormatError(format_string)
1432
def get_default_format(klass):
1433
"""Return the current default format."""
1434
return klass._default_format
1436
def get_format_string(self):
1437
"""Return the ASCII format string that identifies this format."""
1438
raise NotImplementedError(self.get_format_string)
1440
def is_supported(self):
1441
"""Is this format supported?
1443
Supported formats can be initialized and opened.
1444
Unsupported formats may not support initialization or committing or
1445
some other features depending on the reason for not being supported.
1450
def register_format(klass, format):
1451
klass._formats[format.get_format_string()] = format
1454
def set_default_format(klass, format):
1455
klass._default_format = format
1458
def unregister_format(klass, format):
1459
assert klass._formats[format.get_format_string()] is format
1460
del klass._formats[format.get_format_string()]
1464
class WorkingTreeFormat2(WorkingTreeFormat):
1465
"""The second working tree format.
1467
This format modified the hash cache from the format 1 hash cache.
1470
def initialize(self, a_bzrdir, revision_id=None):
1471
"""See WorkingTreeFormat.initialize()."""
1472
if not isinstance(a_bzrdir.transport, LocalTransport):
1473
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1474
branch = a_bzrdir.open_branch()
1475
if revision_id is not None:
1478
revision_history = branch.revision_history()
1480
position = revision_history.index(revision_id)
1482
raise errors.NoSuchRevision(branch, revision_id)
1483
branch.set_revision_history(revision_history[:position + 1])
1486
revision = branch.last_revision()
1488
wt = WorkingTree(a_bzrdir.root_transport.base,
1494
wt._write_inventory(inv)
1495
wt.set_root_id(inv.root.file_id)
1496
wt.set_last_revision(revision)
1497
wt.set_pending_merges([])
1498
build_tree(wt.basis_tree(), wt)
1502
super(WorkingTreeFormat2, self).__init__()
1503
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1505
def open(self, a_bzrdir, _found=False):
1506
"""Return the WorkingTree object for a_bzrdir
1508
_found is a private parameter, do not use it. It is used to indicate
1509
if format probing has already been done.
1512
# we are being called directly and must probe.
1513
raise NotImplementedError
1514
if not isinstance(a_bzrdir.transport, LocalTransport):
1515
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1516
return WorkingTree(a_bzrdir.root_transport.base,
1522
class WorkingTreeFormat3(WorkingTreeFormat):
1523
"""The second working tree format updated to record a format marker.
1526
- exists within a metadir controlling .bzr
1527
- includes an explicit version marker for the workingtree control
1528
files, separate from the BzrDir format
1529
- modifies the hash cache format
1531
- uses a LockDir to guard access to the repository
1534
def get_format_string(self):
1535
"""See WorkingTreeFormat.get_format_string()."""
1536
return "Bazaar-NG Working Tree format 3"
1538
_lock_file_name = 'lock'
1539
_lock_class = LockDir
1541
def _open_control_files(self, a_bzrdir):
1542
transport = a_bzrdir.get_workingtree_transport(None)
1543
return LockableFiles(transport, self._lock_file_name,
1546
def initialize(self, a_bzrdir, revision_id=None):
1547
"""See WorkingTreeFormat.initialize().
1549
revision_id allows creating a working tree at a differnet
1550
revision than the branch is at.
1552
if not isinstance(a_bzrdir.transport, LocalTransport):
1553
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1554
transport = a_bzrdir.get_workingtree_transport(self)
1555
control_files = self._open_control_files(a_bzrdir)
1556
control_files.create_lock()
1557
control_files.put_utf8('format', self.get_format_string())
1558
branch = a_bzrdir.open_branch()
1559
if revision_id is None:
1560
revision_id = branch.last_revision()
1562
wt = WorkingTree3(a_bzrdir.root_transport.base,
1568
_control_files=control_files)
1569
wt._write_inventory(inv)
1570
wt.set_root_id(inv.root.file_id)
1571
wt.set_last_revision(revision_id)
1572
wt.set_pending_merges([])
1573
build_tree(wt.basis_tree(), wt)
1577
super(WorkingTreeFormat3, self).__init__()
1578
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1580
def open(self, a_bzrdir, _found=False):
1581
"""Return the WorkingTree object for a_bzrdir
1583
_found is a private parameter, do not use it. It is used to indicate
1584
if format probing has already been done.
1587
# we are being called directly and must probe.
1588
raise NotImplementedError
1589
if not isinstance(a_bzrdir.transport, LocalTransport):
1590
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1591
control_files = self._open_control_files(a_bzrdir)
1592
return WorkingTree3(a_bzrdir.root_transport.base,
1596
_control_files=control_files)
1599
return self.get_format_string()
1602
# formats which have no format string are not discoverable
1603
# and not independently creatable, so are not registered.
1604
__default_format = WorkingTreeFormat3()
1605
WorkingTreeFormat.register_format(__default_format)
1606
WorkingTreeFormat.set_default_format(__default_format)
1607
_legacy_formats = [WorkingTreeFormat2(),
1611
class WorkingTreeTestProviderAdapter(object):
1612
"""A tool to generate a suite testing multiple workingtree formats at once.
1614
This is done by copying the test once for each transport and injecting
1615
the transport_server, transport_readonly_server, and workingtree_format
1616
classes into each copy. Each copy is also given a new id() to make it
1620
def __init__(self, transport_server, transport_readonly_server, formats):
1621
self._transport_server = transport_server
1622
self._transport_readonly_server = transport_readonly_server
1623
self._formats = formats
1625
def adapt(self, test):
1626
from bzrlib.tests import TestSuite
1627
result = TestSuite()
1628
for workingtree_format, bzrdir_format in self._formats:
1629
new_test = deepcopy(test)
1630
new_test.transport_server = self._transport_server
1631
new_test.transport_readonly_server = self._transport_readonly_server
1632
new_test.bzrdir_format = bzrdir_format
1633
new_test.workingtree_format = workingtree_format
1634
def make_new_test_id():
1635
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1636
return lambda: new_id
1637
new_test.id = make_new_test_id()
1638
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
