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.trace import mutter
92
from bzrlib.transform import build_tree
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()
354
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
357
if inv is not None and inv.revision_id == revision_id:
358
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
360
# FIXME? RBC 20060403 should we cache the inventory here ?
361
return self.branch.repository.revision_tree(revision_id)
364
@deprecated_method(zero_eight)
365
def create(branch, directory):
366
"""Create a workingtree for branch at directory.
368
If existing_directory already exists it must have a .bzr directory.
369
If it does not exist, it will be created.
371
This returns a new WorkingTree object for the new checkout.
373
TODO FIXME RBC 20060124 when we have checkout formats in place this
374
should accept an optional revisionid to checkout [and reject this if
375
checking out into the same dir as a pre-checkout-aware branch format.]
377
XXX: When BzrDir is present, these should be created through that
380
warn('delete WorkingTree.create', stacklevel=3)
381
transport = get_transport(directory)
382
if branch.bzrdir.root_transport.base == transport.base:
384
return branch.bzrdir.create_workingtree()
385
# different directory,
386
# create a branch reference
387
# and now a working tree.
388
raise NotImplementedError
391
@deprecated_method(zero_eight)
392
def create_standalone(directory):
393
"""Create a checkout and a branch and a repo at directory.
395
Directory must exist and be empty.
397
please use BzrDir.create_standalone_workingtree
399
return bzrdir.BzrDir.create_standalone_workingtree(directory)
401
def relpath(self, abs):
402
"""Return the local path portion from a given absolute path."""
403
return relpath(self.basedir, abs)
405
def has_filename(self, filename):
406
return bzrlib.osutils.lexists(self.abspath(filename))
408
def get_file(self, file_id):
409
return self.get_file_byname(self.id2path(file_id))
411
def get_file_byname(self, filename):
412
return file(self.abspath(filename), 'rb')
414
def get_root_id(self):
415
"""Return the id of this trees root"""
416
inv = self.read_working_inventory()
417
return inv.root.file_id
419
def _get_store_filename(self, file_id):
420
## XXX: badly named; this is not in the store at all
421
return self.abspath(self.id2path(file_id))
424
def clone(self, to_bzrdir, revision_id=None, basis=None):
425
"""Duplicate this working tree into to_bzr, including all state.
427
Specifically modified files are kept as modified, but
428
ignored and unknown files are discarded.
430
If you want to make a new line of development, see bzrdir.sprout()
433
If not None, the cloned tree will have its last revision set to
434
revision, and and difference between the source trees last revision
435
and this one merged in.
438
If not None, a closer copy of a tree which may have some files in
439
common, and which file content should be preferentially copied from.
441
# assumes the target bzr dir format is compatible.
442
result = self._format.initialize(to_bzrdir)
443
self.copy_content_into(result, revision_id)
447
def copy_content_into(self, tree, revision_id=None):
448
"""Copy the current content and user files of this tree into tree."""
449
if revision_id is None:
450
transform_tree(tree, self)
452
# TODO now merge from tree.last_revision to revision
453
transform_tree(tree, self)
454
tree.set_last_revision(revision_id)
457
def commit(self, message=None, revprops=None, *args, **kwargs):
458
# avoid circular imports
459
from bzrlib.commit import Commit
462
if not 'branch-nick' in revprops:
463
revprops['branch-nick'] = self.branch.nick
464
# args for wt.commit start at message from the Commit.commit method,
465
# but with branch a kwarg now, passing in args as is results in the
466
#message being used for the branch
467
args = (DEPRECATED_PARAMETER, message, ) + args
468
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
469
self._set_inventory(self.read_working_inventory())
471
def id2abspath(self, file_id):
472
return self.abspath(self.id2path(file_id))
474
def has_id(self, file_id):
475
# files that have been deleted are excluded
476
inv = self._inventory
477
if not inv.has_id(file_id):
479
path = inv.id2path(file_id)
480
return bzrlib.osutils.lexists(self.abspath(path))
482
def has_or_had_id(self, file_id):
483
if file_id == self.inventory.root.file_id:
485
return self.inventory.has_id(file_id)
487
__contains__ = has_id
489
def get_file_size(self, file_id):
490
return os.path.getsize(self.id2abspath(file_id))
493
def get_file_sha1(self, file_id):
494
path = self._inventory.id2path(file_id)
495
return self._hashcache.get_sha1(path)
497
def is_executable(self, file_id):
498
if not supports_executable():
499
return self._inventory[file_id].executable
501
path = self._inventory.id2path(file_id)
502
mode = os.lstat(self.abspath(path)).st_mode
503
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
506
def add(self, files, ids=None):
507
"""Make files versioned.
509
Note that the command line normally calls smart_add instead,
510
which can automatically recurse.
512
This adds the files to the inventory, so that they will be
513
recorded by the next commit.
516
List of paths to add, relative to the base of the tree.
519
If set, use these instead of automatically generated ids.
520
Must be the same length as the list of files, but may
521
contain None for ids that are to be autogenerated.
523
TODO: Perhaps have an option to add the ids even if the files do
526
TODO: Perhaps callback with the ids and paths as they're added.
528
# TODO: Re-adding a file that is removed in the working copy
529
# should probably put it back with the previous ID.
530
if isinstance(files, basestring):
531
assert(ids is None or isinstance(ids, basestring))
537
ids = [None] * len(files)
539
assert(len(ids) == len(files))
541
inv = self.read_working_inventory()
542
for f,file_id in zip(files, ids):
543
if self.is_control_filename(f):
544
raise BzrError("cannot add control file %s" % quotefn(f))
549
raise BzrError("cannot add top-level %r" % f)
551
fullpath = normpath(self.abspath(f))
554
kind = file_kind(fullpath)
556
if e.errno == errno.ENOENT:
557
raise NoSuchFile(fullpath)
558
# maybe something better?
559
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
561
if not InventoryEntry.versionable_kind(kind):
562
raise BzrError('cannot add: not a versionable file ('
563
'i.e. regular file, symlink or directory): %s' % quotefn(f))
566
file_id = gen_file_id(f)
567
inv.add_path(f, kind=kind, file_id=file_id)
569
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
570
self._write_inventory(inv)
573
def add_pending_merge(self, *revision_ids):
574
# TODO: Perhaps should check at this point that the
575
# history of the revision is actually present?
576
p = self.pending_merges()
578
for rev_id in revision_ids:
584
self.set_pending_merges(p)
587
def pending_merges(self):
588
"""Return a list of pending merges.
590
These are revisions that have been merged into the working
591
directory but not yet committed.
594
merges_file = self._control_files.get_utf8('pending-merges')
596
if e.errno != errno.ENOENT:
600
for l in merges_file.readlines():
601
p.append(l.rstrip('\n'))
605
def set_pending_merges(self, rev_list):
606
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
609
def set_merge_modified(self, modified_hashes):
611
my_file.write(MERGE_MODIFIED_HEADER_1 + '\n')
612
writer = RioWriter(my_file)
613
for file_id, hash in modified_hashes.iteritems():
614
s = Stanza(file_id=file_id, hash=hash)
615
writer.write_stanza(s)
617
self._control_files.put('merge-hashes', my_file)
620
def merge_modified(self):
622
hashfile = self._control_files.get('merge-hashes')
627
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
628
raise MergeModifiedFormatError()
629
except StopIteration:
630
raise MergeModifiedFormatError()
631
for s in RioReader(hashfile):
632
file_id = s.get("file_id")
634
if hash == self.get_file_sha1(file_id):
635
merge_hashes[file_id] = hash
638
def get_symlink_target(self, file_id):
639
return os.readlink(self.id2abspath(file_id))
641
def file_class(self, filename):
642
if self.path2id(filename):
644
elif self.is_ignored(filename):
649
def list_files(self):
650
"""Recursively list all files as (path, class, kind, id).
652
Lists, but does not descend into unversioned directories.
654
This does not include files that have been deleted in this
657
Skips the control directory.
659
inv = self._inventory
661
def descend(from_dir_relpath, from_dir_id, dp):
665
## TODO: If we find a subdirectory with its own .bzr
666
## directory, then that is a separate tree and we
667
## should exclude it.
669
# the bzrdir for this tree
670
if self.bzrdir.transport.base.endswith(f + '/'):
674
fp = appendpath(from_dir_relpath, f)
677
fap = appendpath(dp, f)
679
f_ie = inv.get_child(from_dir_id, f)
682
elif self.is_ignored(fp):
691
raise BzrCheckError("file %r entered as kind %r id %r, "
693
% (fap, f_ie.kind, f_ie.file_id, fk))
695
# make a last minute entry
699
if fk == 'directory':
700
entry = TreeDirectory()
703
elif fk == 'symlink':
708
yield fp, c, fk, (f_ie and f_ie.file_id), entry
710
if fk != 'directory':
714
# don't descend unversioned directories
717
for ff in descend(fp, f_ie.file_id, fap):
720
for f in descend(u'', inv.root.file_id, self.basedir):
724
def move(self, from_paths, to_name):
727
to_name must exist in the inventory.
729
If to_name exists and is a directory, the files are moved into
730
it, keeping their old names.
732
Note that to_name is only the last component of the new name;
733
this doesn't change the directory.
735
This returns a list of (from_path, to_path) pairs for each
739
## TODO: Option to move IDs only
740
assert not isinstance(from_paths, basestring)
742
to_abs = self.abspath(to_name)
743
if not isdir(to_abs):
744
raise BzrError("destination %r is not a directory" % to_abs)
745
if not self.has_filename(to_name):
746
raise BzrError("destination %r not in working directory" % to_abs)
747
to_dir_id = inv.path2id(to_name)
748
if to_dir_id == None and to_name != '':
749
raise BzrError("destination %r is not a versioned directory" % to_name)
750
to_dir_ie = inv[to_dir_id]
751
if to_dir_ie.kind not in ('directory', 'root_directory'):
752
raise BzrError("destination %r is not a directory" % to_abs)
754
to_idpath = inv.get_idpath(to_dir_id)
757
if not self.has_filename(f):
758
raise BzrError("%r does not exist in working tree" % f)
759
f_id = inv.path2id(f)
761
raise BzrError("%r is not versioned" % f)
762
name_tail = splitpath(f)[-1]
763
dest_path = appendpath(to_name, name_tail)
764
if self.has_filename(dest_path):
765
raise BzrError("destination %r already exists" % dest_path)
766
if f_id in to_idpath:
767
raise BzrError("can't move %r to a subdirectory of itself" % f)
769
# OK, so there's a race here, it's possible that someone will
770
# create a file in this interval and then the rename might be
771
# left half-done. But we should have caught most problems.
772
orig_inv = deepcopy(self.inventory)
775
name_tail = splitpath(f)[-1]
776
dest_path = appendpath(to_name, name_tail)
777
result.append((f, dest_path))
778
inv.rename(inv.path2id(f), to_dir_id, name_tail)
780
rename(self.abspath(f), self.abspath(dest_path))
782
raise BzrError("failed to rename %r to %r: %s" %
783
(f, dest_path, e[1]),
784
["rename rolled back"])
786
# restore the inventory on error
787
self._set_inventory(orig_inv)
789
self._write_inventory(inv)
793
def rename_one(self, from_rel, to_rel):
796
This can change the directory or the filename or both.
799
if not self.has_filename(from_rel):
800
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
801
if self.has_filename(to_rel):
802
raise BzrError("can't rename: new working file %r already exists" % to_rel)
804
file_id = inv.path2id(from_rel)
806
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
809
from_parent = entry.parent_id
810
from_name = entry.name
812
if inv.path2id(to_rel):
813
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
815
to_dir, to_tail = os.path.split(to_rel)
816
to_dir_id = inv.path2id(to_dir)
817
if to_dir_id == None and to_dir != '':
818
raise BzrError("can't determine destination directory id for %r" % to_dir)
820
mutter("rename_one:")
821
mutter(" file_id {%s}" % file_id)
822
mutter(" from_rel %r" % from_rel)
823
mutter(" to_rel %r" % to_rel)
824
mutter(" to_dir %r" % to_dir)
825
mutter(" to_dir_id {%s}" % to_dir_id)
827
inv.rename(file_id, to_dir_id, to_tail)
829
from_abs = self.abspath(from_rel)
830
to_abs = self.abspath(to_rel)
832
rename(from_abs, to_abs)
834
inv.rename(file_id, from_parent, from_name)
835
raise BzrError("failed to rename %r to %r: %s"
836
% (from_abs, to_abs, e[1]),
837
["rename rolled back"])
838
self._write_inventory(inv)
842
"""Return all unknown files.
844
These are files in the working directory that are not versioned or
845
control files or ignored.
847
>>> from bzrlib.bzrdir import ScratchDir
848
>>> d = ScratchDir(files=['foo', 'foo~'])
849
>>> b = d.open_branch()
850
>>> tree = d.open_workingtree()
851
>>> map(str, tree.unknowns())
854
>>> list(b.unknowns())
856
>>> tree.remove('foo')
857
>>> list(b.unknowns())
860
for subp in self.extras():
861
if not self.is_ignored(subp):
864
def iter_conflicts(self):
866
for path in (s[0] for s in self.list_files()):
867
stem = get_conflicted_stem(path)
870
if stem not in conflicted:
875
def pull(self, source, overwrite=False, stop_revision=None):
876
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
879
pp = ProgressPhase("Pull phase", 2, top_pb)
881
old_revision_history = self.branch.revision_history()
882
basis_tree = self.basis_tree()
883
count = self.branch.pull(source, overwrite, stop_revision)
884
new_revision_history = self.branch.revision_history()
885
if new_revision_history != old_revision_history:
887
if len(old_revision_history):
888
other_revision = old_revision_history[-1]
890
other_revision = None
891
repository = self.branch.repository
892
pb = bzrlib.ui.ui_factory.nested_progress_bar()
894
merge_inner(self.branch,
895
self.branch.basis_tree(),
901
self.set_last_revision(self.branch.last_revision())
908
"""Yield all unknown files in this WorkingTree.
910
If there are any unknown directories then only the directory is
911
returned, not all its children. But if there are unknown files
912
under a versioned subdirectory, they are returned.
914
Currently returned depth-first, sorted by name within directories.
916
## TODO: Work from given directory downwards
917
for path, dir_entry in self.inventory.directories():
918
mutter("search for unknowns in %r", path)
919
dirabs = self.abspath(path)
920
if not isdir(dirabs):
921
# e.g. directory deleted
925
for subf in os.listdir(dirabs):
927
and (subf not in dir_entry.children)):
932
subp = appendpath(path, subf)
936
def ignored_files(self):
937
"""Yield list of PATH, IGNORE_PATTERN"""
938
for subp in self.extras():
939
pat = self.is_ignored(subp)
944
def get_ignore_list(self):
945
"""Return list of ignore patterns.
947
Cached in the Tree object after the first call.
949
if hasattr(self, '_ignorelist'):
950
return self._ignorelist
952
l = bzrlib.DEFAULT_IGNORE[:]
953
if self.has_filename(bzrlib.IGNORE_FILENAME):
954
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
955
l.extend([line.rstrip("\n\r") for line in f.readlines()])
960
def is_ignored(self, filename):
961
r"""Check whether the filename matches an ignore pattern.
963
Patterns containing '/' or '\' need to match the whole path;
964
others match against only the last component.
966
If the file is ignored, returns the pattern which caused it to
967
be ignored, otherwise None. So this can simply be used as a
968
boolean if desired."""
970
# TODO: Use '**' to match directories, and other extended
971
# globbing stuff from cvs/rsync.
973
# XXX: fnmatch is actually not quite what we want: it's only
974
# approximately the same as real Unix fnmatch, and doesn't
975
# treat dotfiles correctly and allows * to match /.
976
# Eventually it should be replaced with something more
979
for pat in self.get_ignore_list():
980
if '/' in pat or '\\' in pat:
982
# as a special case, you can put ./ at the start of a
983
# pattern; this is good to match in the top-level
986
if (pat[:2] == './') or (pat[:2] == '.\\'):
990
if fnmatch.fnmatchcase(filename, newpat):
993
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
998
def kind(self, file_id):
999
return file_kind(self.id2abspath(file_id))
1002
def last_revision(self):
1003
"""Return the last revision id of this working tree.
1005
In early branch formats this was == the branch last_revision,
1006
but that cannot be relied upon - for working tree operations,
1007
always use tree.last_revision().
1009
return self.branch.last_revision()
1011
def lock_read(self):
1012
"""See Branch.lock_read, and WorkingTree.unlock."""
1013
self.branch.lock_read()
1015
return self._control_files.lock_read()
1017
self.branch.unlock()
1020
def lock_write(self):
1021
"""See Branch.lock_write, and WorkingTree.unlock."""
1022
self.branch.lock_write()
1024
return self._control_files.lock_write()
1026
self.branch.unlock()
1029
def _basis_inventory_name(self):
1030
return 'basis-inventory'
1033
def set_last_revision(self, new_revision):
1034
"""Change the last revision in the working tree."""
1035
if self._change_last_revision(new_revision):
1036
self._cache_basis_inventory(new_revision)
1038
def _change_last_revision(self, new_revision):
1039
"""Template method part of set_last_revision to perform the change.
1041
This is used to allow WorkingTree3 instances to not affect branch
1042
when their last revision is set.
1044
if new_revision is None:
1045
self.branch.set_revision_history([])
1047
# current format is locked in with the branch
1048
revision_history = self.branch.revision_history()
1050
position = revision_history.index(new_revision)
1052
raise errors.NoSuchRevision(self.branch, new_revision)
1053
self.branch.set_revision_history(revision_history[:position + 1])
1056
def _cache_basis_inventory(self, new_revision):
1057
"""Cache new_revision as the basis inventory."""
1059
# this double handles the inventory - unpack and repack -
1060
# but is easier to understand. We can/should put a conditional
1061
# in here based on whether the inventory is in the latest format
1062
# - perhaps we should repack all inventories on a repository
1064
inv = self.branch.repository.get_inventory(new_revision)
1065
inv.revision_id = new_revision
1066
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1068
path = self._basis_inventory_name()
1069
self._control_files.put_utf8(path, xml)
1070
except WeaveRevisionNotPresent:
1073
def read_basis_inventory(self):
1074
"""Read the cached basis inventory."""
1075
path = self._basis_inventory_name()
1076
return self._control_files.get_utf8(path).read()
1079
def read_working_inventory(self):
1080
"""Read the working inventory."""
1081
# ElementTree does its own conversion from UTF-8, so open in
1083
result = bzrlib.xml5.serializer_v5.read_inventory(
1084
self._control_files.get('inventory'))
1085
self._set_inventory(result)
1089
def remove(self, files, verbose=False):
1090
"""Remove nominated files from the working inventory..
1092
This does not remove their text. This does not run on XXX on what? RBC
1094
TODO: Refuse to remove modified files unless --force is given?
1096
TODO: Do something useful with directories.
1098
TODO: Should this remove the text or not? Tough call; not
1099
removing may be useful and the user can just use use rm, and
1100
is the opposite of add. Removing it is consistent with most
1101
other tools. Maybe an option.
1103
## TODO: Normalize names
1104
## TODO: Remove nested loops; better scalability
1105
if isinstance(files, basestring):
1108
inv = self.inventory
1110
# do this before any modifications
1112
fid = inv.path2id(f)
1114
# TODO: Perhaps make this just a warning, and continue?
1115
# This tends to happen when
1116
raise NotVersionedError(path=f)
1117
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1119
# having remove it, it must be either ignored or unknown
1120
if self.is_ignored(f):
1124
show_status(new_status, inv[fid].kind, quotefn(f))
1127
self._write_inventory(inv)
1130
def revert(self, filenames, old_tree=None, backups=True,
1131
pb=DummyProgress()):
1132
from transform import revert
1133
if old_tree is None:
1134
old_tree = self.basis_tree()
1135
revert(self, old_tree, filenames, backups, pb)
1136
if not len(filenames):
1137
self.set_pending_merges([])
1140
def set_inventory(self, new_inventory_list):
1141
from bzrlib.inventory import (Inventory,
1146
inv = Inventory(self.get_root_id())
1147
for path, file_id, parent, kind in new_inventory_list:
1148
name = os.path.basename(path)
1151
# fixme, there should be a factory function inv,add_??
1152
if kind == 'directory':
1153
inv.add(InventoryDirectory(file_id, name, parent))
1154
elif kind == 'file':
1155
inv.add(InventoryFile(file_id, name, parent))
1156
elif kind == 'symlink':
1157
inv.add(InventoryLink(file_id, name, parent))
1159
raise BzrError("unknown kind %r" % kind)
1160
self._write_inventory(inv)
1163
def set_root_id(self, file_id):
1164
"""Set the root id for this tree."""
1165
inv = self.read_working_inventory()
1166
orig_root_id = inv.root.file_id
1167
del inv._byid[inv.root.file_id]
1168
inv.root.file_id = file_id
1169
inv._byid[inv.root.file_id] = inv.root
1172
if entry.parent_id == orig_root_id:
1173
entry.parent_id = inv.root.file_id
1174
self._write_inventory(inv)
1177
"""See Branch.unlock.
1179
WorkingTree locking just uses the Branch locking facilities.
1180
This is current because all working trees have an embedded branch
1181
within them. IF in the future, we were to make branch data shareable
1182
between multiple working trees, i.e. via shared storage, then we
1183
would probably want to lock both the local tree, and the branch.
1185
# FIXME: We want to write out the hashcache only when the last lock on
1186
# this working copy is released. Peeking at the lock count is a bit
1187
# of a nasty hack; probably it's better to have a transaction object,
1188
# which can do some finalization when it's either successfully or
1189
# unsuccessfully completed. (Denys's original patch did that.)
1190
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1191
# wrongly. Hookinh into unllock on the control files object is fine though.
1193
# TODO: split this per format so there is no ugly if block
1194
if self._hashcache.needs_write and (
1195
# dedicated lock files
1196
self._control_files._lock_count==1 or
1198
(self._control_files is self.branch.control_files and
1199
self._control_files._lock_count==3)):
1200
self._hashcache.write()
1201
# reverse order of locking.
1202
result = self._control_files.unlock()
1204
self.branch.unlock()
1210
"""Update a working tree along its branch.
1212
This will update the branch if its bound too, which means we have multiple trees involved:
1213
The new basis tree of the master.
1214
The old basis tree of the branch.
1215
The old basis tree of the working tree.
1216
The current working tree state.
1217
pathologically all three may be different, and non ancestors of each other.
1218
Conceptually we want to:
1219
Preserve the wt.basis->wt.state changes
1220
Transform the wt.basis to the new master basis.
1221
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1222
Restore the wt.basis->wt.state changes.
1224
There isn't a single operation at the moment to do that, so we:
1225
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1226
Do a 'normal' merge of the old branch basis if it is relevant.
1228
old_tip = self.branch.update()
1229
if old_tip is not None:
1230
self.add_pending_merge(old_tip)
1231
self.branch.lock_read()
1234
if self.last_revision() != self.branch.last_revision():
1235
# merge tree state up to new branch tip.
1236
basis = self.basis_tree()
1237
to_tree = self.branch.basis_tree()
1238
result += merge_inner(self.branch,
1242
self.set_last_revision(self.branch.last_revision())
1243
if old_tip and old_tip != self.last_revision():
1244
# our last revision was not the prior branch last reivison
1245
# and we have converted that last revision to a pending merge.
1246
# base is somewhere between the branch tip now
1247
# and the now pending merge
1248
from bzrlib.revision import common_ancestor
1250
base_rev_id = common_ancestor(self.branch.last_revision(),
1252
self.branch.repository)
1253
except errors.NoCommonAncestor:
1255
base_tree = self.branch.repository.revision_tree(base_rev_id)
1256
other_tree = self.branch.repository.revision_tree(old_tip)
1257
result += merge_inner(self.branch,
1263
self.branch.unlock()
1266
def _write_inventory(self, inv):
1267
"""Write inventory as the current inventory."""
1269
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1271
self._control_files.put('inventory', sio)
1272
self._set_inventory(inv)
1273
mutter('wrote working inventory')
1276
class WorkingTree3(WorkingTree):
1277
"""This is the Format 3 working tree.
1279
This differs from the base WorkingTree by:
1280
- having its own file lock
1281
- having its own last-revision property.
1283
This is new in bzr 0.8
1287
def last_revision(self):
1288
"""See WorkingTree.last_revision."""
1290
return self._control_files.get_utf8('last-revision').read()
1294
def _change_last_revision(self, revision_id):
1295
"""See WorkingTree._change_last_revision."""
1296
if revision_id is None or revision_id == NULL_REVISION:
1298
self._control_files._transport.delete('last-revision')
1299
except errors.NoSuchFile:
1304
self.branch.revision_history().index(revision_id)
1306
raise errors.NoSuchRevision(self.branch, revision_id)
1307
self._control_files.put_utf8('last-revision', revision_id)
1311
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1312
def get_conflicted_stem(path):
1313
for suffix in CONFLICT_SUFFIXES:
1314
if path.endswith(suffix):
1315
return path[:-len(suffix)]
1317
@deprecated_function(zero_eight)
1318
def is_control_file(filename):
1319
"""See WorkingTree.is_control_filename(filename)."""
1320
## FIXME: better check
1321
filename = normpath(filename)
1322
while filename != '':
1323
head, tail = os.path.split(filename)
1324
## mutter('check %r for control file' % ((head, tail),))
1327
if filename == head:
1333
class WorkingTreeFormat(object):
1334
"""An encapsulation of the initialization and open routines for a format.
1336
Formats provide three things:
1337
* An initialization routine,
1341
Formats are placed in an dict by their format string for reference
1342
during workingtree opening. Its not required that these be instances, they
1343
can be classes themselves with class methods - it simply depends on
1344
whether state is needed for a given format or not.
1346
Once a format is deprecated, just deprecate the initialize and open
1347
methods on the format class. Do not deprecate the object, as the
1348
object will be created every time regardless.
1351
_default_format = None
1352
"""The default format used for new trees."""
1355
"""The known formats."""
1358
def find_format(klass, a_bzrdir):
1359
"""Return the format for the working tree object in a_bzrdir."""
1361
transport = a_bzrdir.get_workingtree_transport(None)
1362
format_string = transport.get("format").read()
1363
return klass._formats[format_string]
1365
raise errors.NoWorkingTree(base=transport.base)
1367
raise errors.UnknownFormatError(format_string)
1370
def get_default_format(klass):
1371
"""Return the current default format."""
1372
return klass._default_format
1374
def get_format_string(self):
1375
"""Return the ASCII format string that identifies this format."""
1376
raise NotImplementedError(self.get_format_string)
1378
def is_supported(self):
1379
"""Is this format supported?
1381
Supported formats can be initialized and opened.
1382
Unsupported formats may not support initialization or committing or
1383
some other features depending on the reason for not being supported.
1388
def register_format(klass, format):
1389
klass._formats[format.get_format_string()] = format
1392
def set_default_format(klass, format):
1393
klass._default_format = format
1396
def unregister_format(klass, format):
1397
assert klass._formats[format.get_format_string()] is format
1398
del klass._formats[format.get_format_string()]
1402
class WorkingTreeFormat2(WorkingTreeFormat):
1403
"""The second working tree format.
1405
This format modified the hash cache from the format 1 hash cache.
1408
def initialize(self, a_bzrdir, revision_id=None):
1409
"""See WorkingTreeFormat.initialize()."""
1410
if not isinstance(a_bzrdir.transport, LocalTransport):
1411
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1412
branch = a_bzrdir.open_branch()
1413
if revision_id is not None:
1416
revision_history = branch.revision_history()
1418
position = revision_history.index(revision_id)
1420
raise errors.NoSuchRevision(branch, revision_id)
1421
branch.set_revision_history(revision_history[:position + 1])
1424
revision = branch.last_revision()
1426
wt = WorkingTree(a_bzrdir.root_transport.base,
1432
wt._write_inventory(inv)
1433
wt.set_root_id(inv.root.file_id)
1434
wt.set_last_revision(revision)
1435
wt.set_pending_merges([])
1436
build_tree(wt.basis_tree(), wt)
1440
super(WorkingTreeFormat2, self).__init__()
1441
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1443
def open(self, a_bzrdir, _found=False):
1444
"""Return the WorkingTree object for a_bzrdir
1446
_found is a private parameter, do not use it. It is used to indicate
1447
if format probing has already been done.
1450
# we are being called directly and must probe.
1451
raise NotImplementedError
1452
if not isinstance(a_bzrdir.transport, LocalTransport):
1453
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1454
return WorkingTree(a_bzrdir.root_transport.base,
1460
class WorkingTreeFormat3(WorkingTreeFormat):
1461
"""The second working tree format updated to record a format marker.
1464
- exists within a metadir controlling .bzr
1465
- includes an explicit version marker for the workingtree control
1466
files, separate from the BzrDir format
1467
- modifies the hash cache format
1469
- uses a LockDir to guard access to the repository
1472
def get_format_string(self):
1473
"""See WorkingTreeFormat.get_format_string()."""
1474
return "Bazaar-NG Working Tree format 3"
1476
_lock_file_name = 'lock'
1477
_lock_class = LockDir
1479
def _open_control_files(self, a_bzrdir):
1480
transport = a_bzrdir.get_workingtree_transport(None)
1481
return LockableFiles(transport, self._lock_file_name,
1484
def initialize(self, a_bzrdir, revision_id=None):
1485
"""See WorkingTreeFormat.initialize().
1487
revision_id allows creating a working tree at a differnet
1488
revision than the branch is at.
1490
if not isinstance(a_bzrdir.transport, LocalTransport):
1491
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1492
transport = a_bzrdir.get_workingtree_transport(self)
1493
control_files = self._open_control_files(a_bzrdir)
1494
control_files.create_lock()
1495
control_files.put_utf8('format', self.get_format_string())
1496
branch = a_bzrdir.open_branch()
1497
if revision_id is None:
1498
revision_id = branch.last_revision()
1500
wt = WorkingTree3(a_bzrdir.root_transport.base,
1506
_control_files=control_files)
1507
wt._write_inventory(inv)
1508
wt.set_root_id(inv.root.file_id)
1509
wt.set_last_revision(revision_id)
1510
wt.set_pending_merges([])
1511
build_tree(wt.basis_tree(), wt)
1515
super(WorkingTreeFormat3, self).__init__()
1516
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1518
def open(self, a_bzrdir, _found=False):
1519
"""Return the WorkingTree object for a_bzrdir
1521
_found is a private parameter, do not use it. It is used to indicate
1522
if format probing has already been done.
1525
# we are being called directly and must probe.
1526
raise NotImplementedError
1527
if not isinstance(a_bzrdir.transport, LocalTransport):
1528
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1529
control_files = self._open_control_files(a_bzrdir)
1530
return WorkingTree3(a_bzrdir.root_transport.base,
1534
_control_files=control_files)
1537
return self.get_format_string()
1540
# formats which have no format string are not discoverable
1541
# and not independently creatable, so are not registered.
1542
__default_format = WorkingTreeFormat3()
1543
WorkingTreeFormat.register_format(__default_format)
1544
WorkingTreeFormat.set_default_format(__default_format)
1545
_legacy_formats = [WorkingTreeFormat2(),
1549
class WorkingTreeTestProviderAdapter(object):
1550
"""A tool to generate a suite testing multiple workingtree formats at once.
1552
This is done by copying the test once for each transport and injecting
1553
the transport_server, transport_readonly_server, and workingtree_format
1554
classes into each copy. Each copy is also given a new id() to make it
1558
def __init__(self, transport_server, transport_readonly_server, formats):
1559
self._transport_server = transport_server
1560
self._transport_readonly_server = transport_readonly_server
1561
self._formats = formats
1563
def adapt(self, test):
1564
from bzrlib.tests import TestSuite
1565
result = TestSuite()
1566
for workingtree_format, bzrdir_format in self._formats:
1567
new_test = deepcopy(test)
1568
new_test.transport_server = self._transport_server
1569
new_test.transport_readonly_server = self._transport_readonly_server
1570
new_test.bzrdir_format = bzrdir_format
1571
new_test.workingtree_format = workingtree_format
1572
def make_new_test_id():
1573
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1574
return lambda: new_id
1575
new_test.id = make_new_test_id()
1576
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
