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
51
from bzrlib.atomicfile import AtomicFile
52
from bzrlib.branch import (Branch,
54
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
55
import bzrlib.bzrdir as bzrdir
56
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
import bzrlib.errors as errors
58
from bzrlib.errors import (BzrCheckError,
62
WeaveRevisionNotPresent,
66
MergeModifiedFormatError,
69
from bzrlib.inventory import InventoryEntry, Inventory
70
from bzrlib.lockable_files import LockableFiles, TransportLock
71
from bzrlib.lockdir import LockDir
72
from bzrlib.merge import merge_inner, transform_tree
73
from bzrlib.osutils import (
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import *
95
from bzrlib.textui import show_status
97
from bzrlib.transform import build_tree
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport import get_transport
100
from bzrlib.transport.local import LocalTransport
105
def gen_file_id(name):
106
"""Return new file id.
108
This should probably generate proper UUIDs, but for the moment we
109
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().",
247
self._branch = branch
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)
286
fget=lambda self: self._branch,
287
doc="""The branch this WorkingTree is connected to.
289
This cannot be set - it is reflective of the actual disk structure
290
the working tree has been constructed from.
293
def break_lock(self):
294
"""Break a lock if one is present from another instance.
296
Uses the ui factory to ask for confirmation if the lock may be from
299
This will probe the repository for its lock as well.
301
self._control_files.break_lock()
302
self.branch.break_lock()
304
def _set_inventory(self, inv):
305
self._inventory = inv
306
self.path2id = self._inventory.path2id
308
def is_control_filename(self, filename):
309
"""True if filename is the name of a control file in this tree.
311
This is true IF and ONLY IF the filename is part of the meta data
312
that bzr controls in this tree. I.E. a random .bzr directory placed
313
on disk will not be a control file for this tree.
316
self.bzrdir.transport.relpath(self.abspath(filename))
318
except errors.PathNotChild:
322
def open(path=None, _unsupported=False):
323
"""Open an existing working tree at path.
327
path = os.path.getcwdu()
328
control = bzrdir.BzrDir.open(path, _unsupported)
329
return control.open_workingtree(_unsupported)
332
def open_containing(path=None):
333
"""Open an existing working tree which has its root about path.
335
This probes for a working tree at path and searches upwards from there.
337
Basically we keep looking up until we find the control directory or
338
run into /. If there isn't one, raises NotBranchError.
339
TODO: give this a new exception.
340
If there is one, it is returned, along with the unused portion of path.
344
control, relpath = bzrdir.BzrDir.open_containing(path)
345
return control.open_workingtree(), relpath
348
def open_downlevel(path=None):
349
"""Open an unsupported working tree.
351
Only intended for advanced situations like upgrading part of a bzrdir.
353
return WorkingTree.open(path, _unsupported=True)
356
"""Iterate through file_ids for this tree.
358
file_ids are in a WorkingTree if they are in the working inventory
359
and the working file exists.
361
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if bzrlib.osutils.lexists(self.abspath(path)):
367
return "<%s of %s>" % (self.__class__.__name__,
368
getattr(self, 'basedir', None))
370
def abspath(self, filename):
371
return pathjoin(self.basedir, filename)
373
def basis_tree(self):
374
"""Return RevisionTree for the current last revision."""
375
revision_id = self.last_revision()
376
if revision_id is not None:
378
xml = self.read_basis_inventory()
379
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
382
if inv is not None and inv.revision_id == revision_id:
383
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
385
# FIXME? RBC 20060403 should we cache the inventory here ?
386
return self.branch.repository.revision_tree(revision_id)
389
@deprecated_method(zero_eight)
390
def create(branch, directory):
391
"""Create a workingtree for branch at directory.
393
If existing_directory already exists it must have a .bzr directory.
394
If it does not exist, it will be created.
396
This returns a new WorkingTree object for the new checkout.
398
TODO FIXME RBC 20060124 when we have checkout formats in place this
399
should accept an optional revisionid to checkout [and reject this if
400
checking out into the same dir as a pre-checkout-aware branch format.]
402
XXX: When BzrDir is present, these should be created through that
405
warn('delete WorkingTree.create', stacklevel=3)
406
transport = get_transport(directory)
407
if branch.bzrdir.root_transport.base == transport.base:
409
return branch.bzrdir.create_workingtree()
410
# different directory,
411
# create a branch reference
412
# and now a working tree.
413
raise NotImplementedError
416
@deprecated_method(zero_eight)
417
def create_standalone(directory):
418
"""Create a checkout and a branch and a repo at directory.
420
Directory must exist and be empty.
422
please use BzrDir.create_standalone_workingtree
424
return bzrdir.BzrDir.create_standalone_workingtree(directory)
426
def relpath(self, abs):
427
"""Return the local path portion from a given absolute path."""
428
return relpath(self.basedir, abs)
430
def has_filename(self, filename):
431
return bzrlib.osutils.lexists(self.abspath(filename))
433
def get_file(self, file_id):
434
return self.get_file_byname(self.id2path(file_id))
436
def get_file_byname(self, filename):
437
return file(self.abspath(filename), 'rb')
439
def get_root_id(self):
440
"""Return the id of this trees root"""
441
inv = self.read_working_inventory()
442
return inv.root.file_id
444
def _get_store_filename(self, file_id):
445
## XXX: badly named; this is not in the store at all
446
return self.abspath(self.id2path(file_id))
449
def clone(self, to_bzrdir, revision_id=None, basis=None):
450
"""Duplicate this working tree into to_bzr, including all state.
452
Specifically modified files are kept as modified, but
453
ignored and unknown files are discarded.
455
If you want to make a new line of development, see bzrdir.sprout()
458
If not None, the cloned tree will have its last revision set to
459
revision, and and difference between the source trees last revision
460
and this one merged in.
463
If not None, a closer copy of a tree which may have some files in
464
common, and which file content should be preferentially copied from.
466
# assumes the target bzr dir format is compatible.
467
result = self._format.initialize(to_bzrdir)
468
self.copy_content_into(result, revision_id)
472
def copy_content_into(self, tree, revision_id=None):
473
"""Copy the current content and user files of this tree into tree."""
474
if revision_id is None:
475
transform_tree(tree, self)
477
# TODO now merge from tree.last_revision to revision
478
transform_tree(tree, self)
479
tree.set_last_revision(revision_id)
482
def commit(self, message=None, revprops=None, *args, **kwargs):
483
# avoid circular imports
484
from bzrlib.commit import Commit
487
if not 'branch-nick' in revprops:
488
revprops['branch-nick'] = self.branch.nick
489
# args for wt.commit start at message from the Commit.commit method,
490
# but with branch a kwarg now, passing in args as is results in the
491
#message being used for the branch
492
args = (DEPRECATED_PARAMETER, message, ) + args
493
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
494
self._set_inventory(self.read_working_inventory())
496
def id2abspath(self, file_id):
497
return self.abspath(self.id2path(file_id))
499
def has_id(self, file_id):
500
# files that have been deleted are excluded
501
inv = self._inventory
502
if not inv.has_id(file_id):
504
path = inv.id2path(file_id)
505
return bzrlib.osutils.lexists(self.abspath(path))
507
def has_or_had_id(self, file_id):
508
if file_id == self.inventory.root.file_id:
510
return self.inventory.has_id(file_id)
512
__contains__ = has_id
514
def get_file_size(self, file_id):
515
return os.path.getsize(self.id2abspath(file_id))
518
def get_file_sha1(self, file_id):
519
path = self._inventory.id2path(file_id)
520
return self._hashcache.get_sha1(path)
522
def is_executable(self, file_id):
523
if not supports_executable():
524
return self._inventory[file_id].executable
526
path = self._inventory.id2path(file_id)
527
mode = os.lstat(self.abspath(path)).st_mode
528
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
531
def add(self, files, ids=None):
532
"""Make files versioned.
534
Note that the command line normally calls smart_add instead,
535
which can automatically recurse.
537
This adds the files to the inventory, so that they will be
538
recorded by the next commit.
541
List of paths to add, relative to the base of the tree.
544
If set, use these instead of automatically generated ids.
545
Must be the same length as the list of files, but may
546
contain None for ids that are to be autogenerated.
548
TODO: Perhaps have an option to add the ids even if the files do
551
TODO: Perhaps callback with the ids and paths as they're added.
553
# TODO: Re-adding a file that is removed in the working copy
554
# should probably put it back with the previous ID.
555
if isinstance(files, basestring):
556
assert(ids is None or isinstance(ids, basestring))
562
ids = [None] * len(files)
564
assert(len(ids) == len(files))
566
inv = self.read_working_inventory()
567
for f,file_id in zip(files, ids):
568
if self.is_control_filename(f):
569
raise BzrError("cannot add control file %s" % quotefn(f))
574
raise BzrError("cannot add top-level %r" % f)
576
fullpath = normpath(self.abspath(f))
579
kind = file_kind(fullpath)
581
if e.errno == errno.ENOENT:
582
raise NoSuchFile(fullpath)
583
# maybe something better?
584
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
586
if not InventoryEntry.versionable_kind(kind):
587
raise BzrError('cannot add: not a versionable file ('
588
'i.e. regular file, symlink or directory): %s' % quotefn(f))
591
file_id = gen_file_id(f)
592
inv.add_path(f, kind=kind, file_id=file_id)
594
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
595
self._write_inventory(inv)
598
def add_pending_merge(self, *revision_ids):
599
# TODO: Perhaps should check at this point that the
600
# history of the revision is actually present?
601
p = self.pending_merges()
603
for rev_id in revision_ids:
609
self.set_pending_merges(p)
612
def pending_merges(self):
613
"""Return a list of pending merges.
615
These are revisions that have been merged into the working
616
directory but not yet committed.
619
merges_file = self._control_files.get_utf8('pending-merges')
621
if e.errno != errno.ENOENT:
625
for l in merges_file.readlines():
626
p.append(l.rstrip('\n'))
630
def set_pending_merges(self, rev_list):
631
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
634
def set_merge_modified(self, modified_hashes):
636
for file_id, hash in modified_hashes.iteritems():
637
yield Stanza(file_id=file_id, hash=hash)
638
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
641
def _put_rio(self, filename, stanzas, header):
642
my_file = rio_file(stanzas, header)
643
self._control_files.put(filename, my_file)
646
def merge_modified(self):
648
hashfile = self._control_files.get('merge-hashes')
653
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
654
raise MergeModifiedFormatError()
655
except StopIteration:
656
raise MergeModifiedFormatError()
657
for s in RioReader(hashfile):
658
file_id = s.get("file_id")
659
if file_id not in self.inventory:
662
if hash == self.get_file_sha1(file_id):
663
merge_hashes[file_id] = hash
666
def get_symlink_target(self, file_id):
667
return os.readlink(self.id2abspath(file_id))
669
def file_class(self, filename):
670
if self.path2id(filename):
672
elif self.is_ignored(filename):
677
def list_files(self):
678
"""Recursively list all files as (path, class, kind, id).
680
Lists, but does not descend into unversioned directories.
682
This does not include files that have been deleted in this
685
Skips the control directory.
687
inv = self._inventory
689
def descend(from_dir_relpath, from_dir_id, dp):
693
## TODO: If we find a subdirectory with its own .bzr
694
## directory, then that is a separate tree and we
695
## should exclude it.
697
# the bzrdir for this tree
698
if self.bzrdir.transport.base.endswith(f + '/'):
702
fp = appendpath(from_dir_relpath, f)
705
fap = appendpath(dp, f)
707
f_ie = inv.get_child(from_dir_id, f)
710
elif self.is_ignored(fp):
719
raise BzrCheckError("file %r entered as kind %r id %r, "
721
% (fap, f_ie.kind, f_ie.file_id, fk))
723
# make a last minute entry
727
if fk == 'directory':
728
entry = TreeDirectory()
731
elif fk == 'symlink':
736
yield fp, c, fk, (f_ie and f_ie.file_id), entry
738
if fk != 'directory':
742
# don't descend unversioned directories
745
for ff in descend(fp, f_ie.file_id, fap):
748
for f in descend(u'', inv.root.file_id, self.basedir):
752
def move(self, from_paths, to_name):
755
to_name must exist in the inventory.
757
If to_name exists and is a directory, the files are moved into
758
it, keeping their old names.
760
Note that to_name is only the last component of the new name;
761
this doesn't change the directory.
763
This returns a list of (from_path, to_path) pairs for each
767
## TODO: Option to move IDs only
768
assert not isinstance(from_paths, basestring)
770
to_abs = self.abspath(to_name)
771
if not isdir(to_abs):
772
raise BzrError("destination %r is not a directory" % to_abs)
773
if not self.has_filename(to_name):
774
raise BzrError("destination %r not in working directory" % to_abs)
775
to_dir_id = inv.path2id(to_name)
776
if to_dir_id == None and to_name != '':
777
raise BzrError("destination %r is not a versioned directory" % to_name)
778
to_dir_ie = inv[to_dir_id]
779
if to_dir_ie.kind not in ('directory', 'root_directory'):
780
raise BzrError("destination %r is not a directory" % to_abs)
782
to_idpath = inv.get_idpath(to_dir_id)
785
if not self.has_filename(f):
786
raise BzrError("%r does not exist in working tree" % f)
787
f_id = inv.path2id(f)
789
raise BzrError("%r is not versioned" % f)
790
name_tail = splitpath(f)[-1]
791
dest_path = appendpath(to_name, name_tail)
792
if self.has_filename(dest_path):
793
raise BzrError("destination %r already exists" % dest_path)
794
if f_id in to_idpath:
795
raise BzrError("can't move %r to a subdirectory of itself" % f)
797
# OK, so there's a race here, it's possible that someone will
798
# create a file in this interval and then the rename might be
799
# left half-done. But we should have caught most problems.
800
orig_inv = deepcopy(self.inventory)
803
name_tail = splitpath(f)[-1]
804
dest_path = appendpath(to_name, name_tail)
805
result.append((f, dest_path))
806
inv.rename(inv.path2id(f), to_dir_id, name_tail)
808
rename(self.abspath(f), self.abspath(dest_path))
810
raise BzrError("failed to rename %r to %r: %s" %
811
(f, dest_path, e[1]),
812
["rename rolled back"])
814
# restore the inventory on error
815
self._set_inventory(orig_inv)
817
self._write_inventory(inv)
821
def rename_one(self, from_rel, to_rel):
824
This can change the directory or the filename or both.
827
if not self.has_filename(from_rel):
828
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
829
if self.has_filename(to_rel):
830
raise BzrError("can't rename: new working file %r already exists" % to_rel)
832
file_id = inv.path2id(from_rel)
834
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
837
from_parent = entry.parent_id
838
from_name = entry.name
840
if inv.path2id(to_rel):
841
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
843
to_dir, to_tail = os.path.split(to_rel)
844
to_dir_id = inv.path2id(to_dir)
845
if to_dir_id == None and to_dir != '':
846
raise BzrError("can't determine destination directory id for %r" % to_dir)
848
mutter("rename_one:")
849
mutter(" file_id {%s}" % file_id)
850
mutter(" from_rel %r" % from_rel)
851
mutter(" to_rel %r" % to_rel)
852
mutter(" to_dir %r" % to_dir)
853
mutter(" to_dir_id {%s}" % to_dir_id)
855
inv.rename(file_id, to_dir_id, to_tail)
857
from_abs = self.abspath(from_rel)
858
to_abs = self.abspath(to_rel)
860
rename(from_abs, to_abs)
862
inv.rename(file_id, from_parent, from_name)
863
raise BzrError("failed to rename %r to %r: %s"
864
% (from_abs, to_abs, e[1]),
865
["rename rolled back"])
866
self._write_inventory(inv)
870
"""Return all unknown files.
872
These are files in the working directory that are not versioned or
873
control files or ignored.
875
>>> from bzrlib.bzrdir import ScratchDir
876
>>> d = ScratchDir(files=['foo', 'foo~'])
877
>>> b = d.open_branch()
878
>>> tree = d.open_workingtree()
879
>>> map(str, tree.unknowns())
882
>>> list(b.unknowns())
884
>>> tree.remove('foo')
885
>>> list(b.unknowns())
888
for subp in self.extras():
889
if not self.is_ignored(subp):
892
@deprecated_method(zero_eight)
893
def iter_conflicts(self):
894
"""List all files in the tree that have text or content conflicts.
895
DEPRECATED. Use conflicts instead."""
896
return self._iter_conflicts()
898
def _iter_conflicts(self):
900
for path in (s[0] for s in self.list_files()):
901
stem = get_conflicted_stem(path)
904
if stem not in conflicted:
909
def pull(self, source, overwrite=False, stop_revision=None):
910
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
913
pp = ProgressPhase("Pull phase", 2, top_pb)
915
old_revision_history = self.branch.revision_history()
916
basis_tree = self.basis_tree()
917
count = self.branch.pull(source, overwrite, stop_revision)
918
new_revision_history = self.branch.revision_history()
919
if new_revision_history != old_revision_history:
921
if len(old_revision_history):
922
other_revision = old_revision_history[-1]
924
other_revision = None
925
repository = self.branch.repository
926
pb = bzrlib.ui.ui_factory.nested_progress_bar()
928
merge_inner(self.branch,
929
self.branch.basis_tree(),
935
self.set_last_revision(self.branch.last_revision())
942
"""Yield all unknown files in this WorkingTree.
944
If there are any unknown directories then only the directory is
945
returned, not all its children. But if there are unknown files
946
under a versioned subdirectory, they are returned.
948
Currently returned depth-first, sorted by name within directories.
950
## TODO: Work from given directory downwards
951
for path, dir_entry in self.inventory.directories():
952
mutter("search for unknowns in %r", path)
953
dirabs = self.abspath(path)
954
if not isdir(dirabs):
955
# e.g. directory deleted
959
for subf in os.listdir(dirabs):
961
and (subf not in dir_entry.children)):
966
subp = appendpath(path, subf)
969
def _translate_ignore_rule(self, rule):
970
"""Translate a single ignore rule to a regex.
972
There are three sorts of ignore rules:
973
root only - regex is the rule itself without the leading './'. These
974
are identified by a leading './'.
975
full path - regex is the rule itself and is identified by the
976
presenve of a '/' in the path.
977
basename only rule - regex is a rule that ignores everything up
978
to the last / in the string before applying the supplied rule.
979
These are the default case.
981
:return: The translated regex.
983
if rule[:2] in ('./', '.\\'):
985
result = fnmatch.translate(rule[2:])
986
elif '/' in rule or '\\' in rule:
988
result = fnmatch.translate(rule)
990
# default rule style.
991
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
992
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
993
return "(" + result + ")"
995
def _combine_ignore_rules(self, rules):
996
"""Combine a list of ignore rules into a single regex object.
998
Each individual rule is combined with | to form a big regex, which then
999
has $ added to it to form something like ()|()|()$. The group index for
1000
each subregex's outermost group is placed in a dictionary mapping back
1001
to the rule. This allows quick identification of the matching rule that
1003
:return: a list of the compiled regex and the matching-group index
1004
dictionaries. We return a list because python complains if you try to
1005
combine more than 100 regexes.
1010
translated_rules = []
1012
translated_rule = self._translate_ignore_rule(rule)
1013
compiled_rule = re.compile(translated_rule)
1014
groups[next_group] = rule
1015
next_group += compiled_rule.groups
1016
translated_rules.append(translated_rule)
1017
if next_group == 99:
1018
result.append((re.compile("|".join(translated_rules)), groups))
1021
translated_rules = []
1022
if len(translated_rules):
1023
result.append((re.compile("|".join(translated_rules)), groups))
1026
def ignored_files(self):
1027
"""Yield list of PATH, IGNORE_PATTERN"""
1028
for subp in self.extras():
1029
pat = self.is_ignored(subp)
1033
def get_ignore_list(self):
1034
"""Return list of ignore patterns.
1036
Cached in the Tree object after the first call.
1038
if hasattr(self, '_ignorelist'):
1039
return self._ignorelist
1041
l = bzrlib.DEFAULT_IGNORE[:]
1042
if self.has_filename(bzrlib.IGNORE_FILENAME):
1043
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1044
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1045
self._ignorelist = l
1046
self._ignore_regex = self._combine_ignore_rules(l)
1049
def _get_ignore_rules_as_regex(self):
1050
"""Return a regex of the ignore rules and a mapping dict.
1052
:return: (ignore rules compiled regex, dictionary mapping rule group
1053
indices to original rule.)
1055
if getattr(self, '_ignorelist', None) is None:
1056
self.get_ignore_list()
1057
return self._ignore_regex
1059
def is_ignored(self, filename):
1060
r"""Check whether the filename matches an ignore pattern.
1062
Patterns containing '/' or '\' need to match the whole path;
1063
others match against only the last component.
1065
If the file is ignored, returns the pattern which caused it to
1066
be ignored, otherwise None. So this can simply be used as a
1067
boolean if desired."""
1069
# TODO: Use '**' to match directories, and other extended
1070
# globbing stuff from cvs/rsync.
1072
# XXX: fnmatch is actually not quite what we want: it's only
1073
# approximately the same as real Unix fnmatch, and doesn't
1074
# treat dotfiles correctly and allows * to match /.
1075
# Eventually it should be replaced with something more
1078
rules = self._get_ignore_rules_as_regex()
1079
for regex, mapping in rules:
1080
match = regex.match(filename)
1081
if match is not None:
1082
# one or more of the groups in mapping will have a non-None group
1084
groups = match.groups()
1085
rules = [mapping[group] for group in
1086
mapping if groups[group] is not None]
1090
def kind(self, file_id):
1091
return file_kind(self.id2abspath(file_id))
1094
def last_revision(self):
1095
"""Return the last revision id of this working tree.
1097
In early branch formats this was == the branch last_revision,
1098
but that cannot be relied upon - for working tree operations,
1099
always use tree.last_revision().
1101
return self.branch.last_revision()
1103
def is_locked(self):
1104
return self._control_files.is_locked()
1106
def lock_read(self):
1107
"""See Branch.lock_read, and WorkingTree.unlock."""
1108
self.branch.lock_read()
1110
return self._control_files.lock_read()
1112
self.branch.unlock()
1115
def lock_write(self):
1116
"""See Branch.lock_write, and WorkingTree.unlock."""
1117
self.branch.lock_write()
1119
return self._control_files.lock_write()
1121
self.branch.unlock()
1124
def get_physical_lock_status(self):
1125
return self._control_files.get_physical_lock_status()
1127
def _basis_inventory_name(self):
1128
return 'basis-inventory'
1131
def set_last_revision(self, new_revision):
1132
"""Change the last revision in the working tree."""
1133
if self._change_last_revision(new_revision):
1134
self._cache_basis_inventory(new_revision)
1136
def _change_last_revision(self, new_revision):
1137
"""Template method part of set_last_revision to perform the change.
1139
This is used to allow WorkingTree3 instances to not affect branch
1140
when their last revision is set.
1142
if new_revision is None:
1143
self.branch.set_revision_history([])
1145
# current format is locked in with the branch
1146
revision_history = self.branch.revision_history()
1148
position = revision_history.index(new_revision)
1150
raise errors.NoSuchRevision(self.branch, new_revision)
1151
self.branch.set_revision_history(revision_history[:position + 1])
1154
def _cache_basis_inventory(self, new_revision):
1155
"""Cache new_revision as the basis inventory."""
1157
# this double handles the inventory - unpack and repack -
1158
# but is easier to understand. We can/should put a conditional
1159
# in here based on whether the inventory is in the latest format
1160
# - perhaps we should repack all inventories on a repository
1162
inv = self.branch.repository.get_inventory(new_revision)
1163
inv.revision_id = new_revision
1164
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1166
path = self._basis_inventory_name()
1167
self._control_files.put_utf8(path, xml)
1168
except WeaveRevisionNotPresent:
1171
def read_basis_inventory(self):
1172
"""Read the cached basis inventory."""
1173
path = self._basis_inventory_name()
1174
return self._control_files.get_utf8(path).read()
1177
def read_working_inventory(self):
1178
"""Read the working inventory."""
1179
# ElementTree does its own conversion from UTF-8, so open in
1181
result = bzrlib.xml5.serializer_v5.read_inventory(
1182
self._control_files.get('inventory'))
1183
self._set_inventory(result)
1187
def remove(self, files, verbose=False):
1188
"""Remove nominated files from the working inventory..
1190
This does not remove their text. This does not run on XXX on what? RBC
1192
TODO: Refuse to remove modified files unless --force is given?
1194
TODO: Do something useful with directories.
1196
TODO: Should this remove the text or not? Tough call; not
1197
removing may be useful and the user can just use use rm, and
1198
is the opposite of add. Removing it is consistent with most
1199
other tools. Maybe an option.
1201
## TODO: Normalize names
1202
## TODO: Remove nested loops; better scalability
1203
if isinstance(files, basestring):
1206
inv = self.inventory
1208
# do this before any modifications
1210
fid = inv.path2id(f)
1212
# TODO: Perhaps make this just a warning, and continue?
1213
# This tends to happen when
1214
raise NotVersionedError(path=f)
1215
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1217
# having remove it, it must be either ignored or unknown
1218
if self.is_ignored(f):
1222
show_status(new_status, inv[fid].kind, quotefn(f))
1225
self._write_inventory(inv)
1228
def revert(self, filenames, old_tree=None, backups=True,
1229
pb=DummyProgress()):
1230
from transform import revert
1231
from conflicts import resolve
1232
if old_tree is None:
1233
old_tree = self.basis_tree()
1234
conflicts = revert(self, old_tree, filenames, backups, pb)
1235
if not len(filenames):
1236
self.set_pending_merges([])
1239
resolve(self, filenames, ignore_misses=True)
1242
# XXX: This method should be deprecated in favour of taking in a proper
1243
# new Inventory object.
1245
def set_inventory(self, new_inventory_list):
1246
from bzrlib.inventory import (Inventory,
1251
inv = Inventory(self.get_root_id())
1252
for path, file_id, parent, kind in new_inventory_list:
1253
name = os.path.basename(path)
1256
# fixme, there should be a factory function inv,add_??
1257
if kind == 'directory':
1258
inv.add(InventoryDirectory(file_id, name, parent))
1259
elif kind == 'file':
1260
inv.add(InventoryFile(file_id, name, parent))
1261
elif kind == 'symlink':
1262
inv.add(InventoryLink(file_id, name, parent))
1264
raise BzrError("unknown kind %r" % kind)
1265
self._write_inventory(inv)
1268
def set_root_id(self, file_id):
1269
"""Set the root id for this tree."""
1270
inv = self.read_working_inventory()
1271
orig_root_id = inv.root.file_id
1272
del inv._byid[inv.root.file_id]
1273
inv.root.file_id = file_id
1274
inv._byid[inv.root.file_id] = inv.root
1277
if entry.parent_id == orig_root_id:
1278
entry.parent_id = inv.root.file_id
1279
self._write_inventory(inv)
1282
"""See Branch.unlock.
1284
WorkingTree locking just uses the Branch locking facilities.
1285
This is current because all working trees have an embedded branch
1286
within them. IF in the future, we were to make branch data shareable
1287
between multiple working trees, i.e. via shared storage, then we
1288
would probably want to lock both the local tree, and the branch.
1290
# FIXME: We want to write out the hashcache only when the last lock on
1291
# this working copy is released. Peeking at the lock count is a bit
1292
# of a nasty hack; probably it's better to have a transaction object,
1293
# which can do some finalization when it's either successfully or
1294
# unsuccessfully completed. (Denys's original patch did that.)
1295
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1296
# wrongly. Hookinh into unllock on the control files object is fine though.
1298
# TODO: split this per format so there is no ugly if block
1299
if self._hashcache.needs_write and (
1300
# dedicated lock files
1301
self._control_files._lock_count==1 or
1303
(self._control_files is self.branch.control_files and
1304
self._control_files._lock_count==3)):
1305
self._hashcache.write()
1306
# reverse order of locking.
1308
return self._control_files.unlock()
1310
self.branch.unlock()
1314
"""Update a working tree along its branch.
1316
This will update the branch if its bound too, which means we have multiple trees involved:
1317
The new basis tree of the master.
1318
The old basis tree of the branch.
1319
The old basis tree of the working tree.
1320
The current working tree state.
1321
pathologically all three may be different, and non ancestors of each other.
1322
Conceptually we want to:
1323
Preserve the wt.basis->wt.state changes
1324
Transform the wt.basis to the new master basis.
1325
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1326
Restore the wt.basis->wt.state changes.
1328
There isn't a single operation at the moment to do that, so we:
1329
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1330
Do a 'normal' merge of the old branch basis if it is relevant.
1332
old_tip = self.branch.update()
1333
if old_tip is not None:
1334
self.add_pending_merge(old_tip)
1335
self.branch.lock_read()
1338
if self.last_revision() != self.branch.last_revision():
1339
# merge tree state up to new branch tip.
1340
basis = self.basis_tree()
1341
to_tree = self.branch.basis_tree()
1342
result += merge_inner(self.branch,
1346
self.set_last_revision(self.branch.last_revision())
1347
if old_tip and old_tip != self.last_revision():
1348
# our last revision was not the prior branch last reivison
1349
# and we have converted that last revision to a pending merge.
1350
# base is somewhere between the branch tip now
1351
# and the now pending merge
1352
from bzrlib.revision import common_ancestor
1354
base_rev_id = common_ancestor(self.branch.last_revision(),
1356
self.branch.repository)
1357
except errors.NoCommonAncestor:
1359
base_tree = self.branch.repository.revision_tree(base_rev_id)
1360
other_tree = self.branch.repository.revision_tree(old_tip)
1361
result += merge_inner(self.branch,
1367
self.branch.unlock()
1370
def _write_inventory(self, inv):
1371
"""Write inventory as the current inventory."""
1373
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1375
self._control_files.put('inventory', sio)
1376
self._set_inventory(inv)
1377
mutter('wrote working inventory')
1379
def set_conflicts(self, arg):
1380
raise UnsupportedOperation(self.set_conflicts, self)
1383
def conflicts(self):
1384
conflicts = ConflictList()
1385
for conflicted in self._iter_conflicts():
1388
if file_kind(self.abspath(conflicted)) != "file":
1391
if e.errno == errno.ENOENT:
1396
for suffix in ('.THIS', '.OTHER'):
1398
kind = file_kind(self.abspath(conflicted+suffix))
1400
if e.errno == errno.ENOENT:
1408
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1409
conflicts.append(Conflict.factory(ctype, path=conflicted,
1410
file_id=self.path2id(conflicted)))
1414
class WorkingTree3(WorkingTree):
1415
"""This is the Format 3 working tree.
1417
This differs from the base WorkingTree by:
1418
- having its own file lock
1419
- having its own last-revision property.
1421
This is new in bzr 0.8
1425
def last_revision(self):
1426
"""See WorkingTree.last_revision."""
1428
return self._control_files.get_utf8('last-revision').read()
1432
def _change_last_revision(self, revision_id):
1433
"""See WorkingTree._change_last_revision."""
1434
if revision_id is None or revision_id == NULL_REVISION:
1436
self._control_files._transport.delete('last-revision')
1437
except errors.NoSuchFile:
1442
self.branch.revision_history().index(revision_id)
1444
raise errors.NoSuchRevision(self.branch, revision_id)
1445
self._control_files.put_utf8('last-revision', revision_id)
1449
def set_conflicts(self, conflicts):
1450
self._put_rio('conflicts', conflicts.to_stanzas(),
1454
def conflicts(self):
1456
confile = self._control_files.get('conflicts')
1458
return ConflictList()
1460
if confile.next() != CONFLICT_HEADER_1 + '\n':
1461
raise ConflictFormatError()
1462
except StopIteration:
1463
raise ConflictFormatError()
1464
return ConflictList.from_stanzas(RioReader(confile))
1467
def get_conflicted_stem(path):
1468
for suffix in CONFLICT_SUFFIXES:
1469
if path.endswith(suffix):
1470
return path[:-len(suffix)]
1472
@deprecated_function(zero_eight)
1473
def is_control_file(filename):
1474
"""See WorkingTree.is_control_filename(filename)."""
1475
## FIXME: better check
1476
filename = normpath(filename)
1477
while filename != '':
1478
head, tail = os.path.split(filename)
1479
## mutter('check %r for control file' % ((head, tail),))
1482
if filename == head:
1488
class WorkingTreeFormat(object):
1489
"""An encapsulation of the initialization and open routines for a format.
1491
Formats provide three things:
1492
* An initialization routine,
1496
Formats are placed in an dict by their format string for reference
1497
during workingtree opening. Its not required that these be instances, they
1498
can be classes themselves with class methods - it simply depends on
1499
whether state is needed for a given format or not.
1501
Once a format is deprecated, just deprecate the initialize and open
1502
methods on the format class. Do not deprecate the object, as the
1503
object will be created every time regardless.
1506
_default_format = None
1507
"""The default format used for new trees."""
1510
"""The known formats."""
1513
def find_format(klass, a_bzrdir):
1514
"""Return the format for the working tree object in a_bzrdir."""
1516
transport = a_bzrdir.get_workingtree_transport(None)
1517
format_string = transport.get("format").read()
1518
return klass._formats[format_string]
1520
raise errors.NoWorkingTree(base=transport.base)
1522
raise errors.UnknownFormatError(format_string)
1525
def get_default_format(klass):
1526
"""Return the current default format."""
1527
return klass._default_format
1529
def get_format_string(self):
1530
"""Return the ASCII format string that identifies this format."""
1531
raise NotImplementedError(self.get_format_string)
1533
def get_format_description(self):
1534
"""Return the short description for this format."""
1535
raise NotImplementedError(self.get_format_description)
1537
def is_supported(self):
1538
"""Is this format supported?
1540
Supported formats can be initialized and opened.
1541
Unsupported formats may not support initialization or committing or
1542
some other features depending on the reason for not being supported.
1547
def register_format(klass, format):
1548
klass._formats[format.get_format_string()] = format
1551
def set_default_format(klass, format):
1552
klass._default_format = format
1555
def unregister_format(klass, format):
1556
assert klass._formats[format.get_format_string()] is format
1557
del klass._formats[format.get_format_string()]
1561
class WorkingTreeFormat2(WorkingTreeFormat):
1562
"""The second working tree format.
1564
This format modified the hash cache from the format 1 hash cache.
1567
def get_format_description(self):
1568
"""See WorkingTreeFormat.get_format_description()."""
1569
return "Working tree format 2"
1571
def stub_initialize_remote(self, control_files):
1572
"""As a special workaround create critical control files for a remote working tree
1574
This ensures that it can later be updated and dealt with locally,
1575
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1576
no working tree. (See bug #43064).
1580
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1582
control_files.put('inventory', sio)
1584
control_files.put_utf8('pending-merges', '')
1587
def initialize(self, a_bzrdir, revision_id=None):
1588
"""See WorkingTreeFormat.initialize()."""
1589
if not isinstance(a_bzrdir.transport, LocalTransport):
1590
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1591
branch = a_bzrdir.open_branch()
1592
if revision_id is not None:
1595
revision_history = branch.revision_history()
1597
position = revision_history.index(revision_id)
1599
raise errors.NoSuchRevision(branch, revision_id)
1600
branch.set_revision_history(revision_history[:position + 1])
1603
revision = branch.last_revision()
1605
wt = WorkingTree(a_bzrdir.root_transport.base,
1611
wt._write_inventory(inv)
1612
wt.set_root_id(inv.root.file_id)
1613
wt.set_last_revision(revision)
1614
wt.set_pending_merges([])
1615
build_tree(wt.basis_tree(), wt)
1619
super(WorkingTreeFormat2, self).__init__()
1620
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1622
def open(self, a_bzrdir, _found=False):
1623
"""Return the WorkingTree object for a_bzrdir
1625
_found is a private parameter, do not use it. It is used to indicate
1626
if format probing has already been done.
1629
# we are being called directly and must probe.
1630
raise NotImplementedError
1631
if not isinstance(a_bzrdir.transport, LocalTransport):
1632
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1633
return WorkingTree(a_bzrdir.root_transport.base,
1639
class WorkingTreeFormat3(WorkingTreeFormat):
1640
"""The second working tree format updated to record a format marker.
1643
- exists within a metadir controlling .bzr
1644
- includes an explicit version marker for the workingtree control
1645
files, separate from the BzrDir format
1646
- modifies the hash cache format
1648
- uses a LockDir to guard access to the repository
1651
def get_format_string(self):
1652
"""See WorkingTreeFormat.get_format_string()."""
1653
return "Bazaar-NG Working Tree format 3"
1655
def get_format_description(self):
1656
"""See WorkingTreeFormat.get_format_description()."""
1657
return "Working tree format 3"
1659
_lock_file_name = 'lock'
1660
_lock_class = LockDir
1662
def _open_control_files(self, a_bzrdir):
1663
transport = a_bzrdir.get_workingtree_transport(None)
1664
return LockableFiles(transport, self._lock_file_name,
1667
def initialize(self, a_bzrdir, revision_id=None):
1668
"""See WorkingTreeFormat.initialize().
1670
revision_id allows creating a working tree at a differnet
1671
revision than the branch is at.
1673
if not isinstance(a_bzrdir.transport, LocalTransport):
1674
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1675
transport = a_bzrdir.get_workingtree_transport(self)
1676
control_files = self._open_control_files(a_bzrdir)
1677
control_files.create_lock()
1678
control_files.lock_write()
1679
control_files.put_utf8('format', self.get_format_string())
1680
branch = a_bzrdir.open_branch()
1681
if revision_id is None:
1682
revision_id = branch.last_revision()
1684
wt = WorkingTree3(a_bzrdir.root_transport.base,
1690
_control_files=control_files)
1693
wt._write_inventory(inv)
1694
wt.set_root_id(inv.root.file_id)
1695
wt.set_last_revision(revision_id)
1696
wt.set_pending_merges([])
1697
build_tree(wt.basis_tree(), wt)
1700
control_files.unlock()
1704
super(WorkingTreeFormat3, self).__init__()
1705
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1707
def open(self, a_bzrdir, _found=False):
1708
"""Return the WorkingTree object for a_bzrdir
1710
_found is a private parameter, do not use it. It is used to indicate
1711
if format probing has already been done.
1714
# we are being called directly and must probe.
1715
raise NotImplementedError
1716
if not isinstance(a_bzrdir.transport, LocalTransport):
1717
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1718
control_files = self._open_control_files(a_bzrdir)
1719
return WorkingTree3(a_bzrdir.root_transport.base,
1723
_control_files=control_files)
1726
return self.get_format_string()
1729
# formats which have no format string are not discoverable
1730
# and not independently creatable, so are not registered.
1731
__default_format = WorkingTreeFormat3()
1732
WorkingTreeFormat.register_format(__default_format)
1733
WorkingTreeFormat.set_default_format(__default_format)
1734
_legacy_formats = [WorkingTreeFormat2(),
1738
class WorkingTreeTestProviderAdapter(object):
1739
"""A tool to generate a suite testing multiple workingtree formats at once.
1741
This is done by copying the test once for each transport and injecting
1742
the transport_server, transport_readonly_server, and workingtree_format
1743
classes into each copy. Each copy is also given a new id() to make it
1747
def __init__(self, transport_server, transport_readonly_server, formats):
1748
self._transport_server = transport_server
1749
self._transport_readonly_server = transport_readonly_server
1750
self._formats = formats
1752
def adapt(self, test):
1753
from bzrlib.tests import TestSuite
1754
result = TestSuite()
1755
for workingtree_format, bzrdir_format in self._formats:
1756
new_test = deepcopy(test)
1757
new_test.transport_server = self._transport_server
1758
new_test.transport_readonly_server = self._transport_readonly_server
1759
new_test.bzrdir_format = bzrdir_format
1760
new_test.workingtree_format = workingtree_format
1761
def make_new_test_id():
1762
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1763
return lambda: new_id
1764
new_test.id = make_new_test_id()
1765
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
