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 binascii import hexlify
43
from copy import deepcopy
44
from cStringIO import StringIO
52
from bzrlib.atomicfile import AtomicFile
53
from bzrlib.branch import (Branch,
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
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,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
72
from bzrlib.lockdir import LockDir
73
from bzrlib.merge import merge_inner, transform_tree
74
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
106
# the regex here does the following:
107
# 1) remove any wierd characters; we don't escape them but rather
109
# 2) match leading '.'s to make it not hidden
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
111
_gen_id_suffix = None
115
def _next_id_suffix():
116
"""Create a new file id suffix that is reasonably unique.
118
On the first call we combine the current time with 64 bits of randomness
119
to give a highly probably globally unique number. Then each call in the same
120
process adds 1 to a serial number we append to that unique value.
122
global _gen_id_suffix, _gen_id_serial
123
if _gen_id_suffix is None:
124
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), hexlify(rand_bytes(8)))
126
return _gen_id_suffix + str(_gen_id_serial)
129
def gen_file_id(name):
130
"""Return new file id for the basename 'name'.
132
This should probably generate proper UUIDs, but for the moment we
133
cope with just randomness because running uuidgen every time is
136
The uniqueness is supplied from _next_id_suffix.
138
return _gen_file_id_re.sub('', name) + _next_id_suffix()
142
"""Return a new tree-root file id."""
143
return gen_file_id('TREE_ROOT')
146
class TreeEntry(object):
147
"""An entry that implements the minium interface used by commands.
149
This needs further inspection, it may be better to have
150
InventoryEntries without ids - though that seems wrong. For now,
151
this is a parallel hierarchy to InventoryEntry, and needs to become
152
one of several things: decorates to that hierarchy, children of, or
154
Another note is that these objects are currently only used when there is
155
no InventoryEntry available - i.e. for unversioned objects.
156
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
159
def __eq__(self, other):
160
# yes, this us ugly, TODO: best practice __eq__ style.
161
return (isinstance(other, TreeEntry)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeDirectory(TreeEntry):
169
"""See TreeEntry. This is a directory in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeDirectory)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class TreeFile(TreeEntry):
180
"""See TreeEntry. This is a regular file in a working tree."""
182
def __eq__(self, other):
183
return (isinstance(other, TreeFile)
184
and other.__class__ == self.__class__)
186
def kind_character(self):
190
class TreeLink(TreeEntry):
191
"""See TreeEntry. This is a symlink in a working tree."""
193
def __eq__(self, other):
194
return (isinstance(other, TreeLink)
195
and other.__class__ == self.__class__)
197
def kind_character(self):
201
class WorkingTree(bzrlib.tree.Tree):
202
"""Working copy tree.
204
The inventory is held in the `Branch` working-inventory, and the
205
files are in a directory on disk.
207
It is possible for a `WorkingTree` to have a filename which is
208
not listed in the Inventory and vice versa.
211
def __init__(self, basedir='.',
212
branch=DEPRECATED_PARAMETER,
218
"""Construct a WorkingTree for basedir.
220
If the branch is not supplied, it is opened automatically.
221
If the branch is supplied, it must be the branch for this basedir.
222
(branch.base is not cross checked, because for remote branches that
223
would be meaningless).
225
self._format = _format
226
self.bzrdir = _bzrdir
228
# not created via open etc.
229
warn("WorkingTree() is deprecated as of bzr version 0.8. "
230
"Please use bzrdir.open_workingtree or WorkingTree.open().",
233
wt = WorkingTree.open(basedir)
234
self._branch = wt.branch
235
self.basedir = wt.basedir
236
self._control_files = wt._control_files
237
self._hashcache = wt._hashcache
238
self._set_inventory(wt._inventory)
239
self._format = wt._format
240
self.bzrdir = wt.bzrdir
241
from bzrlib.hashcache import HashCache
242
from bzrlib.trace import note, mutter
243
assert isinstance(basedir, basestring), \
244
"base directory %r is not a string" % basedir
245
basedir = safe_unicode(basedir)
246
mutter("opening working tree %r", basedir)
247
if deprecated_passed(branch):
249
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
250
" Please use bzrdir.open_workingtree() or"
251
" WorkingTree.open().",
255
self._branch = branch
257
self._branch = self.bzrdir.open_branch()
258
assert isinstance(self.branch, Branch), \
259
"branch %r is not a Branch" % self.branch
260
self.basedir = realpath(basedir)
261
# if branch is at our basedir and is a format 6 or less
262
if isinstance(self._format, WorkingTreeFormat2):
263
# share control object
264
self._control_files = self.branch.control_files
266
# only ready for format 3
267
assert isinstance(self._format, WorkingTreeFormat3)
268
assert isinstance(_control_files, LockableFiles), \
269
"_control_files must be a LockableFiles, not %r" \
271
self._control_files = _control_files
272
# update the whole cache up front and write to disk if anything changed;
273
# in the future we might want to do this more selectively
274
# two possible ways offer themselves : in self._unlock, write the cache
275
# if needed, or, when the cache sees a change, append it to the hash
276
# cache file, and have the parser take the most recent entry for a
278
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
279
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
281
# is this scan needed ? it makes things kinda slow.
288
if _inventory is None:
289
self._set_inventory(self.read_working_inventory())
291
self._set_inventory(_inventory)
294
fget=lambda self: self._branch,
295
doc="""The branch this WorkingTree is connected to.
297
This cannot be set - it is reflective of the actual disk structure
298
the working tree has been constructed from.
301
def break_lock(self):
302
"""Break a lock if one is present from another instance.
304
Uses the ui factory to ask for confirmation if the lock may be from
307
This will probe the repository for its lock as well.
309
self._control_files.break_lock()
310
self.branch.break_lock()
312
def _set_inventory(self, inv):
313
self._inventory = inv
314
self.path2id = self._inventory.path2id
316
def is_control_filename(self, filename):
317
"""True if filename is the name of a control file in this tree.
319
This is true IF and ONLY IF the filename is part of the meta data
320
that bzr controls in this tree. I.E. a random .bzr directory placed
321
on disk will not be a control file for this tree.
324
self.bzrdir.transport.relpath(self.abspath(filename))
326
except errors.PathNotChild:
330
def open(path=None, _unsupported=False):
331
"""Open an existing working tree at path.
335
path = os.path.getcwdu()
336
control = bzrdir.BzrDir.open(path, _unsupported)
337
return control.open_workingtree(_unsupported)
340
def open_containing(path=None):
341
"""Open an existing working tree which has its root about path.
343
This probes for a working tree at path and searches upwards from there.
345
Basically we keep looking up until we find the control directory or
346
run into /. If there isn't one, raises NotBranchError.
347
TODO: give this a new exception.
348
If there is one, it is returned, along with the unused portion of path.
352
control, relpath = bzrdir.BzrDir.open_containing(path)
353
return control.open_workingtree(), relpath
356
def open_downlevel(path=None):
357
"""Open an unsupported working tree.
359
Only intended for advanced situations like upgrading part of a bzrdir.
361
return WorkingTree.open(path, _unsupported=True)
364
"""Iterate through file_ids for this tree.
366
file_ids are in a WorkingTree if they are in the working inventory
367
and the working file exists.
369
inv = self._inventory
370
for path, ie in inv.iter_entries():
371
if bzrlib.osutils.lexists(self.abspath(path)):
375
return "<%s of %s>" % (self.__class__.__name__,
376
getattr(self, 'basedir', None))
378
def abspath(self, filename):
379
return pathjoin(self.basedir, filename)
381
def basis_tree(self):
382
"""Return RevisionTree for the current last revision."""
383
revision_id = self.last_revision()
384
if revision_id is not None:
386
xml = self.read_basis_inventory()
387
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
390
if inv is not None and inv.revision_id == revision_id:
391
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
393
# FIXME? RBC 20060403 should we cache the inventory here ?
394
return self.branch.repository.revision_tree(revision_id)
397
@deprecated_method(zero_eight)
398
def create(branch, directory):
399
"""Create a workingtree for branch at directory.
401
If existing_directory already exists it must have a .bzr directory.
402
If it does not exist, it will be created.
404
This returns a new WorkingTree object for the new checkout.
406
TODO FIXME RBC 20060124 when we have checkout formats in place this
407
should accept an optional revisionid to checkout [and reject this if
408
checking out into the same dir as a pre-checkout-aware branch format.]
410
XXX: When BzrDir is present, these should be created through that
413
warn('delete WorkingTree.create', stacklevel=3)
414
transport = get_transport(directory)
415
if branch.bzrdir.root_transport.base == transport.base:
417
return branch.bzrdir.create_workingtree()
418
# different directory,
419
# create a branch reference
420
# and now a working tree.
421
raise NotImplementedError
424
@deprecated_method(zero_eight)
425
def create_standalone(directory):
426
"""Create a checkout and a branch and a repo at directory.
428
Directory must exist and be empty.
430
please use BzrDir.create_standalone_workingtree
432
return bzrdir.BzrDir.create_standalone_workingtree(directory)
434
def relpath(self, abs):
435
"""Return the local path portion from a given absolute path."""
436
return relpath(self.basedir, abs)
438
def has_filename(self, filename):
439
return bzrlib.osutils.lexists(self.abspath(filename))
441
def get_file(self, file_id):
442
return self.get_file_byname(self.id2path(file_id))
444
def get_file_byname(self, filename):
445
return file(self.abspath(filename), 'rb')
447
def get_root_id(self):
448
"""Return the id of this trees root"""
449
inv = self.read_working_inventory()
450
return inv.root.file_id
452
def _get_store_filename(self, file_id):
453
## XXX: badly named; this is not in the store at all
454
return self.abspath(self.id2path(file_id))
457
def clone(self, to_bzrdir, revision_id=None, basis=None):
458
"""Duplicate this working tree into to_bzr, including all state.
460
Specifically modified files are kept as modified, but
461
ignored and unknown files are discarded.
463
If you want to make a new line of development, see bzrdir.sprout()
466
If not None, the cloned tree will have its last revision set to
467
revision, and and difference between the source trees last revision
468
and this one merged in.
471
If not None, a closer copy of a tree which may have some files in
472
common, and which file content should be preferentially copied from.
474
# assumes the target bzr dir format is compatible.
475
result = self._format.initialize(to_bzrdir)
476
self.copy_content_into(result, revision_id)
480
def copy_content_into(self, tree, revision_id=None):
481
"""Copy the current content and user files of this tree into tree."""
482
if revision_id is None:
483
transform_tree(tree, self)
485
# TODO now merge from tree.last_revision to revision
486
transform_tree(tree, self)
487
tree.set_last_revision(revision_id)
490
def commit(self, message=None, revprops=None, *args, **kwargs):
491
# avoid circular imports
492
from bzrlib.commit import Commit
495
if not 'branch-nick' in revprops:
496
revprops['branch-nick'] = self.branch.nick
497
# args for wt.commit start at message from the Commit.commit method,
498
# but with branch a kwarg now, passing in args as is results in the
499
#message being used for the branch
500
args = (DEPRECATED_PARAMETER, message, ) + args
501
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
502
self._set_inventory(self.read_working_inventory())
504
def id2abspath(self, file_id):
505
return self.abspath(self.id2path(file_id))
507
def has_id(self, file_id):
508
# files that have been deleted are excluded
509
inv = self._inventory
510
if not inv.has_id(file_id):
512
path = inv.id2path(file_id)
513
return bzrlib.osutils.lexists(self.abspath(path))
515
def has_or_had_id(self, file_id):
516
if file_id == self.inventory.root.file_id:
518
return self.inventory.has_id(file_id)
520
__contains__ = has_id
522
def get_file_size(self, file_id):
523
return os.path.getsize(self.id2abspath(file_id))
526
def get_file_sha1(self, file_id):
527
path = self._inventory.id2path(file_id)
528
return self._hashcache.get_sha1(path)
530
def is_executable(self, file_id):
531
if not supports_executable():
532
return self._inventory[file_id].executable
534
path = self._inventory.id2path(file_id)
535
mode = os.lstat(self.abspath(path)).st_mode
536
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
539
def add(self, files, ids=None):
540
"""Make files versioned.
542
Note that the command line normally calls smart_add instead,
543
which can automatically recurse.
545
This adds the files to the inventory, so that they will be
546
recorded by the next commit.
549
List of paths to add, relative to the base of the tree.
552
If set, use these instead of automatically generated ids.
553
Must be the same length as the list of files, but may
554
contain None for ids that are to be autogenerated.
556
TODO: Perhaps have an option to add the ids even if the files do
559
TODO: Perhaps callback with the ids and paths as they're added.
561
# TODO: Re-adding a file that is removed in the working copy
562
# should probably put it back with the previous ID.
563
if isinstance(files, basestring):
564
assert(ids is None or isinstance(ids, basestring))
570
ids = [None] * len(files)
572
assert(len(ids) == len(files))
574
inv = self.read_working_inventory()
575
for f,file_id in zip(files, ids):
576
if self.is_control_filename(f):
577
raise BzrError("cannot add control file %s" % quotefn(f))
582
raise BzrError("cannot add top-level %r" % f)
584
fullpath = normpath(self.abspath(f))
587
kind = file_kind(fullpath)
589
if e.errno == errno.ENOENT:
590
raise NoSuchFile(fullpath)
591
# maybe something better?
592
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
594
if not InventoryEntry.versionable_kind(kind):
595
raise BzrError('cannot add: not a versionable file ('
596
'i.e. regular file, symlink or directory): %s' % quotefn(f))
599
inv.add_path(f, kind=kind)
601
inv.add_path(f, kind=kind, file_id=file_id)
603
self._write_inventory(inv)
606
def add_pending_merge(self, *revision_ids):
607
# TODO: Perhaps should check at this point that the
608
# history of the revision is actually present?
609
p = self.pending_merges()
611
for rev_id in revision_ids:
617
self.set_pending_merges(p)
620
def pending_merges(self):
621
"""Return a list of pending merges.
623
These are revisions that have been merged into the working
624
directory but not yet committed.
627
merges_file = self._control_files.get_utf8('pending-merges')
629
if e.errno != errno.ENOENT:
633
for l in merges_file.readlines():
634
p.append(l.rstrip('\n'))
638
def set_pending_merges(self, rev_list):
639
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
642
def set_merge_modified(self, modified_hashes):
644
for file_id, hash in modified_hashes.iteritems():
645
yield Stanza(file_id=file_id, hash=hash)
646
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
649
def _put_rio(self, filename, stanzas, header):
650
my_file = rio_file(stanzas, header)
651
self._control_files.put(filename, my_file)
654
def merge_modified(self):
656
hashfile = self._control_files.get('merge-hashes')
661
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
662
raise MergeModifiedFormatError()
663
except StopIteration:
664
raise MergeModifiedFormatError()
665
for s in RioReader(hashfile):
666
file_id = s.get("file_id")
667
if file_id not in self.inventory:
670
if hash == self.get_file_sha1(file_id):
671
merge_hashes[file_id] = hash
674
def get_symlink_target(self, file_id):
675
return os.readlink(self.id2abspath(file_id))
677
def file_class(self, filename):
678
if self.path2id(filename):
680
elif self.is_ignored(filename):
685
def list_files(self):
686
"""Recursively list all files as (path, class, kind, id).
688
Lists, but does not descend into unversioned directories.
690
This does not include files that have been deleted in this
693
Skips the control directory.
695
inv = self._inventory
697
def descend(from_dir_relpath, from_dir_id, dp):
701
## TODO: If we find a subdirectory with its own .bzr
702
## directory, then that is a separate tree and we
703
## should exclude it.
705
# the bzrdir for this tree
706
if self.bzrdir.transport.base.endswith(f + '/'):
710
fp = appendpath(from_dir_relpath, f)
713
fap = appendpath(dp, f)
715
f_ie = inv.get_child(from_dir_id, f)
718
elif self.is_ignored(fp):
727
raise BzrCheckError("file %r entered as kind %r id %r, "
729
% (fap, f_ie.kind, f_ie.file_id, fk))
731
# make a last minute entry
735
if fk == 'directory':
736
entry = TreeDirectory()
739
elif fk == 'symlink':
744
yield fp, c, fk, (f_ie and f_ie.file_id), entry
746
if fk != 'directory':
750
# don't descend unversioned directories
753
for ff in descend(fp, f_ie.file_id, fap):
756
for f in descend(u'', inv.root.file_id, self.basedir):
760
def move(self, from_paths, to_name):
763
to_name must exist in the inventory.
765
If to_name exists and is a directory, the files are moved into
766
it, keeping their old names.
768
Note that to_name is only the last component of the new name;
769
this doesn't change the directory.
771
This returns a list of (from_path, to_path) pairs for each
775
## TODO: Option to move IDs only
776
assert not isinstance(from_paths, basestring)
778
to_abs = self.abspath(to_name)
779
if not isdir(to_abs):
780
raise BzrError("destination %r is not a directory" % to_abs)
781
if not self.has_filename(to_name):
782
raise BzrError("destination %r not in working directory" % to_abs)
783
to_dir_id = inv.path2id(to_name)
784
if to_dir_id == None and to_name != '':
785
raise BzrError("destination %r is not a versioned directory" % to_name)
786
to_dir_ie = inv[to_dir_id]
787
if to_dir_ie.kind not in ('directory', 'root_directory'):
788
raise BzrError("destination %r is not a directory" % to_abs)
790
to_idpath = inv.get_idpath(to_dir_id)
793
if not self.has_filename(f):
794
raise BzrError("%r does not exist in working tree" % f)
795
f_id = inv.path2id(f)
797
raise BzrError("%r is not versioned" % f)
798
name_tail = splitpath(f)[-1]
799
dest_path = appendpath(to_name, name_tail)
800
if self.has_filename(dest_path):
801
raise BzrError("destination %r already exists" % dest_path)
802
if f_id in to_idpath:
803
raise BzrError("can't move %r to a subdirectory of itself" % f)
805
# OK, so there's a race here, it's possible that someone will
806
# create a file in this interval and then the rename might be
807
# left half-done. But we should have caught most problems.
808
orig_inv = deepcopy(self.inventory)
811
name_tail = splitpath(f)[-1]
812
dest_path = appendpath(to_name, name_tail)
813
result.append((f, dest_path))
814
inv.rename(inv.path2id(f), to_dir_id, name_tail)
816
rename(self.abspath(f), self.abspath(dest_path))
818
raise BzrError("failed to rename %r to %r: %s" %
819
(f, dest_path, e[1]),
820
["rename rolled back"])
822
# restore the inventory on error
823
self._set_inventory(orig_inv)
825
self._write_inventory(inv)
829
def rename_one(self, from_rel, to_rel):
832
This can change the directory or the filename or both.
835
if not self.has_filename(from_rel):
836
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
837
if self.has_filename(to_rel):
838
raise BzrError("can't rename: new working file %r already exists" % to_rel)
840
file_id = inv.path2id(from_rel)
842
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
845
from_parent = entry.parent_id
846
from_name = entry.name
848
if inv.path2id(to_rel):
849
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
851
to_dir, to_tail = os.path.split(to_rel)
852
to_dir_id = inv.path2id(to_dir)
853
if to_dir_id == None and to_dir != '':
854
raise BzrError("can't determine destination directory id for %r" % to_dir)
856
mutter("rename_one:")
857
mutter(" file_id {%s}" % file_id)
858
mutter(" from_rel %r" % from_rel)
859
mutter(" to_rel %r" % to_rel)
860
mutter(" to_dir %r" % to_dir)
861
mutter(" to_dir_id {%s}" % to_dir_id)
863
inv.rename(file_id, to_dir_id, to_tail)
865
from_abs = self.abspath(from_rel)
866
to_abs = self.abspath(to_rel)
868
rename(from_abs, to_abs)
870
inv.rename(file_id, from_parent, from_name)
871
raise BzrError("failed to rename %r to %r: %s"
872
% (from_abs, to_abs, e[1]),
873
["rename rolled back"])
874
self._write_inventory(inv)
878
"""Return all unknown files.
880
These are files in the working directory that are not versioned or
881
control files or ignored.
883
>>> from bzrlib.bzrdir import ScratchDir
884
>>> d = ScratchDir(files=['foo', 'foo~'])
885
>>> b = d.open_branch()
886
>>> tree = d.open_workingtree()
887
>>> map(str, tree.unknowns())
890
>>> list(b.unknowns())
892
>>> tree.remove('foo')
893
>>> list(b.unknowns())
896
for subp in self.extras():
897
if not self.is_ignored(subp):
900
@deprecated_method(zero_eight)
901
def iter_conflicts(self):
902
"""List all files in the tree that have text or content conflicts.
903
DEPRECATED. Use conflicts instead."""
904
return self._iter_conflicts()
906
def _iter_conflicts(self):
908
for path in (s[0] for s in self.list_files()):
909
stem = get_conflicted_stem(path)
912
if stem not in conflicted:
917
def pull(self, source, overwrite=False, stop_revision=None):
918
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
921
pp = ProgressPhase("Pull phase", 2, top_pb)
923
old_revision_history = self.branch.revision_history()
924
basis_tree = self.basis_tree()
925
count = self.branch.pull(source, overwrite, stop_revision)
926
new_revision_history = self.branch.revision_history()
927
if new_revision_history != old_revision_history:
929
if len(old_revision_history):
930
other_revision = old_revision_history[-1]
932
other_revision = None
933
repository = self.branch.repository
934
pb = bzrlib.ui.ui_factory.nested_progress_bar()
936
merge_inner(self.branch,
937
self.branch.basis_tree(),
943
self.set_last_revision(self.branch.last_revision())
950
"""Yield all unknown files in this WorkingTree.
952
If there are any unknown directories then only the directory is
953
returned, not all its children. But if there are unknown files
954
under a versioned subdirectory, they are returned.
956
Currently returned depth-first, sorted by name within directories.
958
## TODO: Work from given directory downwards
959
for path, dir_entry in self.inventory.directories():
960
mutter("search for unknowns in %r", path)
961
dirabs = self.abspath(path)
962
if not isdir(dirabs):
963
# e.g. directory deleted
967
for subf in os.listdir(dirabs):
969
and (subf not in dir_entry.children)):
974
subp = appendpath(path, subf)
978
def ignored_files(self):
979
"""Yield list of PATH, IGNORE_PATTERN"""
980
for subp in self.extras():
981
pat = self.is_ignored(subp)
986
def get_ignore_list(self):
987
"""Return list of ignore patterns.
989
Cached in the Tree object after the first call.
991
if hasattr(self, '_ignorelist'):
992
return self._ignorelist
994
l = bzrlib.DEFAULT_IGNORE[:]
995
if self.has_filename(bzrlib.IGNORE_FILENAME):
996
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
997
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1002
def is_ignored(self, filename):
1003
r"""Check whether the filename matches an ignore pattern.
1005
Patterns containing '/' or '\' need to match the whole path;
1006
others match against only the last component.
1008
If the file is ignored, returns the pattern which caused it to
1009
be ignored, otherwise None. So this can simply be used as a
1010
boolean if desired."""
1012
# TODO: Use '**' to match directories, and other extended
1013
# globbing stuff from cvs/rsync.
1015
# XXX: fnmatch is actually not quite what we want: it's only
1016
# approximately the same as real Unix fnmatch, and doesn't
1017
# treat dotfiles correctly and allows * to match /.
1018
# Eventually it should be replaced with something more
1021
basename = splitpath(filename)[-1]
1022
for pat in self.get_ignore_list():
1023
if '/' in pat or '\\' in pat:
1025
# as a special case, you can put ./ at the start of a
1026
# pattern; this is good to match in the top-level
1028
if pat[:2] in ('./', '.\\'):
1032
if fnmatch.fnmatchcase(filename, newpat):
1035
if fnmatch.fnmatchcase(basename, pat):
1039
def kind(self, file_id):
1040
return file_kind(self.id2abspath(file_id))
1043
def last_revision(self):
1044
"""Return the last revision id of this working tree.
1046
In early branch formats this was == the branch last_revision,
1047
but that cannot be relied upon - for working tree operations,
1048
always use tree.last_revision().
1050
return self.branch.last_revision()
1052
def is_locked(self):
1053
return self._control_files.is_locked()
1055
def lock_read(self):
1056
"""See Branch.lock_read, and WorkingTree.unlock."""
1057
self.branch.lock_read()
1059
return self._control_files.lock_read()
1061
self.branch.unlock()
1064
def lock_write(self):
1065
"""See Branch.lock_write, and WorkingTree.unlock."""
1066
self.branch.lock_write()
1068
return self._control_files.lock_write()
1070
self.branch.unlock()
1073
def get_physical_lock_status(self):
1074
return self._control_files.get_physical_lock_status()
1076
def _basis_inventory_name(self):
1077
return 'basis-inventory'
1080
def set_last_revision(self, new_revision):
1081
"""Change the last revision in the working tree."""
1082
if self._change_last_revision(new_revision):
1083
self._cache_basis_inventory(new_revision)
1085
def _change_last_revision(self, new_revision):
1086
"""Template method part of set_last_revision to perform the change.
1088
This is used to allow WorkingTree3 instances to not affect branch
1089
when their last revision is set.
1091
if new_revision is None:
1092
self.branch.set_revision_history([])
1094
# current format is locked in with the branch
1095
revision_history = self.branch.revision_history()
1097
position = revision_history.index(new_revision)
1099
raise errors.NoSuchRevision(self.branch, new_revision)
1100
self.branch.set_revision_history(revision_history[:position + 1])
1103
def _cache_basis_inventory(self, new_revision):
1104
"""Cache new_revision as the basis inventory."""
1106
# this double handles the inventory - unpack and repack -
1107
# but is easier to understand. We can/should put a conditional
1108
# in here based on whether the inventory is in the latest format
1109
# - perhaps we should repack all inventories on a repository
1111
inv = self.branch.repository.get_inventory(new_revision)
1112
inv.revision_id = new_revision
1113
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1115
path = self._basis_inventory_name()
1116
self._control_files.put_utf8(path, xml)
1117
except WeaveRevisionNotPresent:
1120
def read_basis_inventory(self):
1121
"""Read the cached basis inventory."""
1122
path = self._basis_inventory_name()
1123
return self._control_files.get_utf8(path).read()
1126
def read_working_inventory(self):
1127
"""Read the working inventory."""
1128
# ElementTree does its own conversion from UTF-8, so open in
1130
result = bzrlib.xml5.serializer_v5.read_inventory(
1131
self._control_files.get('inventory'))
1132
self._set_inventory(result)
1136
def remove(self, files, verbose=False):
1137
"""Remove nominated files from the working inventory..
1139
This does not remove their text. This does not run on XXX on what? RBC
1141
TODO: Refuse to remove modified files unless --force is given?
1143
TODO: Do something useful with directories.
1145
TODO: Should this remove the text or not? Tough call; not
1146
removing may be useful and the user can just use use rm, and
1147
is the opposite of add. Removing it is consistent with most
1148
other tools. Maybe an option.
1150
## TODO: Normalize names
1151
## TODO: Remove nested loops; better scalability
1152
if isinstance(files, basestring):
1155
inv = self.inventory
1157
# do this before any modifications
1159
fid = inv.path2id(f)
1161
# TODO: Perhaps make this just a warning, and continue?
1162
# This tends to happen when
1163
raise NotVersionedError(path=f)
1164
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1166
# having remove it, it must be either ignored or unknown
1167
if self.is_ignored(f):
1171
show_status(new_status, inv[fid].kind, quotefn(f))
1174
self._write_inventory(inv)
1177
def revert(self, filenames, old_tree=None, backups=True,
1178
pb=DummyProgress()):
1179
from transform import revert
1180
from conflicts import resolve
1181
if old_tree is None:
1182
old_tree = self.basis_tree()
1183
conflicts = revert(self, old_tree, filenames, backups, pb)
1184
if not len(filenames):
1185
self.set_pending_merges([])
1188
resolve(self, filenames, ignore_misses=True)
1191
# XXX: This method should be deprecated in favour of taking in a proper
1192
# new Inventory object.
1194
def set_inventory(self, new_inventory_list):
1195
from bzrlib.inventory import (Inventory,
1200
inv = Inventory(self.get_root_id())
1201
for path, file_id, parent, kind in new_inventory_list:
1202
name = os.path.basename(path)
1205
# fixme, there should be a factory function inv,add_??
1206
if kind == 'directory':
1207
inv.add(InventoryDirectory(file_id, name, parent))
1208
elif kind == 'file':
1209
inv.add(InventoryFile(file_id, name, parent))
1210
elif kind == 'symlink':
1211
inv.add(InventoryLink(file_id, name, parent))
1213
raise BzrError("unknown kind %r" % kind)
1214
self._write_inventory(inv)
1217
def set_root_id(self, file_id):
1218
"""Set the root id for this tree."""
1219
inv = self.read_working_inventory()
1220
orig_root_id = inv.root.file_id
1221
del inv._byid[inv.root.file_id]
1222
inv.root.file_id = file_id
1223
inv._byid[inv.root.file_id] = inv.root
1226
if entry.parent_id == orig_root_id:
1227
entry.parent_id = inv.root.file_id
1228
self._write_inventory(inv)
1231
"""See Branch.unlock.
1233
WorkingTree locking just uses the Branch locking facilities.
1234
This is current because all working trees have an embedded branch
1235
within them. IF in the future, we were to make branch data shareable
1236
between multiple working trees, i.e. via shared storage, then we
1237
would probably want to lock both the local tree, and the branch.
1239
# FIXME: We want to write out the hashcache only when the last lock on
1240
# this working copy is released. Peeking at the lock count is a bit
1241
# of a nasty hack; probably it's better to have a transaction object,
1242
# which can do some finalization when it's either successfully or
1243
# unsuccessfully completed. (Denys's original patch did that.)
1244
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1245
# wrongly. Hookinh into unllock on the control files object is fine though.
1247
# TODO: split this per format so there is no ugly if block
1248
if self._hashcache.needs_write and (
1249
# dedicated lock files
1250
self._control_files._lock_count==1 or
1252
(self._control_files is self.branch.control_files and
1253
self._control_files._lock_count==3)):
1254
self._hashcache.write()
1255
# reverse order of locking.
1257
return self._control_files.unlock()
1259
self.branch.unlock()
1263
"""Update a working tree along its branch.
1265
This will update the branch if its bound too, which means we have multiple trees involved:
1266
The new basis tree of the master.
1267
The old basis tree of the branch.
1268
The old basis tree of the working tree.
1269
The current working tree state.
1270
pathologically all three may be different, and non ancestors of each other.
1271
Conceptually we want to:
1272
Preserve the wt.basis->wt.state changes
1273
Transform the wt.basis to the new master basis.
1274
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1275
Restore the wt.basis->wt.state changes.
1277
There isn't a single operation at the moment to do that, so we:
1278
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1279
Do a 'normal' merge of the old branch basis if it is relevant.
1281
old_tip = self.branch.update()
1282
if old_tip is not None:
1283
self.add_pending_merge(old_tip)
1284
self.branch.lock_read()
1287
if self.last_revision() != self.branch.last_revision():
1288
# merge tree state up to new branch tip.
1289
basis = self.basis_tree()
1290
to_tree = self.branch.basis_tree()
1291
result += merge_inner(self.branch,
1295
self.set_last_revision(self.branch.last_revision())
1296
if old_tip and old_tip != self.last_revision():
1297
# our last revision was not the prior branch last reivison
1298
# and we have converted that last revision to a pending merge.
1299
# base is somewhere between the branch tip now
1300
# and the now pending merge
1301
from bzrlib.revision import common_ancestor
1303
base_rev_id = common_ancestor(self.branch.last_revision(),
1305
self.branch.repository)
1306
except errors.NoCommonAncestor:
1308
base_tree = self.branch.repository.revision_tree(base_rev_id)
1309
other_tree = self.branch.repository.revision_tree(old_tip)
1310
result += merge_inner(self.branch,
1316
self.branch.unlock()
1319
def _write_inventory(self, inv):
1320
"""Write inventory as the current inventory."""
1322
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1324
self._control_files.put('inventory', sio)
1325
self._set_inventory(inv)
1326
mutter('wrote working inventory')
1328
def set_conflicts(self, arg):
1329
raise UnsupportedOperation(self.set_conflicts, self)
1332
def conflicts(self):
1333
conflicts = ConflictList()
1334
for conflicted in self._iter_conflicts():
1337
if file_kind(self.abspath(conflicted)) != "file":
1340
if e.errno == errno.ENOENT:
1345
for suffix in ('.THIS', '.OTHER'):
1347
kind = file_kind(self.abspath(conflicted+suffix))
1349
if e.errno == errno.ENOENT:
1357
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1358
conflicts.append(Conflict.factory(ctype, path=conflicted,
1359
file_id=self.path2id(conflicted)))
1363
class WorkingTree3(WorkingTree):
1364
"""This is the Format 3 working tree.
1366
This differs from the base WorkingTree by:
1367
- having its own file lock
1368
- having its own last-revision property.
1370
This is new in bzr 0.8
1374
def last_revision(self):
1375
"""See WorkingTree.last_revision."""
1377
return self._control_files.get_utf8('last-revision').read()
1381
def _change_last_revision(self, revision_id):
1382
"""See WorkingTree._change_last_revision."""
1383
if revision_id is None or revision_id == NULL_REVISION:
1385
self._control_files._transport.delete('last-revision')
1386
except errors.NoSuchFile:
1391
self.branch.revision_history().index(revision_id)
1393
raise errors.NoSuchRevision(self.branch, revision_id)
1394
self._control_files.put_utf8('last-revision', revision_id)
1398
def set_conflicts(self, conflicts):
1399
self._put_rio('conflicts', conflicts.to_stanzas(),
1403
def conflicts(self):
1405
confile = self._control_files.get('conflicts')
1407
return ConflictList()
1409
if confile.next() != CONFLICT_HEADER_1 + '\n':
1410
raise ConflictFormatError()
1411
except StopIteration:
1412
raise ConflictFormatError()
1413
return ConflictList.from_stanzas(RioReader(confile))
1416
def get_conflicted_stem(path):
1417
for suffix in CONFLICT_SUFFIXES:
1418
if path.endswith(suffix):
1419
return path[:-len(suffix)]
1421
@deprecated_function(zero_eight)
1422
def is_control_file(filename):
1423
"""See WorkingTree.is_control_filename(filename)."""
1424
## FIXME: better check
1425
filename = normpath(filename)
1426
while filename != '':
1427
head, tail = os.path.split(filename)
1428
## mutter('check %r for control file' % ((head, tail),))
1431
if filename == head:
1437
class WorkingTreeFormat(object):
1438
"""An encapsulation of the initialization and open routines for a format.
1440
Formats provide three things:
1441
* An initialization routine,
1445
Formats are placed in an dict by their format string for reference
1446
during workingtree opening. Its not required that these be instances, they
1447
can be classes themselves with class methods - it simply depends on
1448
whether state is needed for a given format or not.
1450
Once a format is deprecated, just deprecate the initialize and open
1451
methods on the format class. Do not deprecate the object, as the
1452
object will be created every time regardless.
1455
_default_format = None
1456
"""The default format used for new trees."""
1459
"""The known formats."""
1462
def find_format(klass, a_bzrdir):
1463
"""Return the format for the working tree object in a_bzrdir."""
1465
transport = a_bzrdir.get_workingtree_transport(None)
1466
format_string = transport.get("format").read()
1467
return klass._formats[format_string]
1469
raise errors.NoWorkingTree(base=transport.base)
1471
raise errors.UnknownFormatError(format_string)
1474
def get_default_format(klass):
1475
"""Return the current default format."""
1476
return klass._default_format
1478
def get_format_string(self):
1479
"""Return the ASCII format string that identifies this format."""
1480
raise NotImplementedError(self.get_format_string)
1482
def get_format_description(self):
1483
"""Return the short description for this format."""
1484
raise NotImplementedError(self.get_format_description)
1486
def is_supported(self):
1487
"""Is this format supported?
1489
Supported formats can be initialized and opened.
1490
Unsupported formats may not support initialization or committing or
1491
some other features depending on the reason for not being supported.
1496
def register_format(klass, format):
1497
klass._formats[format.get_format_string()] = format
1500
def set_default_format(klass, format):
1501
klass._default_format = format
1504
def unregister_format(klass, format):
1505
assert klass._formats[format.get_format_string()] is format
1506
del klass._formats[format.get_format_string()]
1510
class WorkingTreeFormat2(WorkingTreeFormat):
1511
"""The second working tree format.
1513
This format modified the hash cache from the format 1 hash cache.
1516
def get_format_description(self):
1517
"""See WorkingTreeFormat.get_format_description()."""
1518
return "Working tree format 2"
1520
def stub_initialize_remote(self, control_files):
1521
"""As a special workaround create critical control files for a remote working tree
1523
This ensures that it can later be updated and dealt with locally,
1524
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1525
no working tree. (See bug #43064).
1529
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1531
control_files.put('inventory', sio)
1533
control_files.put_utf8('pending-merges', '')
1536
def initialize(self, a_bzrdir, revision_id=None):
1537
"""See WorkingTreeFormat.initialize()."""
1538
if not isinstance(a_bzrdir.transport, LocalTransport):
1539
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1540
branch = a_bzrdir.open_branch()
1541
if revision_id is not None:
1544
revision_history = branch.revision_history()
1546
position = revision_history.index(revision_id)
1548
raise errors.NoSuchRevision(branch, revision_id)
1549
branch.set_revision_history(revision_history[:position + 1])
1552
revision = branch.last_revision()
1554
wt = WorkingTree(a_bzrdir.root_transport.base,
1560
wt._write_inventory(inv)
1561
wt.set_root_id(inv.root.file_id)
1562
wt.set_last_revision(revision)
1563
wt.set_pending_merges([])
1564
build_tree(wt.basis_tree(), wt)
1568
super(WorkingTreeFormat2, self).__init__()
1569
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1571
def open(self, a_bzrdir, _found=False):
1572
"""Return the WorkingTree object for a_bzrdir
1574
_found is a private parameter, do not use it. It is used to indicate
1575
if format probing has already been done.
1578
# we are being called directly and must probe.
1579
raise NotImplementedError
1580
if not isinstance(a_bzrdir.transport, LocalTransport):
1581
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1582
return WorkingTree(a_bzrdir.root_transport.base,
1588
class WorkingTreeFormat3(WorkingTreeFormat):
1589
"""The second working tree format updated to record a format marker.
1592
- exists within a metadir controlling .bzr
1593
- includes an explicit version marker for the workingtree control
1594
files, separate from the BzrDir format
1595
- modifies the hash cache format
1597
- uses a LockDir to guard access to the repository
1600
def get_format_string(self):
1601
"""See WorkingTreeFormat.get_format_string()."""
1602
return "Bazaar-NG Working Tree format 3"
1604
def get_format_description(self):
1605
"""See WorkingTreeFormat.get_format_description()."""
1606
return "Working tree format 3"
1608
_lock_file_name = 'lock'
1609
_lock_class = LockDir
1611
def _open_control_files(self, a_bzrdir):
1612
transport = a_bzrdir.get_workingtree_transport(None)
1613
return LockableFiles(transport, self._lock_file_name,
1616
def initialize(self, a_bzrdir, revision_id=None):
1617
"""See WorkingTreeFormat.initialize().
1619
revision_id allows creating a working tree at a differnet
1620
revision than the branch is at.
1622
if not isinstance(a_bzrdir.transport, LocalTransport):
1623
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1624
transport = a_bzrdir.get_workingtree_transport(self)
1625
control_files = self._open_control_files(a_bzrdir)
1626
control_files.create_lock()
1627
control_files.lock_write()
1628
control_files.put_utf8('format', self.get_format_string())
1629
branch = a_bzrdir.open_branch()
1630
if revision_id is None:
1631
revision_id = branch.last_revision()
1633
wt = WorkingTree3(a_bzrdir.root_transport.base,
1639
_control_files=control_files)
1642
wt._write_inventory(inv)
1643
wt.set_root_id(inv.root.file_id)
1644
wt.set_last_revision(revision_id)
1645
wt.set_pending_merges([])
1646
build_tree(wt.basis_tree(), wt)
1649
control_files.unlock()
1653
super(WorkingTreeFormat3, self).__init__()
1654
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1656
def open(self, a_bzrdir, _found=False):
1657
"""Return the WorkingTree object for a_bzrdir
1659
_found is a private parameter, do not use it. It is used to indicate
1660
if format probing has already been done.
1663
# we are being called directly and must probe.
1664
raise NotImplementedError
1665
if not isinstance(a_bzrdir.transport, LocalTransport):
1666
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1667
control_files = self._open_control_files(a_bzrdir)
1668
return WorkingTree3(a_bzrdir.root_transport.base,
1672
_control_files=control_files)
1675
return self.get_format_string()
1678
# formats which have no format string are not discoverable
1679
# and not independently creatable, so are not registered.
1680
__default_format = WorkingTreeFormat3()
1681
WorkingTreeFormat.register_format(__default_format)
1682
WorkingTreeFormat.set_default_format(__default_format)
1683
_legacy_formats = [WorkingTreeFormat2(),
1687
class WorkingTreeTestProviderAdapter(object):
1688
"""A tool to generate a suite testing multiple workingtree formats at once.
1690
This is done by copying the test once for each transport and injecting
1691
the transport_server, transport_readonly_server, and workingtree_format
1692
classes into each copy. Each copy is also given a new id() to make it
1696
def __init__(self, transport_server, transport_readonly_server, formats):
1697
self._transport_server = transport_server
1698
self._transport_readonly_server = transport_readonly_server
1699
self._formats = formats
1701
def adapt(self, test):
1702
from bzrlib.tests import TestSuite
1703
result = TestSuite()
1704
for workingtree_format, bzrdir_format in self._formats:
1705
new_test = deepcopy(test)
1706
new_test.transport_server = self._transport_server
1707
new_test.transport_readonly_server = self._transport_readonly_server
1708
new_test.bzrdir_format = bzrdir_format
1709
new_test.workingtree_format = workingtree_format
1710
def make_new_test_id():
1711
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1712
return lambda: new_id
1713
new_test.id = make_new_test_id()
1714
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
