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).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
34
# FIXME: I don't know if writing out the cache from the destructor is really a
35
# good idea, because destructors are considered poor taste in Python, and it's
36
# not predictable when it will be written out.
38
# TODO: Give the workingtree sole responsibility for the working inventory;
39
# remove the variable and references to it from the branch. This may require
40
# updating the commit code so as to update the inventory within the working
41
# copy, and making sure there's only one WorkingTree for any directory on disk.
42
# At the momenthey may alias the inventory and have old copies of it in memory.
44
from copy import deepcopy
45
from cStringIO import StringIO
52
from bzrlib.atomicfile import AtomicFile
53
from bzrlib.branch import (Branch,
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,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError)
66
from bzrlib.inventory import InventoryEntry, Inventory
67
from bzrlib.lockable_files import LockableFiles, TransportLock
68
from bzrlib.merge import merge_inner, transform_tree
69
from bzrlib.osutils import (
87
from bzrlib.progress import DummyProgress
88
from bzrlib.revision import NULL_REVISION
89
from bzrlib.rio import RioReader, RioWriter, Stanza
90
from bzrlib.symbol_versioning import *
91
from bzrlib.textui import show_status
93
from bzrlib.trace import mutter
94
from bzrlib.transform import build_tree
95
from bzrlib.transport import get_transport
96
from bzrlib.transport.local import LocalTransport
101
def gen_file_id(name):
102
"""Return new file id.
104
This should probably generate proper UUIDs, but for the moment we
105
cope with just randomness because running uuidgen every time is
108
from binascii import hexlify
109
from time import time
112
idx = name.rfind('/')
114
name = name[idx+1 : ]
115
idx = name.rfind('\\')
117
name = name[idx+1 : ]
119
# make it not a hidden file
120
name = name.lstrip('.')
122
# remove any wierd characters; we don't escape them but rather
124
name = re.sub(r'[^\w.]', '', name)
126
s = hexlify(rand_bytes(8))
127
return '-'.join((name, compact_date(time()), s))
131
"""Return a new tree-root file id."""
132
return gen_file_id('TREE_ROOT')
135
class TreeEntry(object):
136
"""An entry that implements the minium interface used by commands.
138
This needs further inspection, it may be better to have
139
InventoryEntries without ids - though that seems wrong. For now,
140
this is a parallel hierarchy to InventoryEntry, and needs to become
141
one of several things: decorates to that hierarchy, children of, or
143
Another note is that these objects are currently only used when there is
144
no InventoryEntry available - i.e. for unversioned objects.
145
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
148
def __eq__(self, other):
149
# yes, this us ugly, TODO: best practice __eq__ style.
150
return (isinstance(other, TreeEntry)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeDirectory(TreeEntry):
158
"""See TreeEntry. This is a directory in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeDirectory)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeFile(TreeEntry):
169
"""See TreeEntry. This is a regular file in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeFile)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class TreeLink(TreeEntry):
180
"""See TreeEntry. This is a symlink in a working tree."""
182
def __eq__(self, other):
183
return (isinstance(other, TreeLink)
184
and other.__class__ == self.__class__)
186
def kind_character(self):
190
class WorkingTree(bzrlib.tree.Tree):
191
"""Working copy tree.
193
The inventory is held in the `Branch` working-inventory, and the
194
files are in a directory on disk.
196
It is possible for a `WorkingTree` to have a filename which is
197
not listed in the Inventory and vice versa.
200
def __init__(self, basedir='.',
201
branch=DEPRECATED_PARAMETER,
207
"""Construct a WorkingTree for basedir.
209
If the branch is not supplied, it is opened automatically.
210
If the branch is supplied, it must be the branch for this basedir.
211
(branch.base is not cross checked, because for remote branches that
212
would be meaningless).
214
self._format = _format
215
self.bzrdir = _bzrdir
217
# not created via open etc.
218
warn("WorkingTree() is deprecated as of bzr version 0.8. "
219
"Please use bzrdir.open_workingtree or WorkingTree.open().",
222
wt = WorkingTree.open(basedir)
223
self.branch = wt.branch
224
self.basedir = wt.basedir
225
self._control_files = wt._control_files
226
self._hashcache = wt._hashcache
227
self._set_inventory(wt._inventory)
228
self._format = wt._format
229
self.bzrdir = wt.bzrdir
230
from bzrlib.hashcache import HashCache
231
from bzrlib.trace import note, mutter
232
assert isinstance(basedir, basestring), \
233
"base directory %r is not a string" % basedir
234
basedir = safe_unicode(basedir)
235
mutter("opening working tree %r", basedir)
236
if deprecated_passed(branch):
238
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
239
" Please use bzrdir.open_workingtree() or WorkingTree.open().",
245
self.branch = self.bzrdir.open_branch()
246
assert isinstance(self.branch, Branch), \
247
"branch %r is not a Branch" % self.branch
248
self.basedir = realpath(basedir)
249
# if branch is at our basedir and is a format 6 or less
250
if isinstance(self._format, WorkingTreeFormat2):
251
# share control object
252
self._control_files = self.branch.control_files
253
elif _control_files is not None:
254
assert False, "not done yet"
255
# self._control_files = _control_files
257
# only ready for format 3
258
assert isinstance(self._format, WorkingTreeFormat3)
259
self._control_files = LockableFiles(
260
self.bzrdir.get_workingtree_transport(None),
261
'lock', TransportLock)
263
# update the whole cache up front and write to disk if anything changed;
264
# in the future we might want to do this more selectively
265
# two possible ways offer themselves : in self._unlock, write the cache
266
# if needed, or, when the cache sees a change, append it to the hash
267
# cache file, and have the parser take the most recent entry for a
269
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
270
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
# is this scan needed ? it makes things kinda slow.
279
if _inventory is None:
280
self._set_inventory(self.read_working_inventory())
282
self._set_inventory(_inventory)
284
def _set_inventory(self, inv):
285
self._inventory = inv
286
self.path2id = self._inventory.path2id
288
def is_control_filename(self, filename):
289
"""True if filename is the name of a control file in this tree.
291
This is true IF and ONLY IF the filename is part of the meta data
292
that bzr controls in this tree. I.E. a random .bzr directory placed
293
on disk will not be a control file for this tree.
296
self.bzrdir.transport.relpath(self.abspath(filename))
298
except errors.PathNotChild:
302
def open(path=None, _unsupported=False):
303
"""Open an existing working tree at path.
307
path = os.path.getcwdu()
308
control = bzrdir.BzrDir.open(path, _unsupported)
309
return control.open_workingtree(_unsupported)
312
def open_containing(path=None):
313
"""Open an existing working tree which has its root about path.
315
This probes for a working tree at path and searches upwards from there.
317
Basically we keep looking up until we find the control directory or
318
run into /. If there isn't one, raises NotBranchError.
319
TODO: give this a new exception.
320
If there is one, it is returned, along with the unused portion of path.
324
control, relpath = bzrdir.BzrDir.open_containing(path)
325
return control.open_workingtree(), relpath
328
def open_downlevel(path=None):
329
"""Open an unsupported working tree.
331
Only intended for advanced situations like upgrading part of a bzrdir.
333
return WorkingTree.open(path, _unsupported=True)
336
"""Iterate through file_ids for this tree.
338
file_ids are in a WorkingTree if they are in the working inventory
339
and the working file exists.
341
inv = self._inventory
342
for path, ie in inv.iter_entries():
343
if bzrlib.osutils.lexists(self.abspath(path)):
347
return "<%s of %s>" % (self.__class__.__name__,
348
getattr(self, 'basedir', None))
350
def abspath(self, filename):
351
return pathjoin(self.basedir, filename)
353
def basis_tree(self):
354
"""Return RevisionTree for the current last revision."""
355
revision_id = self.last_revision()
356
if revision_id is not None:
358
xml = self.read_basis_inventory(revision_id)
359
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
360
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
364
return self.branch.repository.revision_tree(revision_id)
367
@deprecated_method(zero_eight)
368
def create(branch, directory):
369
"""Create a workingtree for branch at directory.
371
If existing_directory already exists it must have a .bzr directory.
372
If it does not exist, it will be created.
374
This returns a new WorkingTree object for the new checkout.
376
TODO FIXME RBC 20060124 when we have checkout formats in place this
377
should accept an optional revisionid to checkout [and reject this if
378
checking out into the same dir as a pre-checkout-aware branch format.]
380
XXX: When BzrDir is present, these should be created through that
383
warn('delete WorkingTree.create', stacklevel=3)
384
transport = get_transport(directory)
385
if branch.bzrdir.root_transport.base == transport.base:
387
return branch.bzrdir.create_workingtree()
388
# different directory,
389
# create a branch reference
390
# and now a working tree.
391
raise NotImplementedError
394
@deprecated_method(zero_eight)
395
def create_standalone(directory):
396
"""Create a checkout and a branch and a repo at directory.
398
Directory must exist and be empty.
400
please use BzrDir.create_standalone_workingtree
402
return bzrdir.BzrDir.create_standalone_workingtree(directory)
404
def relpath(self, abs):
405
"""Return the local path portion from a given absolute path."""
406
return relpath(self.basedir, abs)
408
def has_filename(self, filename):
409
return bzrlib.osutils.lexists(self.abspath(filename))
411
def get_file(self, file_id):
412
return self.get_file_byname(self.id2path(file_id))
414
def get_file_byname(self, filename):
415
return file(self.abspath(filename), 'rb')
417
def get_root_id(self):
418
"""Return the id of this trees root"""
419
inv = self.read_working_inventory()
420
return inv.root.file_id
422
def _get_store_filename(self, file_id):
423
## XXX: badly named; this is not in the store at all
424
return self.abspath(self.id2path(file_id))
427
def clone(self, to_bzrdir, revision_id=None, basis=None):
428
"""Duplicate this working tree into to_bzr, including all state.
430
Specifically modified files are kept as modified, but
431
ignored and unknown files are discarded.
433
If you want to make a new line of development, see bzrdir.sprout()
436
If not None, the cloned tree will have its last revision set to
437
revision, and and difference between the source trees last revision
438
and this one merged in.
441
If not None, a closer copy of a tree which may have some files in
442
common, and which file content should be preferentially copied from.
444
# assumes the target bzr dir format is compatible.
445
result = self._format.initialize(to_bzrdir)
446
self.copy_content_into(result, revision_id)
450
def copy_content_into(self, tree, revision_id=None):
451
"""Copy the current content and user files of this tree into tree."""
452
if revision_id is None:
453
transform_tree(tree, self)
455
# TODO now merge from tree.last_revision to revision
456
transform_tree(tree, self)
457
tree.set_last_revision(revision_id)
460
def commit(self, message=None, revprops=None, *args, **kwargs):
461
# avoid circular imports
462
from bzrlib.commit import Commit
465
if not 'branch-nick' in revprops:
466
revprops['branch-nick'] = self.branch.nick
467
# args for wt.commit start at message from the Commit.commit method,
468
# but with branch a kwarg now, passing in args as is results in the
469
#message being used for the branch
470
args = (DEPRECATED_PARAMETER, message, ) + args
471
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
472
self._set_inventory(self.read_working_inventory())
474
def id2abspath(self, file_id):
475
return self.abspath(self.id2path(file_id))
477
def has_id(self, file_id):
478
# files that have been deleted are excluded
479
inv = self._inventory
480
if not inv.has_id(file_id):
482
path = inv.id2path(file_id)
483
return bzrlib.osutils.lexists(self.abspath(path))
485
def has_or_had_id(self, file_id):
486
if file_id == self.inventory.root.file_id:
488
return self.inventory.has_id(file_id)
490
__contains__ = has_id
492
def get_file_size(self, file_id):
493
return os.path.getsize(self.id2abspath(file_id))
496
def get_file_sha1(self, file_id):
497
path = self._inventory.id2path(file_id)
498
return self._hashcache.get_sha1(path)
500
def is_executable(self, file_id):
501
if not supports_executable():
502
return self._inventory[file_id].executable
504
path = self._inventory.id2path(file_id)
505
mode = os.lstat(self.abspath(path)).st_mode
506
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
509
def add(self, files, ids=None):
510
"""Make files versioned.
512
Note that the command line normally calls smart_add instead,
513
which can automatically recurse.
515
This adds the files to the inventory, so that they will be
516
recorded by the next commit.
519
List of paths to add, relative to the base of the tree.
522
If set, use these instead of automatically generated ids.
523
Must be the same length as the list of files, but may
524
contain None for ids that are to be autogenerated.
526
TODO: Perhaps have an option to add the ids even if the files do
529
TODO: Perhaps callback with the ids and paths as they're added.
531
# TODO: Re-adding a file that is removed in the working copy
532
# should probably put it back with the previous ID.
533
if isinstance(files, basestring):
534
assert(ids is None or isinstance(ids, basestring))
540
ids = [None] * len(files)
542
assert(len(ids) == len(files))
544
inv = self.read_working_inventory()
545
for f,file_id in zip(files, ids):
546
if self.is_control_filename(f):
547
raise BzrError("cannot add control file %s" % quotefn(f))
552
raise BzrError("cannot add top-level %r" % f)
554
fullpath = normpath(self.abspath(f))
557
kind = file_kind(fullpath)
559
if e.errno == errno.ENOENT:
560
raise NoSuchFile(fullpath)
561
# maybe something better?
562
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
564
if not InventoryEntry.versionable_kind(kind):
565
raise BzrError('cannot add: not a versionable file ('
566
'i.e. regular file, symlink or directory): %s' % quotefn(f))
569
file_id = gen_file_id(f)
570
inv.add_path(f, kind=kind, file_id=file_id)
572
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
573
self._write_inventory(inv)
576
def add_pending_merge(self, *revision_ids):
577
# TODO: Perhaps should check at this point that the
578
# history of the revision is actually present?
579
p = self.pending_merges()
581
for rev_id in revision_ids:
587
self.set_pending_merges(p)
590
def pending_merges(self):
591
"""Return a list of pending merges.
593
These are revisions that have been merged into the working
594
directory but not yet committed.
597
merges_file = self._control_files.get_utf8('pending-merges')
599
if e.errno != errno.ENOENT:
603
for l in merges_file.readlines():
604
p.append(l.rstrip('\n'))
608
def set_pending_merges(self, rev_list):
609
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
612
def set_merge_modified(self, modified_hashes):
614
my_file.write(MERGE_MODIFIED_HEADER_1 + '\n')
615
writer = RioWriter(my_file)
616
for file_id, hash in modified_hashes.iteritems():
617
s = Stanza(file_id=file_id, hash=hash)
618
writer.write_stanza(s)
620
self._control_files.put('merge-hashes', my_file)
623
def merge_modified(self):
625
hashfile = self._control_files.get('merge-hashes')
630
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
631
raise MergeModifiedFormatError()
632
except StopIteration:
633
raise MergeModifiedFormatError()
634
for s in RioReader(hashfile):
635
file_id = s.get("file_id")
637
if hash == self.get_file_sha1(file_id):
638
merge_hashes[file_id] = hash
641
def get_symlink_target(self, file_id):
642
return os.readlink(self.id2abspath(file_id))
644
def file_class(self, filename):
645
if self.path2id(filename):
647
elif self.is_ignored(filename):
652
def list_files(self):
653
"""Recursively list all files as (path, class, kind, id).
655
Lists, but does not descend into unversioned directories.
657
This does not include files that have been deleted in this
660
Skips the control directory.
662
inv = self._inventory
664
def descend(from_dir_relpath, from_dir_id, dp):
668
## TODO: If we find a subdirectory with its own .bzr
669
## directory, then that is a separate tree and we
670
## should exclude it.
672
# the bzrdir for this tree
673
if self.bzrdir.transport.base.endswith(f + '/'):
677
fp = appendpath(from_dir_relpath, f)
680
fap = appendpath(dp, f)
682
f_ie = inv.get_child(from_dir_id, f)
685
elif self.is_ignored(fp):
694
raise BzrCheckError("file %r entered as kind %r id %r, "
696
% (fap, f_ie.kind, f_ie.file_id, fk))
698
# make a last minute entry
702
if fk == 'directory':
703
entry = TreeDirectory()
706
elif fk == 'symlink':
711
yield fp, c, fk, (f_ie and f_ie.file_id), entry
713
if fk != 'directory':
717
# don't descend unversioned directories
720
for ff in descend(fp, f_ie.file_id, fap):
723
for f in descend(u'', inv.root.file_id, self.basedir):
727
def move(self, from_paths, to_name):
730
to_name must exist in the inventory.
732
If to_name exists and is a directory, the files are moved into
733
it, keeping their old names.
735
Note that to_name is only the last component of the new name;
736
this doesn't change the directory.
738
This returns a list of (from_path, to_path) pairs for each
742
## TODO: Option to move IDs only
743
assert not isinstance(from_paths, basestring)
745
to_abs = self.abspath(to_name)
746
if not isdir(to_abs):
747
raise BzrError("destination %r is not a directory" % to_abs)
748
if not self.has_filename(to_name):
749
raise BzrError("destination %r not in working directory" % to_abs)
750
to_dir_id = inv.path2id(to_name)
751
if to_dir_id == None and to_name != '':
752
raise BzrError("destination %r is not a versioned directory" % to_name)
753
to_dir_ie = inv[to_dir_id]
754
if to_dir_ie.kind not in ('directory', 'root_directory'):
755
raise BzrError("destination %r is not a directory" % to_abs)
757
to_idpath = inv.get_idpath(to_dir_id)
760
if not self.has_filename(f):
761
raise BzrError("%r does not exist in working tree" % f)
762
f_id = inv.path2id(f)
764
raise BzrError("%r is not versioned" % f)
765
name_tail = splitpath(f)[-1]
766
dest_path = appendpath(to_name, name_tail)
767
if self.has_filename(dest_path):
768
raise BzrError("destination %r already exists" % dest_path)
769
if f_id in to_idpath:
770
raise BzrError("can't move %r to a subdirectory of itself" % f)
772
# OK, so there's a race here, it's possible that someone will
773
# create a file in this interval and then the rename might be
774
# left half-done. But we should have caught most problems.
775
orig_inv = deepcopy(self.inventory)
778
name_tail = splitpath(f)[-1]
779
dest_path = appendpath(to_name, name_tail)
780
result.append((f, dest_path))
781
inv.rename(inv.path2id(f), to_dir_id, name_tail)
783
rename(self.abspath(f), self.abspath(dest_path))
785
raise BzrError("failed to rename %r to %r: %s" %
786
(f, dest_path, e[1]),
787
["rename rolled back"])
789
# restore the inventory on error
790
self._set_inventory(orig_inv)
792
self._write_inventory(inv)
796
def rename_one(self, from_rel, to_rel):
799
This can change the directory or the filename or both.
802
if not self.has_filename(from_rel):
803
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
804
if self.has_filename(to_rel):
805
raise BzrError("can't rename: new working file %r already exists" % to_rel)
807
file_id = inv.path2id(from_rel)
809
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
812
from_parent = entry.parent_id
813
from_name = entry.name
815
if inv.path2id(to_rel):
816
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
818
to_dir, to_tail = os.path.split(to_rel)
819
to_dir_id = inv.path2id(to_dir)
820
if to_dir_id == None and to_dir != '':
821
raise BzrError("can't determine destination directory id for %r" % to_dir)
823
mutter("rename_one:")
824
mutter(" file_id {%s}" % file_id)
825
mutter(" from_rel %r" % from_rel)
826
mutter(" to_rel %r" % to_rel)
827
mutter(" to_dir %r" % to_dir)
828
mutter(" to_dir_id {%s}" % to_dir_id)
830
inv.rename(file_id, to_dir_id, to_tail)
832
from_abs = self.abspath(from_rel)
833
to_abs = self.abspath(to_rel)
835
rename(from_abs, to_abs)
837
inv.rename(file_id, from_parent, from_name)
838
raise BzrError("failed to rename %r to %r: %s"
839
% (from_abs, to_abs, e[1]),
840
["rename rolled back"])
841
self._write_inventory(inv)
845
"""Return all unknown files.
847
These are files in the working directory that are not versioned or
848
control files or ignored.
850
>>> from bzrlib.bzrdir import ScratchDir
851
>>> d = ScratchDir(files=['foo', 'foo~'])
852
>>> b = d.open_branch()
853
>>> tree = d.open_workingtree()
854
>>> map(str, tree.unknowns())
857
>>> list(b.unknowns())
859
>>> tree.remove('foo')
860
>>> list(b.unknowns())
863
for subp in self.extras():
864
if not self.is_ignored(subp):
867
def iter_conflicts(self):
869
for path in (s[0] for s in self.list_files()):
870
stem = get_conflicted_stem(path)
873
if stem not in conflicted:
878
def pull(self, source, overwrite=False, stop_revision=None):
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:
886
if len(old_revision_history):
887
other_revision = old_revision_history[-1]
889
other_revision = None
890
repository = self.branch.repository
891
pb = bzrlib.ui.ui_factory.nested_progress_bar()
893
merge_inner(self.branch,
894
self.branch.basis_tree(),
900
self.set_last_revision(self.branch.last_revision())
906
"""Yield all unknown files in this WorkingTree.
908
If there are any unknown directories then only the directory is
909
returned, not all its children. But if there are unknown files
910
under a versioned subdirectory, they are returned.
912
Currently returned depth-first, sorted by name within directories.
914
## TODO: Work from given directory downwards
915
for path, dir_entry in self.inventory.directories():
916
mutter("search for unknowns in %r", path)
917
dirabs = self.abspath(path)
918
if not isdir(dirabs):
919
# e.g. directory deleted
923
for subf in os.listdir(dirabs):
925
and (subf not in dir_entry.children)):
930
subp = appendpath(path, subf)
934
def ignored_files(self):
935
"""Yield list of PATH, IGNORE_PATTERN"""
936
for subp in self.extras():
937
pat = self.is_ignored(subp)
942
def get_ignore_list(self):
943
"""Return list of ignore patterns.
945
Cached in the Tree object after the first call.
947
if hasattr(self, '_ignorelist'):
948
return self._ignorelist
950
l = bzrlib.DEFAULT_IGNORE[:]
951
if self.has_filename(bzrlib.IGNORE_FILENAME):
952
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
953
l.extend([line.rstrip("\n\r") for line in f.readlines()])
958
def is_ignored(self, filename):
959
r"""Check whether the filename matches an ignore pattern.
961
Patterns containing '/' or '\' need to match the whole path;
962
others match against only the last component.
964
If the file is ignored, returns the pattern which caused it to
965
be ignored, otherwise None. So this can simply be used as a
966
boolean if desired."""
968
# TODO: Use '**' to match directories, and other extended
969
# globbing stuff from cvs/rsync.
971
# XXX: fnmatch is actually not quite what we want: it's only
972
# approximately the same as real Unix fnmatch, and doesn't
973
# treat dotfiles correctly and allows * to match /.
974
# Eventually it should be replaced with something more
977
for pat in self.get_ignore_list():
978
if '/' in pat or '\\' in pat:
980
# as a special case, you can put ./ at the start of a
981
# pattern; this is good to match in the top-level
984
if (pat[:2] == './') or (pat[:2] == '.\\'):
988
if fnmatch.fnmatchcase(filename, newpat):
991
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
996
def kind(self, file_id):
997
return file_kind(self.id2abspath(file_id))
1000
def last_revision(self):
1001
"""Return the last revision id of this working tree.
1003
In early branch formats this was == the branch last_revision,
1004
but that cannot be relied upon - for working tree operations,
1005
always use tree.last_revision().
1007
return self.branch.last_revision()
1009
def lock_read(self):
1010
"""See Branch.lock_read, and WorkingTree.unlock."""
1011
self.branch.lock_read()
1013
return self._control_files.lock_read()
1015
self.branch.unlock()
1018
def lock_write(self):
1019
"""See Branch.lock_write, and WorkingTree.unlock."""
1020
self.branch.lock_write()
1022
return self._control_files.lock_write()
1024
self.branch.unlock()
1027
def _basis_inventory_name(self, revision_id):
1028
return 'basis-inventory.%s' % revision_id
1031
def set_last_revision(self, new_revision, old_revision=None):
1032
"""Change the last revision in the working tree."""
1033
self._remove_old_basis(old_revision)
1034
if self._change_last_revision(new_revision):
1035
self._cache_basis_inventory(new_revision)
1037
def _change_last_revision(self, new_revision):
1038
"""Template method part of set_last_revision to perform the change."""
1039
if new_revision is None:
1040
self.branch.set_revision_history([])
1042
# current format is locked in with the branch
1043
revision_history = self.branch.revision_history()
1045
position = revision_history.index(new_revision)
1047
raise errors.NoSuchRevision(self.branch, new_revision)
1048
self.branch.set_revision_history(revision_history[:position + 1])
1051
def _cache_basis_inventory(self, new_revision):
1052
"""Cache new_revision as the basis inventory."""
1054
xml = self.branch.repository.get_inventory_xml(new_revision)
1055
path = self._basis_inventory_name(new_revision)
1056
self._control_files.put_utf8(path, xml)
1057
except WeaveRevisionNotPresent:
1060
def _remove_old_basis(self, old_revision):
1061
"""Remove the old basis inventory 'old_revision'."""
1062
if old_revision is not None:
1064
path = self._basis_inventory_name(old_revision)
1065
path = self._control_files._escape(path)
1066
self._control_files._transport.delete(path)
1070
def read_basis_inventory(self, revision_id):
1071
"""Read the cached basis inventory."""
1072
path = self._basis_inventory_name(revision_id)
1073
return self._control_files.get_utf8(path).read()
1076
def read_working_inventory(self):
1077
"""Read the working inventory."""
1078
# ElementTree does its own conversion from UTF-8, so open in
1080
result = bzrlib.xml5.serializer_v5.read_inventory(
1081
self._control_files.get('inventory'))
1082
self._set_inventory(result)
1086
def remove(self, files, verbose=False):
1087
"""Remove nominated files from the working inventory..
1089
This does not remove their text. This does not run on XXX on what? RBC
1091
TODO: Refuse to remove modified files unless --force is given?
1093
TODO: Do something useful with directories.
1095
TODO: Should this remove the text or not? Tough call; not
1096
removing may be useful and the user can just use use rm, and
1097
is the opposite of add. Removing it is consistent with most
1098
other tools. Maybe an option.
1100
## TODO: Normalize names
1101
## TODO: Remove nested loops; better scalability
1102
if isinstance(files, basestring):
1105
inv = self.inventory
1107
# do this before any modifications
1109
fid = inv.path2id(f)
1111
# TODO: Perhaps make this just a warning, and continue?
1112
# This tends to happen when
1113
raise NotVersionedError(path=f)
1114
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1116
# having remove it, it must be either ignored or unknown
1117
if self.is_ignored(f):
1121
show_status(new_status, inv[fid].kind, quotefn(f))
1124
self._write_inventory(inv)
1127
def revert(self, filenames, old_tree=None, backups=True,
1128
pb=DummyProgress()):
1129
from transform import revert
1130
if old_tree is None:
1131
old_tree = self.basis_tree()
1132
revert(self, old_tree, filenames, backups, pb)
1133
if not len(filenames):
1134
self.set_pending_merges([])
1137
def set_inventory(self, new_inventory_list):
1138
from bzrlib.inventory import (Inventory,
1143
inv = Inventory(self.get_root_id())
1144
for path, file_id, parent, kind in new_inventory_list:
1145
name = os.path.basename(path)
1148
# fixme, there should be a factory function inv,add_??
1149
if kind == 'directory':
1150
inv.add(InventoryDirectory(file_id, name, parent))
1151
elif kind == 'file':
1152
inv.add(InventoryFile(file_id, name, parent))
1153
elif kind == 'symlink':
1154
inv.add(InventoryLink(file_id, name, parent))
1156
raise BzrError("unknown kind %r" % kind)
1157
self._write_inventory(inv)
1160
def set_root_id(self, file_id):
1161
"""Set the root id for this tree."""
1162
inv = self.read_working_inventory()
1163
orig_root_id = inv.root.file_id
1164
del inv._byid[inv.root.file_id]
1165
inv.root.file_id = file_id
1166
inv._byid[inv.root.file_id] = inv.root
1169
if entry.parent_id == orig_root_id:
1170
entry.parent_id = inv.root.file_id
1171
self._write_inventory(inv)
1174
"""See Branch.unlock.
1176
WorkingTree locking just uses the Branch locking facilities.
1177
This is current because all working trees have an embedded branch
1178
within them. IF in the future, we were to make branch data shareable
1179
between multiple working trees, i.e. via shared storage, then we
1180
would probably want to lock both the local tree, and the branch.
1182
# FIXME: We want to write out the hashcache only when the last lock on
1183
# this working copy is released. Peeking at the lock count is a bit
1184
# of a nasty hack; probably it's better to have a transaction object,
1185
# which can do some finalization when it's either successfully or
1186
# unsuccessfully completed. (Denys's original patch did that.)
1187
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1188
# wrongly. Hookinh into unllock on the control files object is fine though.
1190
# TODO: split this per format so there is no ugly if block
1191
if self._hashcache.needs_write and (
1192
# dedicated lock files
1193
self._control_files._lock_count==1 or
1195
(self._control_files is self.branch.control_files and
1196
self._control_files._lock_count==3)):
1197
self._hashcache.write()
1198
# reverse order of locking.
1199
result = self._control_files.unlock()
1201
self.branch.unlock()
1207
"""Update a working tree along its branch.
1209
This will update the branch if its bound too, which means we have multiple trees involved:
1210
The new basis tree of the master.
1211
The old basis tree of the branch.
1212
The old basis tree of the working tree.
1213
The current working tree state.
1214
pathologically all three may be different, and non ancestors of each other.
1215
Conceptually we want to:
1216
Preserve the wt.basis->wt.state changes
1217
Transform the wt.basis to the new master basis.
1218
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1219
Restore the wt.basis->wt.state changes.
1221
There isn't a single operation at the moment to do that, so we:
1222
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1223
Do a 'normal' merge of the old branch basis if it is relevant.
1225
old_tip = self.branch.update()
1226
if old_tip is not None:
1227
self.add_pending_merge(old_tip)
1228
self.branch.lock_read()
1231
if self.last_revision() != self.branch.last_revision():
1232
# merge tree state up to new branch tip.
1233
basis = self.basis_tree()
1234
to_tree = self.branch.basis_tree()
1235
result += merge_inner(self.branch,
1239
self.set_last_revision(self.branch.last_revision())
1240
if old_tip and old_tip != self.last_revision():
1241
# our last revision was not the prior branch last reivison
1242
# and we have converted that last revision to a pending merge.
1243
# base is somewhere between the branch tip now
1244
# and the now pending merge
1245
from bzrlib.revision import common_ancestor
1247
base_rev_id = common_ancestor(self.branch.last_revision(),
1249
self.branch.repository)
1250
except errors.NoCommonAncestor:
1252
base_tree = self.branch.repository.revision_tree(base_rev_id)
1253
other_tree = self.branch.repository.revision_tree(old_tip)
1254
result += merge_inner(self.branch,
1260
self.branch.unlock()
1263
def _write_inventory(self, inv):
1264
"""Write inventory as the current inventory."""
1266
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1268
self._control_files.put('inventory', sio)
1269
self._set_inventory(inv)
1270
mutter('wrote working inventory')
1273
class WorkingTree3(WorkingTree):
1274
"""This is the Format 3 working tree.
1276
This differs from the base WorkingTree by:
1277
- having its own file lock
1278
- having its own last-revision property.
1282
def last_revision(self):
1283
"""See WorkingTree.last_revision."""
1285
return self._control_files.get_utf8('last-revision').read()
1289
def _change_last_revision(self, revision_id):
1290
"""See WorkingTree._change_last_revision."""
1291
if revision_id is None or revision_id == NULL_REVISION:
1293
self._control_files._transport.delete('last-revision')
1294
except errors.NoSuchFile:
1299
self.branch.revision_history().index(revision_id)
1301
raise errors.NoSuchRevision(self.branch, revision_id)
1302
self._control_files.put_utf8('last-revision', revision_id)
1306
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1307
def get_conflicted_stem(path):
1308
for suffix in CONFLICT_SUFFIXES:
1309
if path.endswith(suffix):
1310
return path[:-len(suffix)]
1312
@deprecated_function(zero_eight)
1313
def is_control_file(filename):
1314
"""See WorkingTree.is_control_filename(filename)."""
1315
## FIXME: better check
1316
filename = normpath(filename)
1317
while filename != '':
1318
head, tail = os.path.split(filename)
1319
## mutter('check %r for control file' % ((head, tail),))
1322
if filename == head:
1328
class WorkingTreeFormat(object):
1329
"""An encapsulation of the initialization and open routines for a format.
1331
Formats provide three things:
1332
* An initialization routine,
1336
Formats are placed in an dict by their format string for reference
1337
during workingtree opening. Its not required that these be instances, they
1338
can be classes themselves with class methods - it simply depends on
1339
whether state is needed for a given format or not.
1341
Once a format is deprecated, just deprecate the initialize and open
1342
methods on the format class. Do not deprecate the object, as the
1343
object will be created every time regardless.
1346
_default_format = None
1347
"""The default format used for new trees."""
1350
"""The known formats."""
1353
def find_format(klass, a_bzrdir):
1354
"""Return the format for the working tree object in a_bzrdir."""
1356
transport = a_bzrdir.get_workingtree_transport(None)
1357
format_string = transport.get("format").read()
1358
return klass._formats[format_string]
1360
raise errors.NoWorkingTree(base=transport.base)
1362
raise errors.UnknownFormatError(format_string)
1365
def get_default_format(klass):
1366
"""Return the current default format."""
1367
return klass._default_format
1369
def get_format_string(self):
1370
"""Return the ASCII format string that identifies this format."""
1371
raise NotImplementedError(self.get_format_string)
1373
def is_supported(self):
1374
"""Is this format supported?
1376
Supported formats can be initialized and opened.
1377
Unsupported formats may not support initialization or committing or
1378
some other features depending on the reason for not being supported.
1383
def register_format(klass, format):
1384
klass._formats[format.get_format_string()] = format
1387
def set_default_format(klass, format):
1388
klass._default_format = format
1391
def unregister_format(klass, format):
1392
assert klass._formats[format.get_format_string()] is format
1393
del klass._formats[format.get_format_string()]
1397
class WorkingTreeFormat2(WorkingTreeFormat):
1398
"""The second working tree format.
1400
This format modified the hash cache from the format 1 hash cache.
1403
def initialize(self, a_bzrdir, revision_id=None):
1404
"""See WorkingTreeFormat.initialize()."""
1405
if not isinstance(a_bzrdir.transport, LocalTransport):
1406
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1407
branch = a_bzrdir.open_branch()
1408
if revision_id is not None:
1411
revision_history = branch.revision_history()
1413
position = revision_history.index(revision_id)
1415
raise errors.NoSuchRevision(branch, revision_id)
1416
branch.set_revision_history(revision_history[:position + 1])
1419
revision = branch.last_revision()
1421
wt = WorkingTree(a_bzrdir.root_transport.base,
1427
wt._write_inventory(inv)
1428
wt.set_root_id(inv.root.file_id)
1429
wt.set_last_revision(revision)
1430
wt.set_pending_merges([])
1431
build_tree(wt.basis_tree(), wt)
1435
super(WorkingTreeFormat2, self).__init__()
1436
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1438
def open(self, a_bzrdir, _found=False):
1439
"""Return the WorkingTree object for a_bzrdir
1441
_found is a private parameter, do not use it. It is used to indicate
1442
if format probing has already been done.
1445
# we are being called directly and must probe.
1446
raise NotImplementedError
1447
if not isinstance(a_bzrdir.transport, LocalTransport):
1448
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1449
return WorkingTree(a_bzrdir.root_transport.base,
1455
class WorkingTreeFormat3(WorkingTreeFormat):
1456
"""The second working tree format updated to record a format marker.
1458
This format modified the hash cache from the format 1 hash cache.
1461
def get_format_string(self):
1462
"""See WorkingTreeFormat.get_format_string()."""
1463
return "Bazaar-NG Working Tree format 3"
1465
def initialize(self, a_bzrdir, revision_id=None):
1466
"""See WorkingTreeFormat.initialize().
1468
revision_id allows creating a working tree at a differnet
1469
revision than the branch is at.
1471
if not isinstance(a_bzrdir.transport, LocalTransport):
1472
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1473
transport = a_bzrdir.get_workingtree_transport(self)
1474
control_files = LockableFiles(transport, 'lock', TransportLock)
1475
control_files.put_utf8('format', self.get_format_string())
1476
branch = a_bzrdir.open_branch()
1477
if revision_id is None:
1478
revision_id = branch.last_revision()
1480
wt = WorkingTree3(a_bzrdir.root_transport.base,
1486
wt._write_inventory(inv)
1487
wt.set_root_id(inv.root.file_id)
1488
wt.set_last_revision(revision_id)
1489
wt.set_pending_merges([])
1490
build_tree(wt.basis_tree(), wt)
1494
super(WorkingTreeFormat3, self).__init__()
1495
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1497
def open(self, a_bzrdir, _found=False):
1498
"""Return the WorkingTree object for a_bzrdir
1500
_found is a private parameter, do not use it. It is used to indicate
1501
if format probing has already been done.
1504
# we are being called directly and must probe.
1505
raise NotImplementedError
1506
if not isinstance(a_bzrdir.transport, LocalTransport):
1507
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1508
return WorkingTree3(a_bzrdir.root_transport.base,
1514
return self.get_format_string()
1517
# formats which have no format string are not discoverable
1518
# and not independently creatable, so are not registered.
1519
__default_format = WorkingTreeFormat3()
1520
WorkingTreeFormat.register_format(__default_format)
1521
WorkingTreeFormat.set_default_format(__default_format)
1522
_legacy_formats = [WorkingTreeFormat2(),
1526
class WorkingTreeTestProviderAdapter(object):
1527
"""A tool to generate a suite testing multiple workingtree formats at once.
1529
This is done by copying the test once for each transport and injecting
1530
the transport_server, transport_readonly_server, and workingtree_format
1531
classes into each copy. Each copy is also given a new id() to make it
1535
def __init__(self, transport_server, transport_readonly_server, formats):
1536
self._transport_server = transport_server
1537
self._transport_readonly_server = transport_readonly_server
1538
self._formats = formats
1540
def adapt(self, test):
1541
from bzrlib.tests import TestSuite
1542
result = TestSuite()
1543
for workingtree_format, bzrdir_format in self._formats:
1544
new_test = deepcopy(test)
1545
new_test.transport_server = self._transport_server
1546
new_test.transport_readonly_server = self._transport_readonly_server
1547
new_test.bzrdir_format = bzrdir_format
1548
new_test.workingtree_format = workingtree_format
1549
def make_new_test_id():
1550
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1551
return lambda: new_id
1552
new_test.id = make_new_test_id()
1553
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
