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
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
import bzrlib.bzrdir as bzrdir
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
import bzrlib.errors as errors
59
from bzrlib.errors import (BzrCheckError,
62
WeaveRevisionNotPresent,
66
MergeModifiedFormatError)
67
from bzrlib.inventory import InventoryEntry, Inventory
68
from bzrlib.lockable_files import LockableFiles, TransportLock
69
from bzrlib.merge import merge_inner, transform_tree
70
from bzrlib.osutils import (
88
from bzrlib.progress import DummyProgress
89
from bzrlib.revision import NULL_REVISION
90
from bzrlib.rio import RioReader, RioWriter, Stanza
91
from bzrlib.symbol_versioning import *
92
from bzrlib.textui import show_status
94
from bzrlib.trace import mutter
95
from bzrlib.transform import build_tree
96
from bzrlib.transport import get_transport
97
from bzrlib.transport.local import LocalTransport
102
def _get_non_word_re():
103
"""Get the compiled regular expression for non-unicode words."""
105
if _non_word_re is None:
107
# TODO: jam 20060106 Currently the BZR codebase can't really handle
108
# unicode ids. There are a lot of code paths which don't
109
# expect them. And we need to do more serious testing
110
# before we enable unicode in ids.
111
#_non_word_re = re.compile(r'[^\w.]', re.UNICODE)
112
_non_word_re = re.compile(r'[^\w.]')
116
def gen_file_id(name):
117
"""Return new file id.
119
This should probably generate proper UUIDs, but for the moment we
120
cope with just randomness because running uuidgen every time is
123
from binascii import hexlify
124
from time import time
127
idx = name.rfind('/')
129
name = name[idx+1 : ]
130
idx = name.rfind('\\')
132
name = name[idx+1 : ]
134
# make it not a hidden file
135
name = name.lstrip('.')
137
# remove any wierd characters; we don't escape them but rather
139
non_word = _get_non_word_re()
140
name = non_word.sub('', name)
142
s = hexlify(rand_bytes(8))
143
return '-'.join((name, compact_date(time()), s))
147
"""Return a new tree-root file id."""
148
return gen_file_id('TREE_ROOT')
151
class TreeEntry(object):
152
"""An entry that implements the minium interface used by commands.
154
This needs further inspection, it may be better to have
155
InventoryEntries without ids - though that seems wrong. For now,
156
this is a parallel hierarchy to InventoryEntry, and needs to become
157
one of several things: decorates to that hierarchy, children of, or
159
Another note is that these objects are currently only used when there is
160
no InventoryEntry available - i.e. for unversioned objects.
161
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
164
def __eq__(self, other):
165
# yes, this us ugly, TODO: best practice __eq__ style.
166
return (isinstance(other, TreeEntry)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeDirectory(TreeEntry):
174
"""See TreeEntry. This is a directory in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeDirectory)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeFile(TreeEntry):
185
"""See TreeEntry. This is a regular file in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeFile)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeLink(TreeEntry):
196
"""See TreeEntry. This is a symlink in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeLink)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class WorkingTree(bzrlib.tree.Tree):
207
"""Working copy tree.
209
The inventory is held in the `Branch` working-inventory, and the
210
files are in a directory on disk.
212
It is possible for a `WorkingTree` to have a filename which is
213
not listed in the Inventory and vice versa.
216
def __init__(self, basedir='.',
217
branch=DEPRECATED_PARAMETER,
223
"""Construct a WorkingTree for basedir.
225
If the branch is not supplied, it is opened automatically.
226
If the branch is supplied, it must be the branch for this basedir.
227
(branch.base is not cross checked, because for remote branches that
228
would be meaningless).
230
self._format = _format
231
self.bzrdir = _bzrdir
233
# not created via open etc.
234
warn("WorkingTree() is deprecated as of bzr version 0.8. "
235
"Please use bzrdir.open_workingtree or WorkingTree.open().",
238
wt = WorkingTree.open(basedir)
239
self.branch = wt.branch
240
self.basedir = wt.basedir
241
self._control_files = wt._control_files
242
self._hashcache = wt._hashcache
243
self._set_inventory(wt._inventory)
244
self._format = wt._format
245
self.bzrdir = wt.bzrdir
246
from bzrlib.hashcache import HashCache
247
from bzrlib.trace import note, mutter
248
assert isinstance(basedir, basestring), \
249
"base directory %r is not a string" % basedir
250
basedir = safe_unicode(basedir)
251
mutter("opening working tree %r", basedir)
252
if deprecated_passed(branch):
254
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
255
" Please use bzrdir.open_workingtree() or WorkingTree.open().",
261
self.branch = self.bzrdir.open_branch()
262
assert isinstance(self.branch, Branch), \
263
"branch %r is not a Branch" % self.branch
264
self.basedir = realpath(basedir)
265
# if branch is at our basedir and is a format 6 or less
266
if isinstance(self._format, WorkingTreeFormat2):
267
# share control object
268
self._control_files = self.branch.control_files
269
elif _control_files is not None:
270
assert False, "not done yet"
271
# self._control_files = _control_files
273
# only ready for format 3
274
assert isinstance(self._format, WorkingTreeFormat3)
275
self._control_files = LockableFiles(
276
self.bzrdir.get_workingtree_transport(None),
277
'lock', TransportLock)
279
# update the whole cache up front and write to disk if anything changed;
280
# in the future we might want to do this more selectively
281
# two possible ways offer themselves : in self._unlock, write the cache
282
# if needed, or, when the cache sees a change, append it to the hash
283
# cache file, and have the parser take the most recent entry for a
285
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
286
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
288
# is this scan needed ? it makes things kinda slow.
295
if _inventory is None:
296
self._set_inventory(self.read_working_inventory())
298
self._set_inventory(_inventory)
300
def _set_inventory(self, inv):
301
self._inventory = inv
302
self.path2id = self._inventory.path2id
304
def is_control_filename(self, filename):
305
"""True if filename is the name of a control file in this tree.
307
This is true IF and ONLY IF the filename is part of the meta data
308
that bzr controls in this tree. I.E. a random .bzr directory placed
309
on disk will not be a control file for this tree.
312
self.bzrdir.transport.relpath(self.abspath(filename))
314
except errors.PathNotChild:
318
def open(path=None, _unsupported=False):
319
"""Open an existing working tree at path.
323
path = os.path.getcwdu()
324
control = bzrdir.BzrDir.open(path, _unsupported)
325
return control.open_workingtree(_unsupported)
328
def open_containing(path=None):
329
"""Open an existing working tree which has its root about path.
331
This probes for a working tree at path and searches upwards from there.
333
Basically we keep looking up until we find the control directory or
334
run into /. If there isn't one, raises NotBranchError.
335
TODO: give this a new exception.
336
If there is one, it is returned, along with the unused portion of path.
340
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
352
"""Iterate through file_ids for this tree.
354
file_ids are in a WorkingTree if they are in the working inventory
355
and the working file exists.
357
inv = self._inventory
358
for path, ie in inv.iter_entries():
359
if bzrlib.osutils.lexists(self.abspath(path)):
363
return "<%s of %s>" % (self.__class__.__name__,
364
getattr(self, 'basedir', None))
366
def abspath(self, filename):
367
return pathjoin(self.basedir, filename)
369
def basis_tree(self):
370
"""Return RevisionTree for the current last revision."""
371
revision_id = self.last_revision()
372
if revision_id is not None:
374
xml = self.read_basis_inventory(revision_id)
375
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
376
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
380
return self.branch.repository.revision_tree(revision_id)
383
@deprecated_method(zero_eight)
384
def create(branch, directory):
385
"""Create a workingtree for branch at directory.
387
If existing_directory already exists it must have a .bzr directory.
388
If it does not exist, it will be created.
390
This returns a new WorkingTree object for the new checkout.
392
TODO FIXME RBC 20060124 when we have checkout formats in place this
393
should accept an optional revisionid to checkout [and reject this if
394
checking out into the same dir as a pre-checkout-aware branch format.]
396
XXX: When BzrDir is present, these should be created through that
399
warn('delete WorkingTree.create', stacklevel=3)
400
transport = get_transport(directory)
401
if branch.bzrdir.root_transport.base == transport.base:
403
return branch.bzrdir.create_workingtree()
404
# different directory,
405
# create a branch reference
406
# and now a working tree.
407
raise NotImplementedError
410
@deprecated_method(zero_eight)
411
def create_standalone(directory):
412
"""Create a checkout and a branch and a repo at directory.
414
Directory must exist and be empty.
416
please use BzrDir.create_standalone_workingtree
418
return bzrdir.BzrDir.create_standalone_workingtree(directory)
420
def relpath(self, abs):
421
"""Return the local path portion from a given absolute path."""
422
return relpath(self.basedir, abs)
424
def has_filename(self, filename):
425
return bzrlib.osutils.lexists(self.abspath(filename))
427
def get_file(self, file_id):
428
return self.get_file_byname(self.id2path(file_id))
430
def get_file_byname(self, filename):
431
return file(self.abspath(filename), 'rb')
433
def get_root_id(self):
434
"""Return the id of this trees root"""
435
inv = self.read_working_inventory()
436
return inv.root.file_id
438
def _get_store_filename(self, file_id):
439
## XXX: badly named; this is not in the store at all
440
return self.abspath(self.id2path(file_id))
443
def clone(self, to_bzrdir, revision_id=None, basis=None):
444
"""Duplicate this working tree into to_bzr, including all state.
446
Specifically modified files are kept as modified, but
447
ignored and unknown files are discarded.
449
If you want to make a new line of development, see bzrdir.sprout()
452
If not None, the cloned tree will have its last revision set to
453
revision, and and difference between the source trees last revision
454
and this one merged in.
457
If not None, a closer copy of a tree which may have some files in
458
common, and which file content should be preferentially copied from.
460
# assumes the target bzr dir format is compatible.
461
result = self._format.initialize(to_bzrdir)
462
self.copy_content_into(result, revision_id)
466
def copy_content_into(self, tree, revision_id=None):
467
"""Copy the current content and user files of this tree into tree."""
468
if revision_id is None:
469
transform_tree(tree, self)
471
# TODO now merge from tree.last_revision to revision
472
transform_tree(tree, self)
473
tree.set_last_revision(revision_id)
476
def commit(self, message=None, revprops=None, *args, **kwargs):
477
# avoid circular imports
478
from bzrlib.commit import Commit
481
if not 'branch-nick' in revprops:
482
revprops['branch-nick'] = self.branch.nick
483
# args for wt.commit start at message from the Commit.commit method,
484
# but with branch a kwarg now, passing in args as is results in the
485
#message being used for the branch
486
args = (DEPRECATED_PARAMETER, message, ) + args
487
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
488
self._set_inventory(self.read_working_inventory())
490
def id2abspath(self, file_id):
491
return self.abspath(self.id2path(file_id))
493
def has_id(self, file_id):
494
# files that have been deleted are excluded
495
inv = self._inventory
496
if not inv.has_id(file_id):
498
path = inv.id2path(file_id)
499
return bzrlib.osutils.lexists(self.abspath(path))
501
def has_or_had_id(self, file_id):
502
if file_id == self.inventory.root.file_id:
504
return self.inventory.has_id(file_id)
506
__contains__ = has_id
508
def get_file_size(self, file_id):
509
return os.path.getsize(self.id2abspath(file_id))
512
def get_file_sha1(self, file_id):
513
path = self._inventory.id2path(file_id)
514
return self._hashcache.get_sha1(path)
516
def is_executable(self, file_id):
517
if not supports_executable():
518
return self._inventory[file_id].executable
520
path = self._inventory.id2path(file_id)
521
mode = os.lstat(self.abspath(path)).st_mode
522
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
525
def add(self, files, ids=None):
526
"""Make files versioned.
528
Note that the command line normally calls smart_add instead,
529
which can automatically recurse.
531
This adds the files to the inventory, so that they will be
532
recorded by the next commit.
535
List of paths to add, relative to the base of the tree.
538
If set, use these instead of automatically generated ids.
539
Must be the same length as the list of files, but may
540
contain None for ids that are to be autogenerated.
542
TODO: Perhaps have an option to add the ids even if the files do
545
TODO: Perhaps callback with the ids and paths as they're added.
547
# TODO: Re-adding a file that is removed in the working copy
548
# should probably put it back with the previous ID.
549
if isinstance(files, basestring):
550
assert(ids is None or isinstance(ids, basestring))
556
ids = [None] * len(files)
558
assert(len(ids) == len(files))
560
inv = self.read_working_inventory()
561
for f,file_id in zip(files, ids):
562
if self.is_control_filename(f):
563
raise BzrError("cannot add control file %s" % quotefn(f))
568
raise BzrError("cannot add top-level %r" % f)
570
fullpath = normpath(self.abspath(f))
573
kind = file_kind(fullpath)
575
if e.errno == errno.ENOENT:
576
raise NoSuchFile(fullpath)
577
# maybe something better?
578
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
580
if not InventoryEntry.versionable_kind(kind):
581
raise BzrError('cannot add: not a versionable file ('
582
'i.e. regular file, symlink or directory): %s' % quotefn(f))
585
file_id = gen_file_id(f)
586
inv.add_path(f, kind=kind, file_id=file_id)
588
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
589
self._write_inventory(inv)
592
def add_pending_merge(self, *revision_ids):
593
# TODO: Perhaps should check at this point that the
594
# history of the revision is actually present?
595
p = self.pending_merges()
597
for rev_id in revision_ids:
603
self.set_pending_merges(p)
606
def pending_merges(self):
607
"""Return a list of pending merges.
609
These are revisions that have been merged into the working
610
directory but not yet committed.
613
merges_file = self._control_files.get_utf8('pending-merges')
615
if e.errno != errno.ENOENT:
619
for l in merges_file.readlines():
620
p.append(l.rstrip('\n'))
624
def set_pending_merges(self, rev_list):
625
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
628
def set_merge_modified(self, modified_hashes):
630
my_file.write(MERGE_MODIFIED_HEADER_1 + '\n')
631
writer = RioWriter(my_file)
632
for file_id, hash in modified_hashes.iteritems():
633
s = Stanza(file_id=file_id, hash=hash)
634
writer.write_stanza(s)
636
self._control_files.put('merge-hashes', my_file)
639
def merge_modified(self):
641
hashfile = self._control_files.get('merge-hashes')
646
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
647
raise MergeModifiedFormatError()
648
except StopIteration:
649
raise MergeModifiedFormatError()
650
for s in RioReader(hashfile):
651
file_id = s.get("file_id")
653
if hash == self.get_file_sha1(file_id):
654
merge_hashes[file_id] = hash
657
def get_symlink_target(self, file_id):
658
return os.readlink(self.id2abspath(file_id))
660
def file_class(self, filename):
661
if self.path2id(filename):
663
elif self.is_ignored(filename):
668
def list_files(self):
669
"""Recursively list all files as (path, class, kind, id).
671
Lists, but does not descend into unversioned directories.
673
This does not include files that have been deleted in this
676
Skips the control directory.
678
inv = self._inventory
680
def descend(from_dir_relpath, from_dir_id, dp):
684
## TODO: If we find a subdirectory with its own .bzr
685
## directory, then that is a separate tree and we
686
## should exclude it.
688
# the bzrdir for this tree
689
if self.bzrdir.transport.base.endswith(f + '/'):
693
fp = appendpath(from_dir_relpath, f)
696
fap = appendpath(dp, f)
698
f_ie = inv.get_child(from_dir_id, f)
701
elif self.is_ignored(fp):
710
raise BzrCheckError("file %r entered as kind %r id %r, "
712
% (fap, f_ie.kind, f_ie.file_id, fk))
714
# make a last minute entry
718
if fk == 'directory':
719
entry = TreeDirectory()
722
elif fk == 'symlink':
727
yield fp, c, fk, (f_ie and f_ie.file_id), entry
729
if fk != 'directory':
733
# don't descend unversioned directories
736
for ff in descend(fp, f_ie.file_id, fap):
739
for f in descend(u'', inv.root.file_id, self.basedir):
743
def move(self, from_paths, to_name):
746
to_name must exist in the inventory.
748
If to_name exists and is a directory, the files are moved into
749
it, keeping their old names.
751
Note that to_name is only the last component of the new name;
752
this doesn't change the directory.
754
This returns a list of (from_path, to_path) pairs for each
758
## TODO: Option to move IDs only
759
assert not isinstance(from_paths, basestring)
761
to_abs = self.abspath(to_name)
762
if not isdir(to_abs):
763
raise BzrError("destination %r is not a directory" % to_abs)
764
if not self.has_filename(to_name):
765
raise BzrError("destination %r not in working directory" % to_abs)
766
to_dir_id = inv.path2id(to_name)
767
if to_dir_id == None and to_name != '':
768
raise BzrError("destination %r is not a versioned directory" % to_name)
769
to_dir_ie = inv[to_dir_id]
770
if to_dir_ie.kind not in ('directory', 'root_directory'):
771
raise BzrError("destination %r is not a directory" % to_abs)
773
to_idpath = inv.get_idpath(to_dir_id)
776
if not self.has_filename(f):
777
raise BzrError("%r does not exist in working tree" % f)
778
f_id = inv.path2id(f)
780
raise BzrError("%r is not versioned" % f)
781
name_tail = splitpath(f)[-1]
782
dest_path = appendpath(to_name, name_tail)
783
if self.has_filename(dest_path):
784
raise BzrError("destination %r already exists" % dest_path)
785
if f_id in to_idpath:
786
raise BzrError("can't move %r to a subdirectory of itself" % f)
788
# OK, so there's a race here, it's possible that someone will
789
# create a file in this interval and then the rename might be
790
# left half-done. But we should have caught most problems.
791
orig_inv = deepcopy(self.inventory)
794
name_tail = splitpath(f)[-1]
795
dest_path = appendpath(to_name, name_tail)
796
result.append((f, dest_path))
797
inv.rename(inv.path2id(f), to_dir_id, name_tail)
799
rename(self.abspath(f), self.abspath(dest_path))
801
raise BzrError("failed to rename %r to %r: %s" %
802
(f, dest_path, e[1]),
803
["rename rolled back"])
805
# restore the inventory on error
806
self._set_inventory(orig_inv)
808
self._write_inventory(inv)
812
def rename_one(self, from_rel, to_rel):
815
This can change the directory or the filename or both.
818
if not self.has_filename(from_rel):
819
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
820
if self.has_filename(to_rel):
821
raise BzrError("can't rename: new working file %r already exists" % to_rel)
823
file_id = inv.path2id(from_rel)
825
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
828
from_parent = entry.parent_id
829
from_name = entry.name
831
if inv.path2id(to_rel):
832
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
834
to_dir, to_tail = os.path.split(to_rel)
835
to_dir_id = inv.path2id(to_dir)
836
if to_dir_id == None and to_dir != '':
837
raise BzrError("can't determine destination directory id for %r" % to_dir)
839
mutter("rename_one:")
840
mutter(" file_id {%s}" % file_id)
841
mutter(" from_rel %r" % from_rel)
842
mutter(" to_rel %r" % to_rel)
843
mutter(" to_dir %r" % to_dir)
844
mutter(" to_dir_id {%s}" % to_dir_id)
846
inv.rename(file_id, to_dir_id, to_tail)
848
from_abs = self.abspath(from_rel)
849
to_abs = self.abspath(to_rel)
851
rename(from_abs, to_abs)
853
inv.rename(file_id, from_parent, from_name)
854
raise BzrError("failed to rename %r to %r: %s"
855
% (from_abs, to_abs, e[1]),
856
["rename rolled back"])
857
self._write_inventory(inv)
861
"""Return all unknown files.
863
These are files in the working directory that are not versioned or
864
control files or ignored.
866
>>> from bzrlib.bzrdir import ScratchDir
867
>>> d = ScratchDir(files=['foo', 'foo~'])
868
>>> b = d.open_branch()
869
>>> tree = d.open_workingtree()
870
>>> map(str, tree.unknowns())
873
>>> list(b.unknowns())
875
>>> tree.remove('foo')
876
>>> list(b.unknowns())
879
for subp in self.extras():
880
if not self.is_ignored(subp):
883
def iter_conflicts(self):
885
for path in (s[0] for s in self.list_files()):
886
stem = get_conflicted_stem(path)
889
if stem not in conflicted:
894
def pull(self, source, overwrite=False, stop_revision=None):
897
old_revision_history = self.branch.revision_history()
898
basis_tree = self.basis_tree()
899
count = self.branch.pull(source, overwrite, stop_revision)
900
new_revision_history = self.branch.revision_history()
901
if new_revision_history != old_revision_history:
902
if len(old_revision_history):
903
other_revision = old_revision_history[-1]
905
other_revision = None
906
repository = self.branch.repository
907
pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
merge_inner(self.branch,
910
self.branch.basis_tree(),
916
self.set_last_revision(self.branch.last_revision())
922
"""Yield all unknown files in this WorkingTree.
924
If there are any unknown directories then only the directory is
925
returned, not all its children. But if there are unknown files
926
under a versioned subdirectory, they are returned.
928
Currently returned depth-first, sorted by name within directories.
930
## TODO: Work from given directory downwards
931
for path, dir_entry in self.inventory.directories():
932
mutter("search for unknowns in %r", path)
933
dirabs = self.abspath(path)
934
if not isdir(dirabs):
935
# e.g. directory deleted
939
for subf in os.listdir(dirabs):
941
and (subf not in dir_entry.children)):
946
subp = appendpath(path, subf)
950
def ignored_files(self):
951
"""Yield list of PATH, IGNORE_PATTERN"""
952
for subp in self.extras():
953
pat = self.is_ignored(subp)
958
def get_ignore_list(self):
959
"""Return list of ignore patterns.
961
Cached in the Tree object after the first call.
963
if hasattr(self, '_ignorelist'):
964
return self._ignorelist
966
l = bzrlib.DEFAULT_IGNORE[:]
967
if self.has_filename(bzrlib.IGNORE_FILENAME):
968
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
969
l.extend([line.rstrip("\n\r").decode('utf-8')
970
for line in f.readlines()])
975
def is_ignored(self, filename):
976
r"""Check whether the filename matches an ignore pattern.
978
Patterns containing '/' or '\' need to match the whole path;
979
others match against only the last component.
981
If the file is ignored, returns the pattern which caused it to
982
be ignored, otherwise None. So this can simply be used as a
983
boolean if desired."""
985
# TODO: Use '**' to match directories, and other extended
986
# globbing stuff from cvs/rsync.
988
# XXX: fnmatch is actually not quite what we want: it's only
989
# approximately the same as real Unix fnmatch, and doesn't
990
# treat dotfiles correctly and allows * to match /.
991
# Eventually it should be replaced with something more
994
# FIXME: fnmatch also won't match unicode exact path filenames.
995
# it does seem to handle wildcard, as long as the non-wildcard
996
# characters are ascii.
998
for pat in self.get_ignore_list():
999
if '/' in pat or '\\' in pat:
1001
# as a special case, you can put ./ at the start of a
1002
# pattern; this is good to match in the top-level
1005
if (pat[:2] == './') or (pat[:2] == '.\\'):
1009
if fnmatch.fnmatchcase(filename, newpat):
1012
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1017
def kind(self, file_id):
1018
return file_kind(self.id2abspath(file_id))
1021
def last_revision(self):
1022
"""Return the last revision id of this working tree.
1024
In early branch formats this was == the branch last_revision,
1025
but that cannot be relied upon - for working tree operations,
1026
always use tree.last_revision().
1028
return self.branch.last_revision()
1030
def lock_read(self):
1031
"""See Branch.lock_read, and WorkingTree.unlock."""
1032
self.branch.lock_read()
1034
return self._control_files.lock_read()
1036
self.branch.unlock()
1039
def lock_write(self):
1040
"""See Branch.lock_write, and WorkingTree.unlock."""
1041
self.branch.lock_write()
1043
return self._control_files.lock_write()
1045
self.branch.unlock()
1048
def _basis_inventory_name(self, revision_id):
1049
return 'basis-inventory.%s' % revision_id
1052
def set_last_revision(self, new_revision, old_revision=None):
1053
"""Change the last revision in the working tree."""
1054
self._remove_old_basis(old_revision)
1055
if self._change_last_revision(new_revision):
1056
self._cache_basis_inventory(new_revision)
1058
def _change_last_revision(self, new_revision):
1059
"""Template method part of set_last_revision to perform the change."""
1060
if new_revision is None:
1061
self.branch.set_revision_history([])
1063
# current format is locked in with the branch
1064
revision_history = self.branch.revision_history()
1066
position = revision_history.index(new_revision)
1068
raise errors.NoSuchRevision(self.branch, new_revision)
1069
self.branch.set_revision_history(revision_history[:position + 1])
1072
def _cache_basis_inventory(self, new_revision):
1073
"""Cache new_revision as the basis inventory."""
1075
xml = self.branch.repository.get_inventory_xml(new_revision)
1076
path = self._basis_inventory_name(new_revision)
1077
self._control_files.put_utf8(path, xml)
1078
except WeaveRevisionNotPresent:
1081
def _remove_old_basis(self, old_revision):
1082
"""Remove the old basis inventory 'old_revision'."""
1083
if old_revision is not None:
1085
path = self._basis_inventory_name(old_revision)
1086
path = self._control_files._escape(path)
1087
self._control_files._transport.delete(path)
1091
def read_basis_inventory(self, revision_id):
1092
"""Read the cached basis inventory."""
1093
path = self._basis_inventory_name(revision_id)
1094
return self._control_files.get_utf8(path).read()
1097
def read_working_inventory(self):
1098
"""Read the working inventory."""
1099
# ElementTree does its own conversion from UTF-8, so open in
1101
result = bzrlib.xml5.serializer_v5.read_inventory(
1102
self._control_files.get('inventory'))
1103
self._set_inventory(result)
1107
def remove(self, files, verbose=False):
1108
"""Remove nominated files from the working inventory..
1110
This does not remove their text. This does not run on XXX on what? RBC
1112
TODO: Refuse to remove modified files unless --force is given?
1114
TODO: Do something useful with directories.
1116
TODO: Should this remove the text or not? Tough call; not
1117
removing may be useful and the user can just use use rm, and
1118
is the opposite of add. Removing it is consistent with most
1119
other tools. Maybe an option.
1121
## TODO: Normalize names
1122
## TODO: Remove nested loops; better scalability
1123
if isinstance(files, basestring):
1126
inv = self.inventory
1128
# do this before any modifications
1130
fid = inv.path2id(f)
1132
# TODO: Perhaps make this just a warning, and continue?
1133
# This tends to happen when
1134
raise NotVersionedError(path=f)
1135
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1137
# having remove it, it must be either ignored or unknown
1138
if self.is_ignored(f):
1142
show_status(new_status, inv[fid].kind, quotefn(f))
1145
self._write_inventory(inv)
1148
def revert(self, filenames, old_tree=None, backups=True,
1149
pb=DummyProgress()):
1150
from transform import revert
1151
if old_tree is None:
1152
old_tree = self.basis_tree()
1153
revert(self, old_tree, filenames, backups, pb)
1154
if not len(filenames):
1155
self.set_pending_merges([])
1158
def set_inventory(self, new_inventory_list):
1159
from bzrlib.inventory import (Inventory,
1164
inv = Inventory(self.get_root_id())
1165
for path, file_id, parent, kind in new_inventory_list:
1166
name = os.path.basename(path)
1169
# fixme, there should be a factory function inv,add_??
1170
if kind == 'directory':
1171
inv.add(InventoryDirectory(file_id, name, parent))
1172
elif kind == 'file':
1173
inv.add(InventoryFile(file_id, name, parent))
1174
elif kind == 'symlink':
1175
inv.add(InventoryLink(file_id, name, parent))
1177
raise BzrError("unknown kind %r" % kind)
1178
self._write_inventory(inv)
1181
def set_root_id(self, file_id):
1182
"""Set the root id for this tree."""
1183
inv = self.read_working_inventory()
1184
orig_root_id = inv.root.file_id
1185
del inv._byid[inv.root.file_id]
1186
inv.root.file_id = file_id
1187
inv._byid[inv.root.file_id] = inv.root
1190
if entry.parent_id == orig_root_id:
1191
entry.parent_id = inv.root.file_id
1192
self._write_inventory(inv)
1195
"""See Branch.unlock.
1197
WorkingTree locking just uses the Branch locking facilities.
1198
This is current because all working trees have an embedded branch
1199
within them. IF in the future, we were to make branch data shareable
1200
between multiple working trees, i.e. via shared storage, then we
1201
would probably want to lock both the local tree, and the branch.
1203
# FIXME: We want to write out the hashcache only when the last lock on
1204
# this working copy is released. Peeking at the lock count is a bit
1205
# of a nasty hack; probably it's better to have a transaction object,
1206
# which can do some finalization when it's either successfully or
1207
# unsuccessfully completed. (Denys's original patch did that.)
1208
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1209
# wrongly. Hookinh into unllock on the control files object is fine though.
1211
# TODO: split this per format so there is no ugly if block
1212
if self._hashcache.needs_write and (
1213
# dedicated lock files
1214
self._control_files._lock_count==1 or
1216
(self._control_files is self.branch.control_files and
1217
self._control_files._lock_count==3)):
1218
self._hashcache.write()
1219
# reverse order of locking.
1220
result = self._control_files.unlock()
1222
self.branch.unlock()
1228
"""Update a working tree along its branch.
1230
This will update the branch if its bound too, which means we have multiple trees involved:
1231
The new basis tree of the master.
1232
The old basis tree of the branch.
1233
The old basis tree of the working tree.
1234
The current working tree state.
1235
pathologically all three may be different, and non ancestors of each other.
1236
Conceptually we want to:
1237
Preserve the wt.basis->wt.state changes
1238
Transform the wt.basis to the new master basis.
1239
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1240
Restore the wt.basis->wt.state changes.
1242
There isn't a single operation at the moment to do that, so we:
1243
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1244
Do a 'normal' merge of the old branch basis if it is relevant.
1246
old_tip = self.branch.update()
1247
if old_tip is not None:
1248
self.add_pending_merge(old_tip)
1249
self.branch.lock_read()
1252
if self.last_revision() != self.branch.last_revision():
1253
# merge tree state up to new branch tip.
1254
basis = self.basis_tree()
1255
to_tree = self.branch.basis_tree()
1256
result += merge_inner(self.branch,
1260
self.set_last_revision(self.branch.last_revision())
1261
if old_tip and old_tip != self.last_revision():
1262
# our last revision was not the prior branch last reivison
1263
# and we have converted that last revision to a pending merge.
1264
# base is somewhere between the branch tip now
1265
# and the now pending merge
1266
from bzrlib.revision import common_ancestor
1268
base_rev_id = common_ancestor(self.branch.last_revision(),
1270
self.branch.repository)
1271
except errors.NoCommonAncestor:
1273
base_tree = self.branch.repository.revision_tree(base_rev_id)
1274
other_tree = self.branch.repository.revision_tree(old_tip)
1275
result += merge_inner(self.branch,
1281
self.branch.unlock()
1284
def _write_inventory(self, inv):
1285
"""Write inventory as the current inventory."""
1287
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1289
self._control_files.put('inventory', sio)
1290
self._set_inventory(inv)
1291
mutter('wrote working inventory')
1294
class WorkingTree3(WorkingTree):
1295
"""This is the Format 3 working tree.
1297
This differs from the base WorkingTree by:
1298
- having its own file lock
1299
- having its own last-revision property.
1303
def last_revision(self):
1304
"""See WorkingTree.last_revision."""
1306
return self._control_files.get_utf8('last-revision').read()
1310
def _change_last_revision(self, revision_id):
1311
"""See WorkingTree._change_last_revision."""
1312
if revision_id is None or revision_id == NULL_REVISION:
1314
self._control_files._transport.delete('last-revision')
1315
except errors.NoSuchFile:
1320
self.branch.revision_history().index(revision_id)
1322
raise errors.NoSuchRevision(self.branch, revision_id)
1323
self._control_files.put_utf8('last-revision', revision_id)
1327
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1328
def get_conflicted_stem(path):
1329
for suffix in CONFLICT_SUFFIXES:
1330
if path.endswith(suffix):
1331
return path[:-len(suffix)]
1333
@deprecated_function(zero_eight)
1334
def is_control_file(filename):
1335
"""See WorkingTree.is_control_filename(filename)."""
1336
## FIXME: better check
1337
filename = normpath(filename)
1338
while filename != '':
1339
head, tail = os.path.split(filename)
1340
## mutter('check %r for control file' % ((head, tail),))
1343
if filename == head:
1349
class WorkingTreeFormat(object):
1350
"""An encapsulation of the initialization and open routines for a format.
1352
Formats provide three things:
1353
* An initialization routine,
1357
Formats are placed in an dict by their format string for reference
1358
during workingtree opening. Its not required that these be instances, they
1359
can be classes themselves with class methods - it simply depends on
1360
whether state is needed for a given format or not.
1362
Once a format is deprecated, just deprecate the initialize and open
1363
methods on the format class. Do not deprecate the object, as the
1364
object will be created every time regardless.
1367
_default_format = None
1368
"""The default format used for new trees."""
1371
"""The known formats."""
1374
def find_format(klass, a_bzrdir):
1375
"""Return the format for the working tree object in a_bzrdir."""
1377
transport = a_bzrdir.get_workingtree_transport(None)
1378
format_string = transport.get("format").read()
1379
return klass._formats[format_string]
1381
raise errors.NoWorkingTree(base=transport.base)
1383
raise errors.UnknownFormatError(format_string)
1386
def get_default_format(klass):
1387
"""Return the current default format."""
1388
return klass._default_format
1390
def get_format_string(self):
1391
"""Return the ASCII format string that identifies this format."""
1392
raise NotImplementedError(self.get_format_string)
1394
def is_supported(self):
1395
"""Is this format supported?
1397
Supported formats can be initialized and opened.
1398
Unsupported formats may not support initialization or committing or
1399
some other features depending on the reason for not being supported.
1404
def register_format(klass, format):
1405
klass._formats[format.get_format_string()] = format
1408
def set_default_format(klass, format):
1409
klass._default_format = format
1412
def unregister_format(klass, format):
1413
assert klass._formats[format.get_format_string()] is format
1414
del klass._formats[format.get_format_string()]
1418
class WorkingTreeFormat2(WorkingTreeFormat):
1419
"""The second working tree format.
1421
This format modified the hash cache from the format 1 hash cache.
1424
def initialize(self, a_bzrdir, revision_id=None):
1425
"""See WorkingTreeFormat.initialize()."""
1426
if not isinstance(a_bzrdir.transport, LocalTransport):
1427
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1428
branch = a_bzrdir.open_branch()
1429
if revision_id is not None:
1432
revision_history = branch.revision_history()
1434
position = revision_history.index(revision_id)
1436
raise errors.NoSuchRevision(branch, revision_id)
1437
branch.set_revision_history(revision_history[:position + 1])
1440
revision = branch.last_revision()
1442
wt = WorkingTree(a_bzrdir.root_transport.base,
1448
wt._write_inventory(inv)
1449
wt.set_root_id(inv.root.file_id)
1450
wt.set_last_revision(revision)
1451
wt.set_pending_merges([])
1452
build_tree(wt.basis_tree(), wt)
1456
super(WorkingTreeFormat2, self).__init__()
1457
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1459
def open(self, a_bzrdir, _found=False):
1460
"""Return the WorkingTree object for a_bzrdir
1462
_found is a private parameter, do not use it. It is used to indicate
1463
if format probing has already been done.
1466
# we are being called directly and must probe.
1467
raise NotImplementedError
1468
if not isinstance(a_bzrdir.transport, LocalTransport):
1469
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1470
return WorkingTree(a_bzrdir.root_transport.base,
1476
class WorkingTreeFormat3(WorkingTreeFormat):
1477
"""The second working tree format updated to record a format marker.
1479
This format modified the hash cache from the format 1 hash cache.
1482
def get_format_string(self):
1483
"""See WorkingTreeFormat.get_format_string()."""
1484
return "Bazaar-NG Working Tree format 3"
1486
def initialize(self, a_bzrdir, revision_id=None):
1487
"""See WorkingTreeFormat.initialize().
1489
revision_id allows creating a working tree at a differnet
1490
revision than the branch is at.
1492
if not isinstance(a_bzrdir.transport, LocalTransport):
1493
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1494
transport = a_bzrdir.get_workingtree_transport(self)
1495
control_files = LockableFiles(transport, 'lock', TransportLock)
1496
control_files.put_utf8('format', self.get_format_string())
1497
branch = a_bzrdir.open_branch()
1498
if revision_id is None:
1499
revision_id = branch.last_revision()
1501
wt = WorkingTree3(a_bzrdir.root_transport.base,
1507
wt._write_inventory(inv)
1508
wt.set_root_id(inv.root.file_id)
1509
wt.set_last_revision(revision_id)
1510
wt.set_pending_merges([])
1511
build_tree(wt.basis_tree(), wt)
1515
super(WorkingTreeFormat3, self).__init__()
1516
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1518
def open(self, a_bzrdir, _found=False):
1519
"""Return the WorkingTree object for a_bzrdir
1521
_found is a private parameter, do not use it. It is used to indicate
1522
if format probing has already been done.
1525
# we are being called directly and must probe.
1526
raise NotImplementedError
1527
if not isinstance(a_bzrdir.transport, LocalTransport):
1528
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1529
return WorkingTree3(a_bzrdir.root_transport.base,
1535
return self.get_format_string()
1538
# formats which have no format string are not discoverable
1539
# and not independently creatable, so are not registered.
1540
__default_format = WorkingTreeFormat3()
1541
WorkingTreeFormat.register_format(__default_format)
1542
WorkingTreeFormat.set_default_format(__default_format)
1543
_legacy_formats = [WorkingTreeFormat2(),
1547
class WorkingTreeTestProviderAdapter(object):
1548
"""A tool to generate a suite testing multiple workingtree formats at once.
1550
This is done by copying the test once for each transport and injecting
1551
the transport_server, transport_readonly_server, and workingtree_format
1552
classes into each copy. Each copy is also given a new id() to make it
1556
def __init__(self, transport_server, transport_readonly_server, formats):
1557
self._transport_server = transport_server
1558
self._transport_readonly_server = transport_readonly_server
1559
self._formats = formats
1561
def adapt(self, test):
1562
from bzrlib.tests import TestSuite
1563
result = TestSuite()
1564
for workingtree_format, bzrdir_format in self._formats:
1565
new_test = deepcopy(test)
1566
new_test.transport_server = self._transport_server
1567
new_test.transport_readonly_server = self._transport_readonly_server
1568
new_test.bzrdir_format = bzrdir_format
1569
new_test.workingtree_format = workingtree_format
1570
def make_new_test_id():
1571
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1572
return lambda: new_id
1573
new_test.id = make_new_test_id()
1574
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
