1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from copy import deepcopy
43
from cStringIO import StringIO
50
from bzrlib.atomicfile import AtomicFile
51
from bzrlib.branch import (Branch,
53
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
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,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError,
68
from bzrlib.inventory import InventoryEntry, Inventory
69
from bzrlib.lockable_files import LockableFiles, TransportLock
70
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
72
from bzrlib.osutils import (
90
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
92
from bzrlib.rio import RioReader, rio_file, Stanza
93
from bzrlib.symbol_versioning import *
94
from bzrlib.textui import show_status
96
from bzrlib.trace import mutter
97
from bzrlib.transform import build_tree
98
from bzrlib.transport import get_transport
99
from bzrlib.transport.local import LocalTransport
104
def gen_file_id(name):
105
"""Return new file id.
107
This should probably generate proper UUIDs, but for the moment we
108
cope with just randomness because running uuidgen every time is
111
from binascii import hexlify
112
from time import time
115
idx = name.rfind('/')
117
name = name[idx+1 : ]
118
idx = name.rfind('\\')
120
name = name[idx+1 : ]
122
# make it not a hidden file
123
name = name.lstrip('.')
125
# remove any wierd characters; we don't escape them but rather
127
name = re.sub(r'[^\w.]', '', name)
129
s = hexlify(rand_bytes(8))
130
return '-'.join((name, compact_date(time()), s))
134
"""Return a new tree-root file id."""
135
return gen_file_id('TREE_ROOT')
138
class TreeEntry(object):
139
"""An entry that implements the minium interface used by commands.
141
This needs further inspection, it may be better to have
142
InventoryEntries without ids - though that seems wrong. For now,
143
this is a parallel hierarchy to InventoryEntry, and needs to become
144
one of several things: decorates to that hierarchy, children of, or
146
Another note is that these objects are currently only used when there is
147
no InventoryEntry available - i.e. for unversioned objects.
148
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
151
def __eq__(self, other):
152
# yes, this us ugly, TODO: best practice __eq__ style.
153
return (isinstance(other, TreeEntry)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeDirectory(TreeEntry):
161
"""See TreeEntry. This is a directory in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeDirectory)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class TreeFile(TreeEntry):
172
"""See TreeEntry. This is a regular file in a working tree."""
174
def __eq__(self, other):
175
return (isinstance(other, TreeFile)
176
and other.__class__ == self.__class__)
178
def kind_character(self):
182
class TreeLink(TreeEntry):
183
"""See TreeEntry. This is a symlink in a working tree."""
185
def __eq__(self, other):
186
return (isinstance(other, TreeLink)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class WorkingTree(bzrlib.tree.Tree):
194
"""Working copy tree.
196
The inventory is held in the `Branch` working-inventory, and the
197
files are in a directory on disk.
199
It is possible for a `WorkingTree` to have a filename which is
200
not listed in the Inventory and vice versa.
203
def __init__(self, basedir='.',
204
branch=DEPRECATED_PARAMETER,
210
"""Construct a WorkingTree for basedir.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
217
self._format = _format
218
self.bzrdir = _bzrdir
220
# not created via open etc.
221
warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self.branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
233
from bzrlib.hashcache import HashCache
234
from bzrlib.trace import note, mutter
235
assert isinstance(basedir, basestring), \
236
"base directory %r is not a string" % basedir
237
basedir = safe_unicode(basedir)
238
mutter("opening working tree %r", basedir)
239
if deprecated_passed(branch):
241
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
" Please use bzrdir.open_workingtree() or"
243
" WorkingTree.open().",
249
self.branch = self.bzrdir.open_branch()
250
assert isinstance(self.branch, Branch), \
251
"branch %r is not a Branch" % self.branch
252
self.basedir = realpath(basedir)
253
# if branch is at our basedir and is a format 6 or less
254
if isinstance(self._format, WorkingTreeFormat2):
255
# share control object
256
self._control_files = self.branch.control_files
258
# only ready for format 3
259
assert isinstance(self._format, WorkingTreeFormat3)
260
assert isinstance(_control_files, LockableFiles), \
261
"_control_files must be a LockableFiles, not %r" \
263
self._control_files = _control_files
264
# update the whole cache up front and write to disk if anything changed;
265
# in the future we might want to do this more selectively
266
# two possible ways offer themselves : in self._unlock, write the cache
267
# if needed, or, when the cache sees a change, append it to the hash
268
# cache file, and have the parser take the most recent entry for a
270
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
273
# is this scan needed ? it makes things kinda slow.
280
if _inventory is None:
281
self._set_inventory(self.read_working_inventory())
283
self._set_inventory(_inventory)
285
def _set_inventory(self, inv):
286
self._inventory = inv
287
self.path2id = self._inventory.path2id
289
def is_control_filename(self, filename):
290
"""True if filename is the name of a control file in this tree.
292
This is true IF and ONLY IF the filename is part of the meta data
293
that bzr controls in this tree. I.E. a random .bzr directory placed
294
on disk will not be a control file for this tree.
297
self.bzrdir.transport.relpath(self.abspath(filename))
299
except errors.PathNotChild:
303
def open(path=None, _unsupported=False):
304
"""Open an existing working tree at path.
308
path = os.path.getcwdu()
309
control = bzrdir.BzrDir.open(path, _unsupported)
310
return control.open_workingtree(_unsupported)
313
def open_containing(path=None):
314
"""Open an existing working tree which has its root about path.
316
This probes for a working tree at path and searches upwards from there.
318
Basically we keep looking up until we find the control directory or
319
run into /. If there isn't one, raises NotBranchError.
320
TODO: give this a new exception.
321
If there is one, it is returned, along with the unused portion of path.
325
control, relpath = bzrdir.BzrDir.open_containing(path)
326
return control.open_workingtree(), relpath
329
def open_downlevel(path=None):
330
"""Open an unsupported working tree.
332
Only intended for advanced situations like upgrading part of a bzrdir.
334
return WorkingTree.open(path, _unsupported=True)
337
"""Iterate through file_ids for this tree.
339
file_ids are in a WorkingTree if they are in the working inventory
340
and the working file exists.
342
inv = self._inventory
343
for path, ie in inv.iter_entries():
344
if bzrlib.osutils.lexists(self.abspath(path)):
348
return "<%s of %s>" % (self.__class__.__name__,
349
getattr(self, 'basedir', None))
351
def abspath(self, filename):
352
return pathjoin(self.basedir, filename)
354
def basis_tree(self):
355
"""Return RevisionTree for the current last revision."""
356
revision_id = self.last_revision()
357
if revision_id is not None:
359
xml = self.read_basis_inventory(revision_id)
360
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
361
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
365
return self.branch.repository.revision_tree(revision_id)
368
@deprecated_method(zero_eight)
369
def create(branch, directory):
370
"""Create a workingtree for branch at directory.
372
If existing_directory already exists it must have a .bzr directory.
373
If it does not exist, it will be created.
375
This returns a new WorkingTree object for the new checkout.
377
TODO FIXME RBC 20060124 when we have checkout formats in place this
378
should accept an optional revisionid to checkout [and reject this if
379
checking out into the same dir as a pre-checkout-aware branch format.]
381
XXX: When BzrDir is present, these should be created through that
384
warn('delete WorkingTree.create', stacklevel=3)
385
transport = get_transport(directory)
386
if branch.bzrdir.root_transport.base == transport.base:
388
return branch.bzrdir.create_workingtree()
389
# different directory,
390
# create a branch reference
391
# and now a working tree.
392
raise NotImplementedError
395
@deprecated_method(zero_eight)
396
def create_standalone(directory):
397
"""Create a checkout and a branch and a repo at directory.
399
Directory must exist and be empty.
401
please use BzrDir.create_standalone_workingtree
403
return bzrdir.BzrDir.create_standalone_workingtree(directory)
405
def relpath(self, abs):
406
"""Return the local path portion from a given absolute path."""
407
return relpath(self.basedir, abs)
409
def has_filename(self, filename):
410
return bzrlib.osutils.lexists(self.abspath(filename))
412
def get_file(self, file_id):
413
return self.get_file_byname(self.id2path(file_id))
415
def get_file_byname(self, filename):
416
return file(self.abspath(filename), 'rb')
418
def get_root_id(self):
419
"""Return the id of this trees root"""
420
inv = self.read_working_inventory()
421
return inv.root.file_id
423
def _get_store_filename(self, file_id):
424
## XXX: badly named; this is not in the store at all
425
return self.abspath(self.id2path(file_id))
428
def clone(self, to_bzrdir, revision_id=None, basis=None):
429
"""Duplicate this working tree into to_bzr, including all state.
431
Specifically modified files are kept as modified, but
432
ignored and unknown files are discarded.
434
If you want to make a new line of development, see bzrdir.sprout()
437
If not None, the cloned tree will have its last revision set to
438
revision, and and difference between the source trees last revision
439
and this one merged in.
442
If not None, a closer copy of a tree which may have some files in
443
common, and which file content should be preferentially copied from.
445
# assumes the target bzr dir format is compatible.
446
result = self._format.initialize(to_bzrdir)
447
self.copy_content_into(result, revision_id)
451
def copy_content_into(self, tree, revision_id=None):
452
"""Copy the current content and user files of this tree into tree."""
453
if revision_id is None:
454
transform_tree(tree, self)
456
# TODO now merge from tree.last_revision to revision
457
transform_tree(tree, self)
458
tree.set_last_revision(revision_id)
461
def commit(self, message=None, revprops=None, *args, **kwargs):
462
# avoid circular imports
463
from bzrlib.commit import Commit
466
if not 'branch-nick' in revprops:
467
revprops['branch-nick'] = self.branch.nick
468
# args for wt.commit start at message from the Commit.commit method,
469
# but with branch a kwarg now, passing in args as is results in the
470
#message being used for the branch
471
args = (DEPRECATED_PARAMETER, message, ) + args
472
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
473
self._set_inventory(self.read_working_inventory())
475
def id2abspath(self, file_id):
476
return self.abspath(self.id2path(file_id))
478
def has_id(self, file_id):
479
# files that have been deleted are excluded
480
inv = self._inventory
481
if not inv.has_id(file_id):
483
path = inv.id2path(file_id)
484
return bzrlib.osutils.lexists(self.abspath(path))
486
def has_or_had_id(self, file_id):
487
if file_id == self.inventory.root.file_id:
489
return self.inventory.has_id(file_id)
491
__contains__ = has_id
493
def get_file_size(self, file_id):
494
return os.path.getsize(self.id2abspath(file_id))
497
def get_file_sha1(self, file_id):
498
path = self._inventory.id2path(file_id)
499
return self._hashcache.get_sha1(path)
501
def is_executable(self, file_id):
502
if not supports_executable():
503
return self._inventory[file_id].executable
505
path = self._inventory.id2path(file_id)
506
mode = os.lstat(self.abspath(path)).st_mode
507
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
510
def add(self, files, ids=None):
511
"""Make files versioned.
513
Note that the command line normally calls smart_add instead,
514
which can automatically recurse.
516
This adds the files to the inventory, so that they will be
517
recorded by the next commit.
520
List of paths to add, relative to the base of the tree.
523
If set, use these instead of automatically generated ids.
524
Must be the same length as the list of files, but may
525
contain None for ids that are to be autogenerated.
527
TODO: Perhaps have an option to add the ids even if the files do
530
TODO: Perhaps callback with the ids and paths as they're added.
532
# TODO: Re-adding a file that is removed in the working copy
533
# should probably put it back with the previous ID.
534
if isinstance(files, basestring):
535
assert(ids is None or isinstance(ids, basestring))
541
ids = [None] * len(files)
543
assert(len(ids) == len(files))
545
inv = self.read_working_inventory()
546
for f,file_id in zip(files, ids):
547
if self.is_control_filename(f):
548
raise BzrError("cannot add control file %s" % quotefn(f))
553
raise BzrError("cannot add top-level %r" % f)
555
fullpath = normpath(self.abspath(f))
558
kind = file_kind(fullpath)
560
if e.errno == errno.ENOENT:
561
raise NoSuchFile(fullpath)
562
# maybe something better?
563
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
565
if not InventoryEntry.versionable_kind(kind):
566
raise BzrError('cannot add: not a versionable file ('
567
'i.e. regular file, symlink or directory): %s' % quotefn(f))
570
file_id = gen_file_id(f)
571
inv.add_path(f, kind=kind, file_id=file_id)
573
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
574
self._write_inventory(inv)
577
def add_pending_merge(self, *revision_ids):
578
# TODO: Perhaps should check at this point that the
579
# history of the revision is actually present?
580
p = self.pending_merges()
582
for rev_id in revision_ids:
588
self.set_pending_merges(p)
591
def pending_merges(self):
592
"""Return a list of pending merges.
594
These are revisions that have been merged into the working
595
directory but not yet committed.
598
merges_file = self._control_files.get_utf8('pending-merges')
600
if e.errno != errno.ENOENT:
604
for l in merges_file.readlines():
605
p.append(l.rstrip('\n'))
609
def set_pending_merges(self, rev_list):
610
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
613
def set_merge_modified(self, modified_hashes):
615
for file_id, hash in modified_hashes.iteritems():
616
yield Stanza(file_id=file_id, hash=hash)
617
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
def _put_rio(self, filename, stanzas, header):
621
my_file = rio_file(stanzas, header)
622
self._control_files.put(filename, my_file)
625
def merge_modified(self):
627
hashfile = self._control_files.get('merge-hashes')
632
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
633
raise MergeModifiedFormatError()
634
except StopIteration:
635
raise MergeModifiedFormatError()
636
for s in RioReader(hashfile):
637
file_id = s.get("file_id")
639
if hash == self.get_file_sha1(file_id):
640
merge_hashes[file_id] = hash
643
def get_symlink_target(self, file_id):
644
return os.readlink(self.id2abspath(file_id))
646
def file_class(self, filename):
647
if self.path2id(filename):
649
elif self.is_ignored(filename):
654
def list_files(self):
655
"""Recursively list all files as (path, class, kind, id).
657
Lists, but does not descend into unversioned directories.
659
This does not include files that have been deleted in this
662
Skips the control directory.
664
inv = self._inventory
666
def descend(from_dir_relpath, from_dir_id, dp):
670
## TODO: If we find a subdirectory with its own .bzr
671
## directory, then that is a separate tree and we
672
## should exclude it.
674
# the bzrdir for this tree
675
if self.bzrdir.transport.base.endswith(f + '/'):
679
fp = appendpath(from_dir_relpath, f)
682
fap = appendpath(dp, f)
684
f_ie = inv.get_child(from_dir_id, f)
687
elif self.is_ignored(fp):
696
raise BzrCheckError("file %r entered as kind %r id %r, "
698
% (fap, f_ie.kind, f_ie.file_id, fk))
700
# make a last minute entry
704
if fk == 'directory':
705
entry = TreeDirectory()
708
elif fk == 'symlink':
713
yield fp, c, fk, (f_ie and f_ie.file_id), entry
715
if fk != 'directory':
719
# don't descend unversioned directories
722
for ff in descend(fp, f_ie.file_id, fap):
725
for f in descend(u'', inv.root.file_id, self.basedir):
729
def move(self, from_paths, to_name):
732
to_name must exist in the inventory.
734
If to_name exists and is a directory, the files are moved into
735
it, keeping their old names.
737
Note that to_name is only the last component of the new name;
738
this doesn't change the directory.
740
This returns a list of (from_path, to_path) pairs for each
744
## TODO: Option to move IDs only
745
assert not isinstance(from_paths, basestring)
747
to_abs = self.abspath(to_name)
748
if not isdir(to_abs):
749
raise BzrError("destination %r is not a directory" % to_abs)
750
if not self.has_filename(to_name):
751
raise BzrError("destination %r not in working directory" % to_abs)
752
to_dir_id = inv.path2id(to_name)
753
if to_dir_id == None and to_name != '':
754
raise BzrError("destination %r is not a versioned directory" % to_name)
755
to_dir_ie = inv[to_dir_id]
756
if to_dir_ie.kind not in ('directory', 'root_directory'):
757
raise BzrError("destination %r is not a directory" % to_abs)
759
to_idpath = inv.get_idpath(to_dir_id)
762
if not self.has_filename(f):
763
raise BzrError("%r does not exist in working tree" % f)
764
f_id = inv.path2id(f)
766
raise BzrError("%r is not versioned" % f)
767
name_tail = splitpath(f)[-1]
768
dest_path = appendpath(to_name, name_tail)
769
if self.has_filename(dest_path):
770
raise BzrError("destination %r already exists" % dest_path)
771
if f_id in to_idpath:
772
raise BzrError("can't move %r to a subdirectory of itself" % f)
774
# OK, so there's a race here, it's possible that someone will
775
# create a file in this interval and then the rename might be
776
# left half-done. But we should have caught most problems.
777
orig_inv = deepcopy(self.inventory)
780
name_tail = splitpath(f)[-1]
781
dest_path = appendpath(to_name, name_tail)
782
result.append((f, dest_path))
783
inv.rename(inv.path2id(f), to_dir_id, name_tail)
785
rename(self.abspath(f), self.abspath(dest_path))
787
raise BzrError("failed to rename %r to %r: %s" %
788
(f, dest_path, e[1]),
789
["rename rolled back"])
791
# restore the inventory on error
792
self._set_inventory(orig_inv)
794
self._write_inventory(inv)
798
def rename_one(self, from_rel, to_rel):
801
This can change the directory or the filename or both.
804
if not self.has_filename(from_rel):
805
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
806
if self.has_filename(to_rel):
807
raise BzrError("can't rename: new working file %r already exists" % to_rel)
809
file_id = inv.path2id(from_rel)
811
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
814
from_parent = entry.parent_id
815
from_name = entry.name
817
if inv.path2id(to_rel):
818
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
820
to_dir, to_tail = os.path.split(to_rel)
821
to_dir_id = inv.path2id(to_dir)
822
if to_dir_id == None and to_dir != '':
823
raise BzrError("can't determine destination directory id for %r" % to_dir)
825
mutter("rename_one:")
826
mutter(" file_id {%s}" % file_id)
827
mutter(" from_rel %r" % from_rel)
828
mutter(" to_rel %r" % to_rel)
829
mutter(" to_dir %r" % to_dir)
830
mutter(" to_dir_id {%s}" % to_dir_id)
832
inv.rename(file_id, to_dir_id, to_tail)
834
from_abs = self.abspath(from_rel)
835
to_abs = self.abspath(to_rel)
837
rename(from_abs, to_abs)
839
inv.rename(file_id, from_parent, from_name)
840
raise BzrError("failed to rename %r to %r: %s"
841
% (from_abs, to_abs, e[1]),
842
["rename rolled back"])
843
self._write_inventory(inv)
847
"""Return all unknown files.
849
These are files in the working directory that are not versioned or
850
control files or ignored.
852
>>> from bzrlib.bzrdir import ScratchDir
853
>>> d = ScratchDir(files=['foo', 'foo~'])
854
>>> b = d.open_branch()
855
>>> tree = d.open_workingtree()
856
>>> map(str, tree.unknowns())
859
>>> list(b.unknowns())
861
>>> tree.remove('foo')
862
>>> list(b.unknowns())
865
for subp in self.extras():
866
if not self.is_ignored(subp):
869
@deprecated_method(zero_eight)
870
def iter_conflicts(self):
871
"""List all files in the tree that have text or content conflicts.
872
DEPRECATED. Use conflicts instead."""
873
return self._iter_conflicts()
875
def _iter_conflicts(self):
877
for path in (s[0] for s in self.list_files()):
878
stem = get_conflicted_stem(path)
881
if stem not in conflicted:
886
def pull(self, source, overwrite=False, stop_revision=None):
887
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
890
pp = ProgressPhase("Pull phase", 2, top_pb)
892
old_revision_history = self.branch.revision_history()
893
basis_tree = self.basis_tree()
894
count = self.branch.pull(source, overwrite, stop_revision)
895
new_revision_history = self.branch.revision_history()
896
if new_revision_history != old_revision_history:
898
if len(old_revision_history):
899
other_revision = old_revision_history[-1]
901
other_revision = None
902
repository = self.branch.repository
903
pb = bzrlib.ui.ui_factory.nested_progress_bar()
905
merge_inner(self.branch,
906
self.branch.basis_tree(),
912
self.set_last_revision(self.branch.last_revision())
919
"""Yield all unknown files in this WorkingTree.
921
If there are any unknown directories then only the directory is
922
returned, not all its children. But if there are unknown files
923
under a versioned subdirectory, they are returned.
925
Currently returned depth-first, sorted by name within directories.
927
## TODO: Work from given directory downwards
928
for path, dir_entry in self.inventory.directories():
929
mutter("search for unknowns in %r", path)
930
dirabs = self.abspath(path)
931
if not isdir(dirabs):
932
# e.g. directory deleted
936
for subf in os.listdir(dirabs):
938
and (subf not in dir_entry.children)):
943
subp = appendpath(path, subf)
947
def ignored_files(self):
948
"""Yield list of PATH, IGNORE_PATTERN"""
949
for subp in self.extras():
950
pat = self.is_ignored(subp)
955
def get_ignore_list(self):
956
"""Return list of ignore patterns.
958
Cached in the Tree object after the first call.
960
if hasattr(self, '_ignorelist'):
961
return self._ignorelist
963
l = bzrlib.DEFAULT_IGNORE[:]
964
if self.has_filename(bzrlib.IGNORE_FILENAME):
965
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
966
l.extend([line.rstrip("\n\r") for line in f.readlines()])
971
def is_ignored(self, filename):
972
r"""Check whether the filename matches an ignore pattern.
974
Patterns containing '/' or '\' need to match the whole path;
975
others match against only the last component.
977
If the file is ignored, returns the pattern which caused it to
978
be ignored, otherwise None. So this can simply be used as a
979
boolean if desired."""
981
# TODO: Use '**' to match directories, and other extended
982
# globbing stuff from cvs/rsync.
984
# XXX: fnmatch is actually not quite what we want: it's only
985
# approximately the same as real Unix fnmatch, and doesn't
986
# treat dotfiles correctly and allows * to match /.
987
# Eventually it should be replaced with something more
990
for pat in self.get_ignore_list():
991
if '/' in pat or '\\' in pat:
993
# as a special case, you can put ./ at the start of a
994
# pattern; this is good to match in the top-level
997
if (pat[:2] == './') or (pat[:2] == '.\\'):
1001
if fnmatch.fnmatchcase(filename, newpat):
1004
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1009
def kind(self, file_id):
1010
return file_kind(self.id2abspath(file_id))
1013
def last_revision(self):
1014
"""Return the last revision id of this working tree.
1016
In early branch formats this was == the branch last_revision,
1017
but that cannot be relied upon - for working tree operations,
1018
always use tree.last_revision().
1020
return self.branch.last_revision()
1022
def lock_read(self):
1023
"""See Branch.lock_read, and WorkingTree.unlock."""
1024
self.branch.lock_read()
1026
return self._control_files.lock_read()
1028
self.branch.unlock()
1031
def lock_write(self):
1032
"""See Branch.lock_write, and WorkingTree.unlock."""
1033
self.branch.lock_write()
1035
return self._control_files.lock_write()
1037
self.branch.unlock()
1040
def _basis_inventory_name(self, revision_id):
1041
return 'basis-inventory.%s' % revision_id
1044
def set_last_revision(self, new_revision, old_revision=None):
1045
"""Change the last revision in the working tree."""
1046
self._remove_old_basis(old_revision)
1047
if self._change_last_revision(new_revision):
1048
self._cache_basis_inventory(new_revision)
1050
def _change_last_revision(self, new_revision):
1051
"""Template method part of set_last_revision to perform the change."""
1052
if new_revision is None:
1053
self.branch.set_revision_history([])
1055
# current format is locked in with the branch
1056
revision_history = self.branch.revision_history()
1058
position = revision_history.index(new_revision)
1060
raise errors.NoSuchRevision(self.branch, new_revision)
1061
self.branch.set_revision_history(revision_history[:position + 1])
1064
def _cache_basis_inventory(self, new_revision):
1065
"""Cache new_revision as the basis inventory."""
1067
xml = self.branch.repository.get_inventory_xml(new_revision)
1068
path = self._basis_inventory_name(new_revision)
1069
self._control_files.put_utf8(path, xml)
1070
except WeaveRevisionNotPresent:
1073
def _remove_old_basis(self, old_revision):
1074
"""Remove the old basis inventory 'old_revision'."""
1075
if old_revision is not None:
1077
path = self._basis_inventory_name(old_revision)
1078
path = self._control_files._escape(path)
1079
self._control_files._transport.delete(path)
1083
def read_basis_inventory(self, revision_id):
1084
"""Read the cached basis inventory."""
1085
path = self._basis_inventory_name(revision_id)
1086
return self._control_files.get_utf8(path).read()
1089
def read_working_inventory(self):
1090
"""Read the working inventory."""
1091
# ElementTree does its own conversion from UTF-8, so open in
1093
result = bzrlib.xml5.serializer_v5.read_inventory(
1094
self._control_files.get('inventory'))
1095
self._set_inventory(result)
1099
def remove(self, files, verbose=False):
1100
"""Remove nominated files from the working inventory..
1102
This does not remove their text. This does not run on XXX on what? RBC
1104
TODO: Refuse to remove modified files unless --force is given?
1106
TODO: Do something useful with directories.
1108
TODO: Should this remove the text or not? Tough call; not
1109
removing may be useful and the user can just use use rm, and
1110
is the opposite of add. Removing it is consistent with most
1111
other tools. Maybe an option.
1113
## TODO: Normalize names
1114
## TODO: Remove nested loops; better scalability
1115
if isinstance(files, basestring):
1118
inv = self.inventory
1120
# do this before any modifications
1122
fid = inv.path2id(f)
1124
# TODO: Perhaps make this just a warning, and continue?
1125
# This tends to happen when
1126
raise NotVersionedError(path=f)
1127
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1129
# having remove it, it must be either ignored or unknown
1130
if self.is_ignored(f):
1134
show_status(new_status, inv[fid].kind, quotefn(f))
1137
self._write_inventory(inv)
1140
def revert(self, filenames, old_tree=None, backups=True,
1141
pb=DummyProgress()):
1142
from transform import revert
1143
from conflicts import resolve
1144
if old_tree is None:
1145
old_tree = self.basis_tree()
1146
revert(self, old_tree, filenames, backups, pb)
1147
if not len(filenames):
1148
self.set_pending_merges([])
1151
resolve(self, filenames, ignore_misses=True)
1154
def set_inventory(self, new_inventory_list):
1155
from bzrlib.inventory import (Inventory,
1160
inv = Inventory(self.get_root_id())
1161
for path, file_id, parent, kind in new_inventory_list:
1162
name = os.path.basename(path)
1165
# fixme, there should be a factory function inv,add_??
1166
if kind == 'directory':
1167
inv.add(InventoryDirectory(file_id, name, parent))
1168
elif kind == 'file':
1169
inv.add(InventoryFile(file_id, name, parent))
1170
elif kind == 'symlink':
1171
inv.add(InventoryLink(file_id, name, parent))
1173
raise BzrError("unknown kind %r" % kind)
1174
self._write_inventory(inv)
1177
def set_root_id(self, file_id):
1178
"""Set the root id for this tree."""
1179
inv = self.read_working_inventory()
1180
orig_root_id = inv.root.file_id
1181
del inv._byid[inv.root.file_id]
1182
inv.root.file_id = file_id
1183
inv._byid[inv.root.file_id] = inv.root
1186
if entry.parent_id == orig_root_id:
1187
entry.parent_id = inv.root.file_id
1188
self._write_inventory(inv)
1191
"""See Branch.unlock.
1193
WorkingTree locking just uses the Branch locking facilities.
1194
This is current because all working trees have an embedded branch
1195
within them. IF in the future, we were to make branch data shareable
1196
between multiple working trees, i.e. via shared storage, then we
1197
would probably want to lock both the local tree, and the branch.
1199
# FIXME: We want to write out the hashcache only when the last lock on
1200
# this working copy is released. Peeking at the lock count is a bit
1201
# of a nasty hack; probably it's better to have a transaction object,
1202
# which can do some finalization when it's either successfully or
1203
# unsuccessfully completed. (Denys's original patch did that.)
1204
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1205
# wrongly. Hookinh into unllock on the control files object is fine though.
1207
# TODO: split this per format so there is no ugly if block
1208
if self._hashcache.needs_write and (
1209
# dedicated lock files
1210
self._control_files._lock_count==1 or
1212
(self._control_files is self.branch.control_files and
1213
self._control_files._lock_count==3)):
1214
self._hashcache.write()
1215
# reverse order of locking.
1216
result = self._control_files.unlock()
1218
self.branch.unlock()
1224
"""Update a working tree along its branch.
1226
This will update the branch if its bound too, which means we have multiple trees involved:
1227
The new basis tree of the master.
1228
The old basis tree of the branch.
1229
The old basis tree of the working tree.
1230
The current working tree state.
1231
pathologically all three may be different, and non ancestors of each other.
1232
Conceptually we want to:
1233
Preserve the wt.basis->wt.state changes
1234
Transform the wt.basis to the new master basis.
1235
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1236
Restore the wt.basis->wt.state changes.
1238
There isn't a single operation at the moment to do that, so we:
1239
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1240
Do a 'normal' merge of the old branch basis if it is relevant.
1242
old_tip = self.branch.update()
1243
if old_tip is not None:
1244
self.add_pending_merge(old_tip)
1245
self.branch.lock_read()
1248
if self.last_revision() != self.branch.last_revision():
1249
# merge tree state up to new branch tip.
1250
basis = self.basis_tree()
1251
to_tree = self.branch.basis_tree()
1252
result += merge_inner(self.branch,
1256
self.set_last_revision(self.branch.last_revision())
1257
if old_tip and old_tip != self.last_revision():
1258
# our last revision was not the prior branch last reivison
1259
# and we have converted that last revision to a pending merge.
1260
# base is somewhere between the branch tip now
1261
# and the now pending merge
1262
from bzrlib.revision import common_ancestor
1264
base_rev_id = common_ancestor(self.branch.last_revision(),
1266
self.branch.repository)
1267
except errors.NoCommonAncestor:
1269
base_tree = self.branch.repository.revision_tree(base_rev_id)
1270
other_tree = self.branch.repository.revision_tree(old_tip)
1271
result += merge_inner(self.branch,
1277
self.branch.unlock()
1280
def _write_inventory(self, inv):
1281
"""Write inventory as the current inventory."""
1283
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1285
self._control_files.put('inventory', sio)
1286
self._set_inventory(inv)
1287
mutter('wrote working inventory')
1289
def set_conflicts(self, arg):
1290
raise UnsupportedOperation(self.set_conflicts, self)
1293
def conflicts(self):
1294
conflicts = ConflictList()
1295
for conflicted in self._iter_conflicts():
1298
if file_kind(self.abspath(conflicted)) != "file":
1301
if e.errno == errno.ENOENT:
1306
for suffix in ('.THIS', '.OTHER'):
1308
kind = file_kind(self.abspath(conflicted+suffix))
1310
if e.errno == errno.ENOENT:
1318
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1319
conflicts.append(Conflict.factory(ctype, path=conflicted,
1320
file_id=self.path2id(conflicted)))
1324
class WorkingTree3(WorkingTree):
1325
"""This is the Format 3 working tree.
1327
This differs from the base WorkingTree by:
1328
- having its own file lock
1329
- having its own last-revision property.
1331
This is new in bzr 0.8
1335
def last_revision(self):
1336
"""See WorkingTree.last_revision."""
1338
return self._control_files.get_utf8('last-revision').read()
1342
def _change_last_revision(self, revision_id):
1343
"""See WorkingTree._change_last_revision."""
1344
if revision_id is None or revision_id == NULL_REVISION:
1346
self._control_files._transport.delete('last-revision')
1347
except errors.NoSuchFile:
1352
self.branch.revision_history().index(revision_id)
1354
raise errors.NoSuchRevision(self.branch, revision_id)
1355
self._control_files.put_utf8('last-revision', revision_id)
1359
def set_conflicts(self, conflicts):
1360
self._put_rio('conflicts', conflicts.to_stanzas(),
1364
def conflicts(self):
1366
confile = self._control_files.get('conflicts')
1368
return ConflictList()
1370
if confile.next() != CONFLICT_HEADER_1 + '\n':
1371
raise ConflictFormatError()
1372
except StopIteration:
1373
raise ConflictFormatError()
1374
return ConflictList.from_stanzas(RioReader(confile))
1377
def get_conflicted_stem(path):
1378
for suffix in CONFLICT_SUFFIXES:
1379
if path.endswith(suffix):
1380
return path[:-len(suffix)]
1382
@deprecated_function(zero_eight)
1383
def is_control_file(filename):
1384
"""See WorkingTree.is_control_filename(filename)."""
1385
## FIXME: better check
1386
filename = normpath(filename)
1387
while filename != '':
1388
head, tail = os.path.split(filename)
1389
## mutter('check %r for control file' % ((head, tail),))
1392
if filename == head:
1398
class WorkingTreeFormat(object):
1399
"""An encapsulation of the initialization and open routines for a format.
1401
Formats provide three things:
1402
* An initialization routine,
1406
Formats are placed in an dict by their format string for reference
1407
during workingtree opening. Its not required that these be instances, they
1408
can be classes themselves with class methods - it simply depends on
1409
whether state is needed for a given format or not.
1411
Once a format is deprecated, just deprecate the initialize and open
1412
methods on the format class. Do not deprecate the object, as the
1413
object will be created every time regardless.
1416
_default_format = None
1417
"""The default format used for new trees."""
1420
"""The known formats."""
1423
def find_format(klass, a_bzrdir):
1424
"""Return the format for the working tree object in a_bzrdir."""
1426
transport = a_bzrdir.get_workingtree_transport(None)
1427
format_string = transport.get("format").read()
1428
return klass._formats[format_string]
1430
raise errors.NoWorkingTree(base=transport.base)
1432
raise errors.UnknownFormatError(format_string)
1435
def get_default_format(klass):
1436
"""Return the current default format."""
1437
return klass._default_format
1439
def get_format_string(self):
1440
"""Return the ASCII format string that identifies this format."""
1441
raise NotImplementedError(self.get_format_string)
1443
def is_supported(self):
1444
"""Is this format supported?
1446
Supported formats can be initialized and opened.
1447
Unsupported formats may not support initialization or committing or
1448
some other features depending on the reason for not being supported.
1453
def register_format(klass, format):
1454
klass._formats[format.get_format_string()] = format
1457
def set_default_format(klass, format):
1458
klass._default_format = format
1461
def unregister_format(klass, format):
1462
assert klass._formats[format.get_format_string()] is format
1463
del klass._formats[format.get_format_string()]
1467
class WorkingTreeFormat2(WorkingTreeFormat):
1468
"""The second working tree format.
1470
This format modified the hash cache from the format 1 hash cache.
1473
def initialize(self, a_bzrdir, revision_id=None):
1474
"""See WorkingTreeFormat.initialize()."""
1475
if not isinstance(a_bzrdir.transport, LocalTransport):
1476
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1477
branch = a_bzrdir.open_branch()
1478
if revision_id is not None:
1481
revision_history = branch.revision_history()
1483
position = revision_history.index(revision_id)
1485
raise errors.NoSuchRevision(branch, revision_id)
1486
branch.set_revision_history(revision_history[:position + 1])
1489
revision = branch.last_revision()
1491
wt = WorkingTree(a_bzrdir.root_transport.base,
1497
wt._write_inventory(inv)
1498
wt.set_root_id(inv.root.file_id)
1499
wt.set_last_revision(revision)
1500
wt.set_pending_merges([])
1501
build_tree(wt.basis_tree(), wt)
1505
super(WorkingTreeFormat2, self).__init__()
1506
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1508
def open(self, a_bzrdir, _found=False):
1509
"""Return the WorkingTree object for a_bzrdir
1511
_found is a private parameter, do not use it. It is used to indicate
1512
if format probing has already been done.
1515
# we are being called directly and must probe.
1516
raise NotImplementedError
1517
if not isinstance(a_bzrdir.transport, LocalTransport):
1518
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1519
return WorkingTree(a_bzrdir.root_transport.base,
1525
class WorkingTreeFormat3(WorkingTreeFormat):
1526
"""The second working tree format updated to record a format marker.
1529
- exists within a metadir controlling .bzr
1530
- includes an explicit version marker for the workingtree control
1531
files, separate from the BzrDir format
1532
- modifies the hash cache format
1534
- uses a LockDir to guard access to the repository
1537
def get_format_string(self):
1538
"""See WorkingTreeFormat.get_format_string()."""
1539
return "Bazaar-NG Working Tree format 3"
1541
_lock_file_name = 'lock'
1542
_lock_class = LockDir
1544
def _open_control_files(self, a_bzrdir):
1545
transport = a_bzrdir.get_workingtree_transport(None)
1546
return LockableFiles(transport, self._lock_file_name,
1549
def initialize(self, a_bzrdir, revision_id=None):
1550
"""See WorkingTreeFormat.initialize().
1552
revision_id allows creating a working tree at a differnet
1553
revision than the branch is at.
1555
if not isinstance(a_bzrdir.transport, LocalTransport):
1556
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1557
transport = a_bzrdir.get_workingtree_transport(self)
1558
control_files = self._open_control_files(a_bzrdir)
1559
control_files.create_lock()
1560
control_files.put_utf8('format', self.get_format_string())
1561
branch = a_bzrdir.open_branch()
1562
if revision_id is None:
1563
revision_id = branch.last_revision()
1565
wt = WorkingTree3(a_bzrdir.root_transport.base,
1571
_control_files=control_files)
1572
wt._write_inventory(inv)
1573
wt.set_root_id(inv.root.file_id)
1574
wt.set_last_revision(revision_id)
1575
wt.set_pending_merges([])
1576
build_tree(wt.basis_tree(), wt)
1580
super(WorkingTreeFormat3, self).__init__()
1581
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1583
def open(self, a_bzrdir, _found=False):
1584
"""Return the WorkingTree object for a_bzrdir
1586
_found is a private parameter, do not use it. It is used to indicate
1587
if format probing has already been done.
1590
# we are being called directly and must probe.
1591
raise NotImplementedError
1592
if not isinstance(a_bzrdir.transport, LocalTransport):
1593
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1594
control_files = self._open_control_files(a_bzrdir)
1595
return WorkingTree3(a_bzrdir.root_transport.base,
1599
_control_files=control_files)
1602
return self.get_format_string()
1605
# formats which have no format string are not discoverable
1606
# and not independently creatable, so are not registered.
1607
__default_format = WorkingTreeFormat3()
1608
WorkingTreeFormat.register_format(__default_format)
1609
WorkingTreeFormat.set_default_format(__default_format)
1610
_legacy_formats = [WorkingTreeFormat2(),
1614
class WorkingTreeTestProviderAdapter(object):
1615
"""A tool to generate a suite testing multiple workingtree formats at once.
1617
This is done by copying the test once for each transport and injecting
1618
the transport_server, transport_readonly_server, and workingtree_format
1619
classes into each copy. Each copy is also given a new id() to make it
1623
def __init__(self, transport_server, transport_readonly_server, formats):
1624
self._transport_server = transport_server
1625
self._transport_readonly_server = transport_readonly_server
1626
self._formats = formats
1628
def adapt(self, test):
1629
from bzrlib.tests import TestSuite
1630
result = TestSuite()
1631
for workingtree_format, bzrdir_format in self._formats:
1632
new_test = deepcopy(test)
1633
new_test.transport_server = self._transport_server
1634
new_test.transport_readonly_server = self._transport_readonly_server
1635
new_test.bzrdir_format = bzrdir_format
1636
new_test.workingtree_format = workingtree_format
1637
def make_new_test_id():
1638
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1639
return lambda: new_id
1640
new_test.id = make_new_test_id()
1641
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
