1
# Copyright (C) 2005 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).
33
# FIXME: I don't know if writing out the cache from the destructor is really a
34
# good idea, because destructors are considered poor taste in Python, and it's
35
# not predictable when it will be written out.
37
# TODO: Give the workingtree sole responsibility for the working inventory;
38
# remove the variable and references to it from the branch. This may require
39
# updating the commit code so as to update the inventory within the working
40
# copy, and making sure there's only one WorkingTree for any directory on disk.
41
# At the momenthey may alias the inventory and have old copies of it in memory.
43
from copy import deepcopy
44
from cStringIO import StringIO
51
from bzrlib.atomicfile import AtomicFile
52
from bzrlib.branch import (Branch,
54
import bzrlib.bzrdir as bzrdir
55
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
import bzrlib.errors as errors
57
from bzrlib.errors import (BzrCheckError,
60
WeaveRevisionNotPresent,
64
from bzrlib.inventory import InventoryEntry, Inventory
65
from bzrlib.lockable_files import LockableFiles, TransportLock
66
from bzrlib.merge import merge_inner, transform_tree
67
from bzrlib.osutils import (
85
from bzrlib.progress import DummyProgress
86
from bzrlib.revision import NULL_REVISION
87
from bzrlib.symbol_versioning import *
88
from bzrlib.textui import show_status
90
from bzrlib.trace import mutter
91
from bzrlib.transform import build_tree
92
from bzrlib.transport import get_transport
93
from bzrlib.transport.local import LocalTransport
98
def gen_file_id(name):
99
"""Return new file id.
101
This should probably generate proper UUIDs, but for the moment we
102
cope with just randomness because running uuidgen every time is
105
from binascii import hexlify
106
from time import time
109
idx = name.rfind('/')
111
name = name[idx+1 : ]
112
idx = name.rfind('\\')
114
name = name[idx+1 : ]
116
# make it not a hidden file
117
name = name.lstrip('.')
119
# remove any wierd characters; we don't escape them but rather
121
name = re.sub(r'[^\w.]', '', name)
123
s = hexlify(rand_bytes(8))
124
return '-'.join((name, compact_date(time()), s))
128
"""Return a new tree-root file id."""
129
return gen_file_id('TREE_ROOT')
132
class TreeEntry(object):
133
"""An entry that implements the minium interface used by commands.
135
This needs further inspection, it may be better to have
136
InventoryEntries without ids - though that seems wrong. For now,
137
this is a parallel hierarchy to InventoryEntry, and needs to become
138
one of several things: decorates to that hierarchy, children of, or
140
Another note is that these objects are currently only used when there is
141
no InventoryEntry available - i.e. for unversioned objects.
142
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
145
def __eq__(self, other):
146
# yes, this us ugly, TODO: best practice __eq__ style.
147
return (isinstance(other, TreeEntry)
148
and other.__class__ == self.__class__)
150
def kind_character(self):
154
class TreeDirectory(TreeEntry):
155
"""See TreeEntry. This is a directory in a working tree."""
157
def __eq__(self, other):
158
return (isinstance(other, TreeDirectory)
159
and other.__class__ == self.__class__)
161
def kind_character(self):
165
class TreeFile(TreeEntry):
166
"""See TreeEntry. This is a regular file in a working tree."""
168
def __eq__(self, other):
169
return (isinstance(other, TreeFile)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class TreeLink(TreeEntry):
177
"""See TreeEntry. This is a symlink in a working tree."""
179
def __eq__(self, other):
180
return (isinstance(other, TreeLink)
181
and other.__class__ == self.__class__)
183
def kind_character(self):
187
class WorkingTree(bzrlib.tree.Tree):
188
"""Working copy tree.
190
The inventory is held in the `Branch` working-inventory, and the
191
files are in a directory on disk.
193
It is possible for a `WorkingTree` to have a filename which is
194
not listed in the Inventory and vice versa.
197
def __init__(self, basedir='.',
198
branch=DEPRECATED_PARAMETER,
204
"""Construct a WorkingTree for basedir.
206
If the branch is not supplied, it is opened automatically.
207
If the branch is supplied, it must be the branch for this basedir.
208
(branch.base is not cross checked, because for remote branches that
209
would be meaningless).
211
self._format = _format
212
self.bzrdir = _bzrdir
214
# not created via open etc.
215
warn("WorkingTree() is deprecated as of bzr version 0.8. "
216
"Please use bzrdir.open_workingtree or WorkingTree.open().",
219
wt = WorkingTree.open(basedir)
220
self.branch = wt.branch
221
self.basedir = wt.basedir
222
self._control_files = wt._control_files
223
self._hashcache = wt._hashcache
224
self._set_inventory(wt._inventory)
225
self._format = wt._format
226
self.bzrdir = wt.bzrdir
227
from bzrlib.hashcache import HashCache
228
from bzrlib.trace import note, mutter
229
assert isinstance(basedir, basestring), \
230
"base directory %r is not a string" % basedir
231
basedir = safe_unicode(basedir)
232
mutter("opening working tree %r", basedir)
233
if deprecated_passed(branch):
235
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
236
" Please use bzrdir.open_workingtree() or WorkingTree.open().",
242
self.branch = self.bzrdir.open_branch()
243
assert isinstance(self.branch, Branch), \
244
"branch %r is not a Branch" % self.branch
245
self.basedir = realpath(basedir)
246
# if branch is at our basedir and is a format 6 or less
247
if isinstance(self._format, WorkingTreeFormat2):
248
# share control object
249
self._control_files = self.branch.control_files
250
elif _control_files is not None:
251
assert False, "not done yet"
252
# self._control_files = _control_files
254
# only ready for format 3
255
assert isinstance(self._format, WorkingTreeFormat3)
256
self._control_files = LockableFiles(
257
self.bzrdir.get_workingtree_transport(None),
258
'lock', TransportLock)
260
# update the whole cache up front and write to disk if anything changed;
261
# in the future we might want to do this more selectively
262
# two possible ways offer themselves : in self._unlock, write the cache
263
# if needed, or, when the cache sees a change, append it to the hash
264
# cache file, and have the parser take the most recent entry for a
266
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
267
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
269
# is this scan needed ? it makes things kinda slow.
276
if _inventory is None:
277
self._set_inventory(self.read_working_inventory())
279
self._set_inventory(_inventory)
281
def _set_inventory(self, inv):
282
self._inventory = inv
283
self.path2id = self._inventory.path2id
285
def is_control_filename(self, filename):
286
"""True if filename is the name of a control file in this tree.
288
This is true IF and ONLY IF the filename is part of the meta data
289
that bzr controls in this tree. I.E. a random .bzr directory placed
290
on disk will not be a control file for this tree.
293
self.bzrdir.transport.relpath(self.abspath(filename))
295
except errors.PathNotChild:
299
def open(path=None, _unsupported=False):
300
"""Open an existing working tree at path.
304
path = os.path.getcwdu()
305
control = bzrdir.BzrDir.open(path, _unsupported)
306
return control.open_workingtree(_unsupported)
309
def open_containing(path=None):
310
"""Open an existing working tree which has its root about path.
312
This probes for a working tree at path and searches upwards from there.
314
Basically we keep looking up until we find the control directory or
315
run into /. If there isn't one, raises NotBranchError.
316
TODO: give this a new exception.
317
If there is one, it is returned, along with the unused portion of path.
321
control, relpath = bzrdir.BzrDir.open_containing(path)
322
return control.open_workingtree(), relpath
325
def open_downlevel(path=None):
326
"""Open an unsupported working tree.
328
Only intended for advanced situations like upgrading part of a bzrdir.
330
return WorkingTree.open(path, _unsupported=True)
333
"""Iterate through file_ids for this tree.
335
file_ids are in a WorkingTree if they are in the working inventory
336
and the working file exists.
338
inv = self._inventory
339
for path, ie in inv.iter_entries():
340
if bzrlib.osutils.lexists(self.abspath(path)):
344
return "<%s of %s>" % (self.__class__.__name__,
345
getattr(self, 'basedir', None))
347
def abspath(self, filename):
348
return pathjoin(self.basedir, filename)
350
def basis_tree(self):
351
"""Return RevisionTree for the current last revision."""
352
revision_id = self.last_revision()
353
if revision_id is not None:
355
xml = self.read_basis_inventory(revision_id)
356
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
357
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
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))
608
def get_symlink_target(self, file_id):
609
return os.readlink(self.id2abspath(file_id))
611
def file_class(self, filename):
612
if self.path2id(filename):
614
elif self.is_ignored(filename):
619
def list_files(self):
620
"""Recursively list all files as (path, class, kind, id).
622
Lists, but does not descend into unversioned directories.
624
This does not include files that have been deleted in this
627
Skips the control directory.
629
inv = self._inventory
631
def descend(from_dir_relpath, from_dir_id, dp):
635
## TODO: If we find a subdirectory with its own .bzr
636
## directory, then that is a separate tree and we
637
## should exclude it.
639
# the bzrdir for this tree
640
if self.bzrdir.transport.base.endswith(f + '/'):
644
fp = appendpath(from_dir_relpath, f)
647
fap = appendpath(dp, f)
649
f_ie = inv.get_child(from_dir_id, f)
652
elif self.is_ignored(fp):
661
raise BzrCheckError("file %r entered as kind %r id %r, "
663
% (fap, f_ie.kind, f_ie.file_id, fk))
665
# make a last minute entry
669
if fk == 'directory':
670
entry = TreeDirectory()
673
elif fk == 'symlink':
678
yield fp, c, fk, (f_ie and f_ie.file_id), entry
680
if fk != 'directory':
684
# don't descend unversioned directories
687
for ff in descend(fp, f_ie.file_id, fap):
690
for f in descend(u'', inv.root.file_id, self.basedir):
694
def move(self, from_paths, to_name):
697
to_name must exist in the inventory.
699
If to_name exists and is a directory, the files are moved into
700
it, keeping their old names.
702
Note that to_name is only the last component of the new name;
703
this doesn't change the directory.
705
This returns a list of (from_path, to_path) pairs for each
709
## TODO: Option to move IDs only
710
assert not isinstance(from_paths, basestring)
712
to_abs = self.abspath(to_name)
713
if not isdir(to_abs):
714
raise BzrError("destination %r is not a directory" % to_abs)
715
if not self.has_filename(to_name):
716
raise BzrError("destination %r not in working directory" % to_abs)
717
to_dir_id = inv.path2id(to_name)
718
if to_dir_id == None and to_name != '':
719
raise BzrError("destination %r is not a versioned directory" % to_name)
720
to_dir_ie = inv[to_dir_id]
721
if to_dir_ie.kind not in ('directory', 'root_directory'):
722
raise BzrError("destination %r is not a directory" % to_abs)
724
to_idpath = inv.get_idpath(to_dir_id)
727
if not self.has_filename(f):
728
raise BzrError("%r does not exist in working tree" % f)
729
f_id = inv.path2id(f)
731
raise BzrError("%r is not versioned" % f)
732
name_tail = splitpath(f)[-1]
733
dest_path = appendpath(to_name, name_tail)
734
if self.has_filename(dest_path):
735
raise BzrError("destination %r already exists" % dest_path)
736
if f_id in to_idpath:
737
raise BzrError("can't move %r to a subdirectory of itself" % f)
739
# OK, so there's a race here, it's possible that someone will
740
# create a file in this interval and then the rename might be
741
# left half-done. But we should have caught most problems.
742
orig_inv = deepcopy(self.inventory)
745
name_tail = splitpath(f)[-1]
746
dest_path = appendpath(to_name, name_tail)
747
result.append((f, dest_path))
748
inv.rename(inv.path2id(f), to_dir_id, name_tail)
750
rename(self.abspath(f), self.abspath(dest_path))
752
raise BzrError("failed to rename %r to %r: %s" %
753
(f, dest_path, e[1]),
754
["rename rolled back"])
756
# restore the inventory on error
757
self._set_inventory(orig_inv)
759
self._write_inventory(inv)
763
def rename_one(self, from_rel, to_rel):
766
This can change the directory or the filename or both.
769
if not self.has_filename(from_rel):
770
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
771
if self.has_filename(to_rel):
772
raise BzrError("can't rename: new working file %r already exists" % to_rel)
774
file_id = inv.path2id(from_rel)
776
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
779
from_parent = entry.parent_id
780
from_name = entry.name
782
if inv.path2id(to_rel):
783
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
785
to_dir, to_tail = os.path.split(to_rel)
786
to_dir_id = inv.path2id(to_dir)
787
if to_dir_id == None and to_dir != '':
788
raise BzrError("can't determine destination directory id for %r" % to_dir)
790
mutter("rename_one:")
791
mutter(" file_id {%s}" % file_id)
792
mutter(" from_rel %r" % from_rel)
793
mutter(" to_rel %r" % to_rel)
794
mutter(" to_dir %r" % to_dir)
795
mutter(" to_dir_id {%s}" % to_dir_id)
797
inv.rename(file_id, to_dir_id, to_tail)
799
from_abs = self.abspath(from_rel)
800
to_abs = self.abspath(to_rel)
802
rename(from_abs, to_abs)
804
inv.rename(file_id, from_parent, from_name)
805
raise BzrError("failed to rename %r to %r: %s"
806
% (from_abs, to_abs, e[1]),
807
["rename rolled back"])
808
self._write_inventory(inv)
812
"""Return all unknown files.
814
These are files in the working directory that are not versioned or
815
control files or ignored.
817
>>> from bzrlib.bzrdir import ScratchDir
818
>>> d = ScratchDir(files=['foo', 'foo~'])
819
>>> b = d.open_branch()
820
>>> tree = d.open_workingtree()
821
>>> map(str, tree.unknowns())
824
>>> list(b.unknowns())
826
>>> tree.remove('foo')
827
>>> list(b.unknowns())
830
for subp in self.extras():
831
if not self.is_ignored(subp):
834
def iter_conflicts(self):
836
for path in (s[0] for s in self.list_files()):
837
stem = get_conflicted_stem(path)
840
if stem not in conflicted:
845
def pull(self, source, overwrite=False, stop_revision=None):
848
old_revision_history = self.branch.revision_history()
849
basis_tree = self.basis_tree()
850
count = self.branch.pull(source, overwrite, stop_revision)
851
new_revision_history = self.branch.revision_history()
852
if new_revision_history != old_revision_history:
853
if len(old_revision_history):
854
other_revision = old_revision_history[-1]
856
other_revision = None
857
repository = self.branch.repository
858
pb = bzrlib.ui.ui_factory.nested_progress_bar()
860
merge_inner(self.branch,
861
self.branch.basis_tree(),
867
self.set_last_revision(self.branch.last_revision())
873
"""Yield all unknown files in this WorkingTree.
875
If there are any unknown directories then only the directory is
876
returned, not all its children. But if there are unknown files
877
under a versioned subdirectory, they are returned.
879
Currently returned depth-first, sorted by name within directories.
881
## TODO: Work from given directory downwards
882
for path, dir_entry in self.inventory.directories():
883
mutter("search for unknowns in %r", path)
884
dirabs = self.abspath(path)
885
if not isdir(dirabs):
886
# e.g. directory deleted
890
for subf in os.listdir(dirabs):
892
and (subf not in dir_entry.children)):
897
subp = appendpath(path, subf)
901
def ignored_files(self):
902
"""Yield list of PATH, IGNORE_PATTERN"""
903
for subp in self.extras():
904
pat = self.is_ignored(subp)
909
def get_ignore_list(self):
910
"""Return list of ignore patterns.
912
Cached in the Tree object after the first call.
914
if hasattr(self, '_ignorelist'):
915
return self._ignorelist
917
l = bzrlib.DEFAULT_IGNORE[:]
918
if self.has_filename(bzrlib.IGNORE_FILENAME):
919
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
920
l.extend([line.rstrip("\n\r") for line in f.readlines()])
925
def is_ignored(self, filename):
926
r"""Check whether the filename matches an ignore pattern.
928
Patterns containing '/' or '\' need to match the whole path;
929
others match against only the last component.
931
If the file is ignored, returns the pattern which caused it to
932
be ignored, otherwise None. So this can simply be used as a
933
boolean if desired."""
935
# TODO: Use '**' to match directories, and other extended
936
# globbing stuff from cvs/rsync.
938
# XXX: fnmatch is actually not quite what we want: it's only
939
# approximately the same as real Unix fnmatch, and doesn't
940
# treat dotfiles correctly and allows * to match /.
941
# Eventually it should be replaced with something more
944
for pat in self.get_ignore_list():
945
if '/' in pat or '\\' in pat:
947
# as a special case, you can put ./ at the start of a
948
# pattern; this is good to match in the top-level
951
if (pat[:2] == './') or (pat[:2] == '.\\'):
955
if fnmatch.fnmatchcase(filename, newpat):
958
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
963
def kind(self, file_id):
964
return file_kind(self.id2abspath(file_id))
967
def last_revision(self):
968
"""Return the last revision id of this working tree.
970
In early branch formats this was == the branch last_revision,
971
but that cannot be relied upon - for working tree operations,
972
always use tree.last_revision().
974
return self.branch.last_revision()
977
"""See Branch.lock_read, and WorkingTree.unlock."""
978
self.branch.lock_read()
980
return self._control_files.lock_read()
985
def lock_write(self):
986
"""See Branch.lock_write, and WorkingTree.unlock."""
987
self.branch.lock_write()
989
return self._control_files.lock_write()
994
def _basis_inventory_name(self, revision_id):
995
return 'basis-inventory.%s' % revision_id
998
def set_last_revision(self, new_revision, old_revision=None):
999
"""Change the last revision in the working tree."""
1000
self._remove_old_basis(old_revision)
1001
if self._change_last_revision(new_revision):
1002
self._cache_basis_inventory(new_revision)
1004
def _change_last_revision(self, new_revision):
1005
"""Template method part of set_last_revision to perform the change."""
1006
if new_revision is None:
1007
self.branch.set_revision_history([])
1009
# current format is locked in with the branch
1010
revision_history = self.branch.revision_history()
1012
position = revision_history.index(new_revision)
1014
raise errors.NoSuchRevision(self.branch, new_revision)
1015
self.branch.set_revision_history(revision_history[:position + 1])
1018
def _cache_basis_inventory(self, new_revision):
1019
"""Cache new_revision as the basis inventory."""
1021
xml = self.branch.repository.get_inventory_xml(new_revision)
1022
path = self._basis_inventory_name(new_revision)
1023
self._control_files.put_utf8(path, xml)
1024
except WeaveRevisionNotPresent:
1027
def _remove_old_basis(self, old_revision):
1028
"""Remove the old basis inventory 'old_revision'."""
1029
if old_revision is not None:
1031
path = self._basis_inventory_name(old_revision)
1032
path = self._control_files._escape(path)
1033
self._control_files._transport.delete(path)
1037
def read_basis_inventory(self, revision_id):
1038
"""Read the cached basis inventory."""
1039
path = self._basis_inventory_name(revision_id)
1040
return self._control_files.get_utf8(path).read()
1043
def read_working_inventory(self):
1044
"""Read the working inventory."""
1045
# ElementTree does its own conversion from UTF-8, so open in
1047
result = bzrlib.xml5.serializer_v5.read_inventory(
1048
self._control_files.get('inventory'))
1049
self._set_inventory(result)
1053
def remove(self, files, verbose=False):
1054
"""Remove nominated files from the working inventory..
1056
This does not remove their text. This does not run on XXX on what? RBC
1058
TODO: Refuse to remove modified files unless --force is given?
1060
TODO: Do something useful with directories.
1062
TODO: Should this remove the text or not? Tough call; not
1063
removing may be useful and the user can just use use rm, and
1064
is the opposite of add. Removing it is consistent with most
1065
other tools. Maybe an option.
1067
## TODO: Normalize names
1068
## TODO: Remove nested loops; better scalability
1069
if isinstance(files, basestring):
1072
inv = self.inventory
1074
# do this before any modifications
1076
fid = inv.path2id(f)
1078
# TODO: Perhaps make this just a warning, and continue?
1079
# This tends to happen when
1080
raise NotVersionedError(path=f)
1081
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1083
# having remove it, it must be either ignored or unknown
1084
if self.is_ignored(f):
1088
show_status(new_status, inv[fid].kind, quotefn(f))
1091
self._write_inventory(inv)
1094
def revert(self, filenames, old_tree=None, backups=True,
1095
pb=DummyProgress()):
1096
from transform import revert
1097
if old_tree is None:
1098
old_tree = self.basis_tree()
1099
revert(self, old_tree, filenames, backups, pb)
1100
if not len(filenames):
1101
self.set_pending_merges([])
1104
def set_inventory(self, new_inventory_list):
1105
from bzrlib.inventory import (Inventory,
1110
inv = Inventory(self.get_root_id())
1111
for path, file_id, parent, kind in new_inventory_list:
1112
name = os.path.basename(path)
1115
# fixme, there should be a factory function inv,add_??
1116
if kind == 'directory':
1117
inv.add(InventoryDirectory(file_id, name, parent))
1118
elif kind == 'file':
1119
inv.add(InventoryFile(file_id, name, parent))
1120
elif kind == 'symlink':
1121
inv.add(InventoryLink(file_id, name, parent))
1123
raise BzrError("unknown kind %r" % kind)
1124
self._write_inventory(inv)
1127
def set_root_id(self, file_id):
1128
"""Set the root id for this tree."""
1129
inv = self.read_working_inventory()
1130
orig_root_id = inv.root.file_id
1131
del inv._byid[inv.root.file_id]
1132
inv.root.file_id = file_id
1133
inv._byid[inv.root.file_id] = inv.root
1136
if entry.parent_id == orig_root_id:
1137
entry.parent_id = inv.root.file_id
1138
self._write_inventory(inv)
1141
"""See Branch.unlock.
1143
WorkingTree locking just uses the Branch locking facilities.
1144
This is current because all working trees have an embedded branch
1145
within them. IF in the future, we were to make branch data shareable
1146
between multiple working trees, i.e. via shared storage, then we
1147
would probably want to lock both the local tree, and the branch.
1149
# FIXME: We want to write out the hashcache only when the last lock on
1150
# this working copy is released. Peeking at the lock count is a bit
1151
# of a nasty hack; probably it's better to have a transaction object,
1152
# which can do some finalization when it's either successfully or
1153
# unsuccessfully completed. (Denys's original patch did that.)
1154
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1155
# wrongly. Hookinh into unllock on the control files object is fine though.
1157
# TODO: split this per format so there is no ugly if block
1158
if self._hashcache.needs_write and (
1159
# dedicated lock files
1160
self._control_files._lock_count==1 or
1162
(self._control_files is self.branch.control_files and
1163
self._control_files._lock_count==3)):
1164
self._hashcache.write()
1165
# reverse order of locking.
1166
result = self._control_files.unlock()
1168
self.branch.unlock()
1174
"""Update a working tree along its branch.
1176
This will update the branch if its bound too, which means we have multiple trees involved:
1177
The new basis tree of the master.
1178
The old basis tree of the branch.
1179
The old basis tree of the working tree.
1180
The current working tree state.
1181
pathologically all three may be different, and non ancestors of each other.
1182
Conceptually we want to:
1183
Preserve the wt.basis->wt.state changes
1184
Transform the wt.basis to the new master basis.
1185
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1186
Restore the wt.basis->wt.state changes.
1188
There isn't a single operation at the moment to do that, so we:
1189
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1190
Do a 'normal' merge of the old branch basis if it is relevant.
1192
old_tip = self.branch.update()
1193
if old_tip is not None:
1194
self.add_pending_merge(old_tip)
1195
self.branch.lock_read()
1198
if self.last_revision() != self.branch.last_revision():
1199
# merge tree state up to new branch tip.
1200
basis = self.basis_tree()
1201
to_tree = self.branch.basis_tree()
1202
result += merge_inner(self.branch,
1206
self.set_last_revision(self.branch.last_revision())
1207
if old_tip and old_tip != self.last_revision():
1208
# our last revision was not the prior branch last reivison
1209
# and we have converted that last revision to a pending merge.
1210
# base is somewhere between the branch tip now
1211
# and the now pending merge
1212
from bzrlib.revision import common_ancestor
1214
base_rev_id = common_ancestor(self.branch.last_revision(),
1216
self.branch.repository)
1217
except errors.NoCommonAncestor:
1219
base_tree = self.branch.repository.revision_tree(base_rev_id)
1220
other_tree = self.branch.repository.revision_tree(old_tip)
1221
result += merge_inner(self.branch,
1227
self.branch.unlock()
1230
def _write_inventory(self, inv):
1231
"""Write inventory as the current inventory."""
1233
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1235
self._control_files.put('inventory', sio)
1236
self._set_inventory(inv)
1237
mutter('wrote working inventory')
1240
class WorkingTree3(WorkingTree):
1241
"""This is the Format 3 working tree.
1243
This differs from the base WorkingTree by:
1244
- having its own file lock
1245
- having its own last-revision property.
1249
def last_revision(self):
1250
"""See WorkingTree.last_revision."""
1252
return self._control_files.get_utf8('last-revision').read()
1256
def _change_last_revision(self, revision_id):
1257
"""See WorkingTree._change_last_revision."""
1258
if revision_id is None or revision_id == NULL_REVISION:
1260
self._control_files._transport.delete('last-revision')
1261
except errors.NoSuchFile:
1266
self.branch.revision_history().index(revision_id)
1268
raise errors.NoSuchRevision(self.branch, revision_id)
1269
self._control_files.put_utf8('last-revision', revision_id)
1273
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1274
def get_conflicted_stem(path):
1275
for suffix in CONFLICT_SUFFIXES:
1276
if path.endswith(suffix):
1277
return path[:-len(suffix)]
1279
@deprecated_function(zero_eight)
1280
def is_control_file(filename):
1281
"""See WorkingTree.is_control_filename(filename)."""
1282
## FIXME: better check
1283
filename = normpath(filename)
1284
while filename != '':
1285
head, tail = os.path.split(filename)
1286
## mutter('check %r for control file' % ((head, tail),))
1289
if filename == head:
1295
class WorkingTreeFormat(object):
1296
"""An encapsulation of the initialization and open routines for a format.
1298
Formats provide three things:
1299
* An initialization routine,
1303
Formats are placed in an dict by their format string for reference
1304
during workingtree opening. Its not required that these be instances, they
1305
can be classes themselves with class methods - it simply depends on
1306
whether state is needed for a given format or not.
1308
Once a format is deprecated, just deprecate the initialize and open
1309
methods on the format class. Do not deprecate the object, as the
1310
object will be created every time regardless.
1313
_default_format = None
1314
"""The default format used for new trees."""
1317
"""The known formats."""
1320
def find_format(klass, a_bzrdir):
1321
"""Return the format for the working tree object in a_bzrdir."""
1323
transport = a_bzrdir.get_workingtree_transport(None)
1324
format_string = transport.get("format").read()
1325
return klass._formats[format_string]
1327
raise errors.NoWorkingTree(base=transport.base)
1329
raise errors.UnknownFormatError(format_string)
1332
def get_default_format(klass):
1333
"""Return the current default format."""
1334
return klass._default_format
1336
def get_format_string(self):
1337
"""Return the ASCII format string that identifies this format."""
1338
raise NotImplementedError(self.get_format_string)
1340
def is_supported(self):
1341
"""Is this format supported?
1343
Supported formats can be initialized and opened.
1344
Unsupported formats may not support initialization or committing or
1345
some other features depending on the reason for not being supported.
1350
def register_format(klass, format):
1351
klass._formats[format.get_format_string()] = format
1354
def set_default_format(klass, format):
1355
klass._default_format = format
1358
def unregister_format(klass, format):
1359
assert klass._formats[format.get_format_string()] is format
1360
del klass._formats[format.get_format_string()]
1364
class WorkingTreeFormat2(WorkingTreeFormat):
1365
"""The second working tree format.
1367
This format modified the hash cache from the format 1 hash cache.
1370
def initialize(self, a_bzrdir, revision_id=None):
1371
"""See WorkingTreeFormat.initialize()."""
1372
if not isinstance(a_bzrdir.transport, LocalTransport):
1373
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1374
branch = a_bzrdir.open_branch()
1375
if revision_id is not None:
1378
revision_history = branch.revision_history()
1380
position = revision_history.index(revision_id)
1382
raise errors.NoSuchRevision(branch, revision_id)
1383
branch.set_revision_history(revision_history[:position + 1])
1386
revision = branch.last_revision()
1388
wt = WorkingTree(a_bzrdir.root_transport.base,
1394
wt._write_inventory(inv)
1395
wt.set_root_id(inv.root.file_id)
1396
wt.set_last_revision(revision)
1397
wt.set_pending_merges([])
1398
build_tree(wt.basis_tree(), wt)
1402
super(WorkingTreeFormat2, self).__init__()
1403
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1405
def open(self, a_bzrdir, _found=False):
1406
"""Return the WorkingTree object for a_bzrdir
1408
_found is a private parameter, do not use it. It is used to indicate
1409
if format probing has already been done.
1412
# we are being called directly and must probe.
1413
raise NotImplementedError
1414
if not isinstance(a_bzrdir.transport, LocalTransport):
1415
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1416
return WorkingTree(a_bzrdir.root_transport.base,
1422
class WorkingTreeFormat3(WorkingTreeFormat):
1423
"""The second working tree format updated to record a format marker.
1425
This format modified the hash cache from the format 1 hash cache.
1428
def get_format_string(self):
1429
"""See WorkingTreeFormat.get_format_string()."""
1430
return "Bazaar-NG Working Tree format 3"
1432
def initialize(self, a_bzrdir, revision_id=None):
1433
"""See WorkingTreeFormat.initialize().
1435
revision_id allows creating a working tree at a differnet
1436
revision than the branch is at.
1438
if not isinstance(a_bzrdir.transport, LocalTransport):
1439
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1440
transport = a_bzrdir.get_workingtree_transport(self)
1441
control_files = LockableFiles(transport, 'lock', TransportLock)
1442
control_files.put_utf8('format', self.get_format_string())
1443
branch = a_bzrdir.open_branch()
1444
if revision_id is None:
1445
revision_id = branch.last_revision()
1447
wt = WorkingTree3(a_bzrdir.root_transport.base,
1453
wt._write_inventory(inv)
1454
wt.set_root_id(inv.root.file_id)
1455
wt.set_last_revision(revision_id)
1456
wt.set_pending_merges([])
1457
build_tree(wt.basis_tree(), wt)
1461
super(WorkingTreeFormat3, self).__init__()
1462
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1464
def open(self, a_bzrdir, _found=False):
1465
"""Return the WorkingTree object for a_bzrdir
1467
_found is a private parameter, do not use it. It is used to indicate
1468
if format probing has already been done.
1471
# we are being called directly and must probe.
1472
raise NotImplementedError
1473
if not isinstance(a_bzrdir.transport, LocalTransport):
1474
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1475
return WorkingTree3(a_bzrdir.root_transport.base,
1481
return self.get_format_string()
1484
# formats which have no format string are not discoverable
1485
# and not independently creatable, so are not registered.
1486
__default_format = WorkingTreeFormat3()
1487
WorkingTreeFormat.register_format(__default_format)
1488
WorkingTreeFormat.set_default_format(__default_format)
1489
_legacy_formats = [WorkingTreeFormat2(),
1493
class WorkingTreeTestProviderAdapter(object):
1494
"""A tool to generate a suite testing multiple workingtree formats at once.
1496
This is done by copying the test once for each transport and injecting
1497
the transport_server, transport_readonly_server, and workingtree_format
1498
classes into each copy. Each copy is also given a new id() to make it
1502
def __init__(self, transport_server, transport_readonly_server, formats):
1503
self._transport_server = transport_server
1504
self._transport_readonly_server = transport_readonly_server
1505
self._formats = formats
1507
def adapt(self, test):
1508
from bzrlib.tests import TestSuite
1509
result = TestSuite()
1510
for workingtree_format, bzrdir_format in self._formats:
1511
new_test = deepcopy(test)
1512
new_test.transport_server = self._transport_server
1513
new_test.transport_readonly_server = self._transport_readonly_server
1514
new_test.bzrdir_format = bzrdir_format
1515
new_test.workingtree_format = workingtree_format
1516
def make_new_test_id():
1517
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1518
return lambda: new_id
1519
new_test.id = make_new_test_id()
1520
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
