1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
19
# FIXME: I don't know if writing out the cache from the destructor is really a
20
# good idea, because destructors are considered poor taste in Python, and
21
# it's not predictable when it will be written out.
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
44
from copy import deepcopy
45
from cStringIO import StringIO
27
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
28
from bzrlib.errors import BzrCheckError
29
from bzrlib.trace import mutter
31
class WorkingTree(bzrlib.tree.Tree):
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
from bzrlib.atomicfile import AtomicFile
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
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
import bzrlib.mutabletree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
import bzrlib.revisiontree
95
from bzrlib.rio import RioReader, rio_file, Stanza
96
from bzrlib.symbol_versioning import (deprecated_passed,
102
from bzrlib.trace import mutter, note
103
from bzrlib.transform import build_tree
104
from bzrlib.transport import get_transport
105
from bzrlib.transport.local import LocalTransport
106
from bzrlib.textui import show_status
111
# the regex removes any weird characters; we don't escape them
112
# but rather just pull them out
113
_gen_file_id_re = re.compile(r'[^\w.]')
114
_gen_id_suffix = None
118
def _next_id_suffix():
119
"""Create a new file id suffix that is reasonably unique.
121
On the first call we combine the current time with 64 bits of randomness
122
to give a highly probably globally unique number. Then each call in the same
123
process adds 1 to a serial number we append to that unique value.
125
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
126
# than having to move the id randomness out of the inner loop like this.
127
# XXX TODO: for the global randomness this uses we should add the thread-id
128
# before the serial #.
129
global _gen_id_suffix, _gen_id_serial
130
if _gen_id_suffix is None:
131
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
133
return _gen_id_suffix + str(_gen_id_serial)
136
def gen_file_id(name):
137
"""Return new file id for the basename 'name'.
139
The uniqueness is supplied from _next_id_suffix.
141
# The real randomness is in the _next_id_suffix, the
142
# rest of the identifier is just to be nice.
144
# 1) Remove non-ascii word characters to keep the ids portable
145
# 2) squash to lowercase, so the file id doesn't have to
146
# be escaped (case insensitive filesystems would bork for ids
147
# that only differred in case without escaping).
148
# 3) truncate the filename to 20 chars. Long filenames also bork on some
150
# 4) Removing starting '.' characters to prevent the file ids from
151
# being considered hidden.
152
ascii_word_only = _gen_file_id_re.sub('', name.lower())
153
short_no_dots = ascii_word_only.lstrip('.')[:20]
154
return short_no_dots + _next_id_suffix()
158
"""Return a new tree-root file id."""
159
return gen_file_id('TREE_ROOT')
162
class TreeEntry(object):
163
"""An entry that implements the minimum interface used by commands.
165
This needs further inspection, it may be better to have
166
InventoryEntries without ids - though that seems wrong. For now,
167
this is a parallel hierarchy to InventoryEntry, and needs to become
168
one of several things: decorates to that hierarchy, children of, or
170
Another note is that these objects are currently only used when there is
171
no InventoryEntry available - i.e. for unversioned objects.
172
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
175
def __eq__(self, other):
176
# yes, this us ugly, TODO: best practice __eq__ style.
177
return (isinstance(other, TreeEntry)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeDirectory(TreeEntry):
185
"""See TreeEntry. This is a directory in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeDirectory)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeFile(TreeEntry):
196
"""See TreeEntry. This is a regular file in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeFile)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class TreeLink(TreeEntry):
207
"""See TreeEntry. This is a symlink in a working tree."""
209
def __eq__(self, other):
210
return (isinstance(other, TreeLink)
211
and other.__class__ == self.__class__)
213
def kind_character(self):
217
class WorkingTree(bzrlib.mutabletree.MutableTree):
32
218
"""Working copy tree.
34
220
The inventory is held in the `Branch` working-inventory, and the
37
223
It is possible for a `WorkingTree` to have a filename which is
38
224
not listed in the Inventory and vice versa.
40
def __init__(self, basedir, inv):
227
def __init__(self, basedir='.',
228
branch=DEPRECATED_PARAMETER,
234
"""Construct a WorkingTree for basedir.
236
If the branch is not supplied, it is opened automatically.
237
If the branch is supplied, it must be the branch for this basedir.
238
(branch.base is not cross checked, because for remote branches that
239
would be meaningless).
241
self._format = _format
242
self.bzrdir = _bzrdir
244
# not created via open etc.
245
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
246
"Please use bzrdir.open_workingtree or WorkingTree.open().",
249
wt = WorkingTree.open(basedir)
250
self._branch = wt.branch
251
self.basedir = wt.basedir
252
self._control_files = wt._control_files
253
self._hashcache = wt._hashcache
254
self._set_inventory(wt._inventory)
255
self._format = wt._format
256
self.bzrdir = wt.bzrdir
41
257
from bzrlib.hashcache import HashCache
42
258
from bzrlib.trace import note, mutter
45
self.basedir = basedir
46
self.path2id = inv.path2id
259
assert isinstance(basedir, basestring), \
260
"base directory %r is not a string" % basedir
261
basedir = safe_unicode(basedir)
262
mutter("opening working tree %r", basedir)
263
if deprecated_passed(branch):
265
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
266
" Please use bzrdir.open_workingtree() or"
267
" WorkingTree.open().",
271
self._branch = branch
273
self._branch = self.bzrdir.open_branch()
274
self.basedir = realpath(basedir)
275
# if branch is at our basedir and is a format 6 or less
276
if isinstance(self._format, WorkingTreeFormat2):
277
# share control object
278
self._control_files = self.branch.control_files
280
# assume all other formats have their own control files.
281
assert isinstance(_control_files, LockableFiles), \
282
"_control_files must be a LockableFiles, not %r" \
284
self._control_files = _control_files
48
285
# update the whole cache up front and write to disk if anything changed;
49
286
# in the future we might want to do this more selectively
50
hc = self._hashcache = HashCache(basedir)
287
# two possible ways offer themselves : in self._unlock, write the cache
288
# if needed, or, when the cache sees a change, append it to the hash
289
# cache file, and have the parser take the most recent entry for a
291
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
292
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
294
# is this scan needed ? it makes things kinda slow.
54
297
if hc.needs_write:
55
298
mutter("write hc")
60
if self._hashcache.needs_write:
61
self._hashcache.write()
301
if _inventory is None:
302
self._set_inventory(self.read_working_inventory())
304
self._set_inventory(_inventory)
307
fget=lambda self: self._branch,
308
doc="""The branch this WorkingTree is connected to.
310
This cannot be set - it is reflective of the actual disk structure
311
the working tree has been constructed from.
314
def break_lock(self):
315
"""Break a lock if one is present from another instance.
317
Uses the ui factory to ask for confirmation if the lock may be from
320
This will probe the repository for its lock as well.
322
self._control_files.break_lock()
323
self.branch.break_lock()
325
def _set_inventory(self, inv):
326
assert inv.root is not None
327
self._inventory = inv
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.
350
:return: The WorkingTree that contains 'path', and the rest of path
353
path = osutils.getcwd()
354
control, relpath = bzrdir.BzrDir.open_containing(path)
356
return control.open_workingtree(), relpath
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
64
366
def __iter__(self):
65
367
"""Iterate through file_ids for this tree.
70
372
inv = self._inventory
71
373
for path, ie in inv.iter_entries():
72
if os.path.exists(self.abspath(path)):
374
if osutils.lexists(self.abspath(path)):
76
377
def __repr__(self):
77
378
return "<%s of %s>" % (self.__class__.__name__,
78
379
getattr(self, 'basedir', None))
82
381
def abspath(self, filename):
83
return os.path.join(self.basedir, filename)
382
return pathjoin(self.basedir, filename)
384
def basis_tree(self):
385
"""Return RevisionTree for the current last revision.
387
If the left most parent is a ghost then the returned tree will be an
388
empty tree - one obtained by calling repository.revision_tree(None).
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
395
inv.root.revision = revision_id
398
if inv is not None and inv.revision_id == revision_id:
399
return bzrlib.revisiontree.RevisionTree(self.branch.repository,
401
# FIXME? RBC 20060403 should we cache the inventory here ?
403
return self.branch.repository.revision_tree(revision_id)
404
except errors.RevisionNotPresent:
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(None)
414
@deprecated_method(zero_eight)
415
def create(branch, directory):
416
"""Create a workingtree for branch at directory.
418
If existing_directory already exists it must have a .bzr directory.
419
If it does not exist, it will be created.
421
This returns a new WorkingTree object for the new checkout.
423
TODO FIXME RBC 20060124 when we have checkout formats in place this
424
should accept an optional revisionid to checkout [and reject this if
425
checking out into the same dir as a pre-checkout-aware branch format.]
427
XXX: When BzrDir is present, these should be created through that
430
warnings.warn('delete WorkingTree.create', stacklevel=3)
431
transport = get_transport(directory)
432
if branch.bzrdir.root_transport.base == transport.base:
434
return branch.bzrdir.create_workingtree()
435
# different directory,
436
# create a branch reference
437
# and now a working tree.
438
raise NotImplementedError
441
@deprecated_method(zero_eight)
442
def create_standalone(directory):
443
"""Create a checkout and a branch and a repo at directory.
445
Directory must exist and be empty.
447
please use BzrDir.create_standalone_workingtree
449
return bzrdir.BzrDir.create_standalone_workingtree(directory)
451
def relpath(self, path):
452
"""Return the local path portion from a given path.
454
The path may be absolute or relative. If its a relative path it is
455
interpreted relative to the python current working directory.
457
return relpath(self.basedir, path)
85
459
def has_filename(self, filename):
86
return os.path.exists(self.abspath(filename))
460
return osutils.lexists(self.abspath(filename))
88
462
def get_file(self, file_id):
89
463
return self.get_file_byname(self.id2path(file_id))
465
def get_file_text(self, file_id):
466
return self.get_file(file_id).read()
91
468
def get_file_byname(self, filename):
92
469
return file(self.abspath(filename), 'rb')
471
def get_parent_ids(self):
472
"""See Tree.get_parent_ids.
474
This implementation reads the pending merges list and last_revision
475
value and uses that to decide what the parents list should be.
477
last_rev = self.last_revision()
483
merges_file = self._control_files.get_utf8('pending-merges')
487
for l in merges_file.readlines():
488
parents.append(l.rstrip('\n'))
491
def get_root_id(self):
492
"""Return the id of this trees root"""
493
inv = self.read_working_inventory()
494
return inv.root.file_id
94
496
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
96
return self.abspath(self.id2path(file_id))
497
## XXX: badly named; this is not in the store at all
498
return self.abspath(self.id2path(file_id))
501
def clone(self, to_bzrdir, revision_id=None, basis=None):
502
"""Duplicate this working tree into to_bzr, including all state.
504
Specifically modified files are kept as modified, but
505
ignored and unknown files are discarded.
507
If you want to make a new line of development, see bzrdir.sprout()
510
If not None, the cloned tree will have its last revision set to
511
revision, and and difference between the source trees last revision
512
and this one merged in.
515
If not None, a closer copy of a tree which may have some files in
516
common, and which file content should be preferentially copied from.
518
# assumes the target bzr dir format is compatible.
519
result = self._format.initialize(to_bzrdir)
520
self.copy_content_into(result, revision_id)
524
def copy_content_into(self, tree, revision_id=None):
525
"""Copy the current content and user files of this tree into tree."""
526
if revision_id is None:
527
transform_tree(tree, self)
529
# TODO now merge from tree.last_revision to revision (to preserve
530
# user local changes)
531
transform_tree(tree, self)
532
tree.set_parent_ids([revision_id])
534
def id2abspath(self, file_id):
535
return self.abspath(self.id2path(file_id))
99
537
def has_id(self, file_id):
100
538
# files that have been deleted are excluded
101
539
inv = self._inventory
102
540
if not inv.has_id(file_id):
104
542
path = inv.id2path(file_id)
105
return os.path.exists(self.abspath(path))
543
return osutils.lexists(self.abspath(path))
545
def has_or_had_id(self, file_id):
546
if file_id == self.inventory.root.file_id:
548
return self.inventory.has_id(file_id)
108
550
__contains__ = has_id
111
552
def get_file_size(self, file_id):
112
# is this still called?
113
raise NotImplementedError()
116
def get_file_sha1(self, file_id):
117
path = self._inventory.id2path(file_id)
553
return os.path.getsize(self.id2abspath(file_id))
556
def get_file_sha1(self, file_id, path=None):
558
path = self._inventory.id2path(file_id)
118
559
return self._hashcache.get_sha1(path)
561
def get_file_mtime(self, file_id, path=None):
563
path = self._inventory.id2path(file_id)
564
return os.lstat(self.abspath(path)).st_mtime
566
if not supports_executable():
567
def is_executable(self, file_id, path=None):
568
return self._inventory[file_id].executable
570
def is_executable(self, file_id, path=None):
572
path = self._inventory.id2path(file_id)
573
mode = os.lstat(self.abspath(path)).st_mode
574
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
577
def _add(self, files, ids, kinds):
578
"""See MutableTree._add."""
579
# TODO: Re-adding a file that is removed in the working copy
580
# should probably put it back with the previous ID.
581
# the read and write working inventory should not occur in this
582
# function - they should be part of lock_write and unlock.
583
inv = self.read_working_inventory()
584
for f, file_id, kind in zip(files, ids, kinds):
585
assert kind is not None
587
inv.add_path(f, kind=kind)
589
inv.add_path(f, kind=kind, file_id=file_id)
590
self._write_inventory(inv)
592
def _gather_kinds(self, files, kinds):
593
"""See MutableTree._gather_kinds."""
594
for pos, f in enumerate(files):
595
if kinds[pos] is None:
596
fullpath = normpath(self.abspath(f))
598
kinds[pos] = file_kind(fullpath)
600
if e.errno == errno.ENOENT:
601
raise NoSuchFile(fullpath)
604
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
605
"""Add revision_id as a parent.
607
This is equivalent to retrieving the current list of parent ids
608
and setting the list to its value plus revision_id.
610
:param revision_id: The revision id to add to the parent list. It may
611
be a ghost revision as long as its not the first parent to be added,
612
or the allow_leftmost_as_ghost parameter is set True.
613
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
615
parents = self.get_parent_ids() + [revision_id]
616
self.set_parent_ids(parents,
617
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
620
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
621
"""Add revision_id, tree tuple as a parent.
623
This is equivalent to retrieving the current list of parent trees
624
and setting the list to its value plus parent_tuple. See also
625
add_parent_tree_id - if you only have a parent id available it will be
626
simpler to use that api. If you have the parent already available, using
627
this api is preferred.
629
:param parent_tuple: The (revision id, tree) to add to the parent list.
630
If the revision_id is a ghost, pass None for the tree.
631
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
633
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
634
if len(parent_ids) > 1:
635
# the leftmost may have already been a ghost, preserve that if it
637
allow_leftmost_as_ghost = True
638
self.set_parent_ids(parent_ids,
639
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
642
def add_pending_merge(self, *revision_ids):
643
# TODO: Perhaps should check at this point that the
644
# history of the revision is actually present?
645
parents = self.get_parent_ids()
647
for rev_id in revision_ids:
648
if rev_id in parents:
650
parents.append(rev_id)
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
656
def pending_merges(self):
657
"""Return a list of pending merges.
659
These are revisions that have been merged into the working
660
directory but not yet committed.
662
return self.get_parent_ids()[1:]
665
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
666
"""Set the parent ids to revision_ids.
668
See also set_parent_trees. This api will try to retrieve the tree data
669
for each element of revision_ids from the trees repository. If you have
670
tree data already available, it is more efficient to use
671
set_parent_trees rather than set_parent_ids. set_parent_ids is however
672
an easier API to use.
674
:param revision_ids: The revision_ids to set as the parent ids of this
675
working tree. Any of these may be ghosts.
677
if len(revision_ids) > 0:
678
leftmost_id = revision_ids[0]
679
if (not allow_leftmost_as_ghost and not
680
self.branch.repository.has_revision(leftmost_id)):
681
raise errors.GhostRevisionUnusableHere(leftmost_id)
682
self.set_last_revision(leftmost_id)
684
self.set_last_revision(None)
685
merges = revision_ids[1:]
686
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
689
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
690
"""See MutableTree.set_parent_trees."""
691
# parent trees are not used in current format trees, delegate to
693
self.set_parent_ids([rev for (rev, tree) in parents_list],
694
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
697
def set_pending_merges(self, rev_list):
698
parents = self.get_parent_ids()
699
leftmost = parents[:1]
700
new_parents = leftmost + rev_list
701
self.set_parent_ids(new_parents)
704
def set_merge_modified(self, modified_hashes):
706
for file_id, hash in modified_hashes.iteritems():
707
yield Stanza(file_id=file_id, hash=hash)
708
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
711
def _put_rio(self, filename, stanzas, header):
712
my_file = rio_file(stanzas, header)
713
self._control_files.put(filename, my_file)
716
def merge_from_branch(self, branch, to_revision=None):
717
"""Merge from a branch into this working tree.
719
:param branch: The branch to merge from.
720
:param to_revision: If non-None, the merge will merge to to_revision, but
721
not beyond it. to_revision does not need to be in the history of
722
the branch when it is supplied. If None, to_revision defaults to
723
branch.last_revision().
725
from bzrlib.merge import Merger, Merge3Merger
726
pb = bzrlib.ui.ui_factory.nested_progress_bar()
728
merger = Merger(self.branch, this_tree=self, pb=pb)
729
merger.pp = ProgressPhase("Merge phase", 5, pb)
730
merger.pp.next_phase()
731
# check that there are no
733
merger.check_basis(check_clean=True, require_commits=False)
734
if to_revision is None:
735
to_revision = branch.last_revision()
736
merger.other_rev_id = to_revision
737
if merger.other_rev_id is None:
738
raise error.NoCommits(branch)
739
self.branch.fetch(branch, last_revision=merger.other_rev_id)
740
merger.other_basis = merger.other_rev_id
741
merger.other_tree = self.branch.repository.revision_tree(
743
merger.pp.next_phase()
745
if merger.base_rev_id == merger.other_rev_id:
746
raise errors.PointlessMerge
747
merger.backup_files = False
748
merger.merge_type = Merge3Merger
749
merger.set_interesting_files(None)
750
merger.show_base = False
751
merger.reprocess = False
752
conflicts = merger.do_merge()
759
def merge_modified(self):
761
hashfile = self._control_files.get('merge-hashes')
766
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
767
raise MergeModifiedFormatError()
768
except StopIteration:
769
raise MergeModifiedFormatError()
770
for s in RioReader(hashfile):
771
file_id = s.get("file_id")
772
if file_id not in self.inventory:
775
if hash == self.get_file_sha1(file_id):
776
merge_hashes[file_id] = hash
780
def mkdir(self, path, file_id=None):
781
"""See MutableTree.mkdir()."""
783
file_id = gen_file_id(os.path.basename(path))
784
os.mkdir(self.abspath(path))
785
self.add(path, file_id, 'directory')
788
def get_symlink_target(self, file_id):
789
return os.readlink(self.id2abspath(file_id))
121
791
def file_class(self, filename):
122
792
if self.path2id(filename):
172
882
% (fap, f_ie.kind, f_ie.file_id, fk))
174
yield fp, c, fk, (f_ie and f_ie.file_id)
884
# make a last minute entry
886
yield fp[1:], c, fk, f_ie.file_id, f_ie
889
yield fp[1:], c, fk, None, fk_entries[fk]()
891
yield fp[1:], c, fk, None, TreeEntry()
176
894
if fk != 'directory':
180
# don't descend unversioned directories
183
for ff in descend(fp, f_ie.file_id, fap):
186
for f in descend('', inv.root.file_id, self.basedir):
897
# But do this child first
898
new_children = os.listdir(fap)
900
new_children = collections.deque(new_children)
901
stack.append((f_ie.file_id, fp, fap, new_children))
902
# Break out of inner loop, so that we start outer loop with child
905
# if we finished all children, pop it off the stack
910
def move(self, from_paths, to_name):
913
to_name must exist in the inventory.
915
If to_name exists and is a directory, the files are moved into
916
it, keeping their old names.
918
Note that to_name is only the last component of the new name;
919
this doesn't change the directory.
921
This returns a list of (from_path, to_path) pairs for each
925
## TODO: Option to move IDs only
926
assert not isinstance(from_paths, basestring)
928
to_abs = self.abspath(to_name)
929
if not isdir(to_abs):
930
raise BzrError("destination %r is not a directory" % to_abs)
931
if not self.has_filename(to_name):
932
raise BzrError("destination %r not in working directory" % to_abs)
933
to_dir_id = inv.path2id(to_name)
934
if to_dir_id == None and to_name != '':
935
raise BzrError("destination %r is not a versioned directory" % to_name)
936
to_dir_ie = inv[to_dir_id]
937
if to_dir_ie.kind != 'directory':
938
raise BzrError("destination %r is not a directory" % to_abs)
940
to_idpath = inv.get_idpath(to_dir_id)
943
if not self.has_filename(f):
944
raise BzrError("%r does not exist in working tree" % f)
945
f_id = inv.path2id(f)
947
raise BzrError("%r is not versioned" % f)
948
name_tail = splitpath(f)[-1]
949
dest_path = pathjoin(to_name, name_tail)
950
if self.has_filename(dest_path):
951
raise BzrError("destination %r already exists" % dest_path)
952
if f_id in to_idpath:
953
raise BzrError("can't move %r to a subdirectory of itself" % f)
955
# OK, so there's a race here, it's possible that someone will
956
# create a file in this interval and then the rename might be
957
# left half-done. But we should have caught most problems.
958
orig_inv = deepcopy(self.inventory)
961
name_tail = splitpath(f)[-1]
962
dest_path = pathjoin(to_name, name_tail)
963
result.append((f, dest_path))
964
inv.rename(inv.path2id(f), to_dir_id, name_tail)
966
rename(self.abspath(f), self.abspath(dest_path))
968
raise BzrError("failed to rename %r to %r: %s" %
969
(f, dest_path, e[1]),
970
["rename rolled back"])
972
# restore the inventory on error
973
self._set_inventory(orig_inv)
975
self._write_inventory(inv)
979
def rename_one(self, from_rel, to_rel):
982
This can change the directory or the filename or both.
985
if not self.has_filename(from_rel):
986
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
987
if self.has_filename(to_rel):
988
raise BzrError("can't rename: new working file %r already exists" % to_rel)
990
file_id = inv.path2id(from_rel)
992
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
995
from_parent = entry.parent_id
996
from_name = entry.name
998
if inv.path2id(to_rel):
999
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1001
to_dir, to_tail = os.path.split(to_rel)
1002
to_dir_id = inv.path2id(to_dir)
1003
if to_dir_id == None and to_dir != '':
1004
raise BzrError("can't determine destination directory id for %r" % to_dir)
1006
mutter("rename_one:")
1007
mutter(" file_id {%s}" % file_id)
1008
mutter(" from_rel %r" % from_rel)
1009
mutter(" to_rel %r" % to_rel)
1010
mutter(" to_dir %r" % to_dir)
1011
mutter(" to_dir_id {%s}" % to_dir_id)
1013
inv.rename(file_id, to_dir_id, to_tail)
1015
from_abs = self.abspath(from_rel)
1016
to_abs = self.abspath(to_rel)
1018
rename(from_abs, to_abs)
1020
inv.rename(file_id, from_parent, from_name)
1021
raise BzrError("failed to rename %r to %r: %s"
1022
% (from_abs, to_abs, e[1]),
1023
["rename rolled back"])
1024
self._write_inventory(inv)
191
1027
def unknowns(self):
1028
"""Return all unknown files.
1030
These are files in the working directory that are not versioned or
1031
control files or ignored.
192
1033
for subp in self.extras():
193
1034
if not self.is_ignored(subp):
1038
def unversion(self, file_ids):
1039
"""Remove the file ids in file_ids from the current versioned set.
1041
When a file_id is unversioned, all of its children are automatically
1044
:param file_ids: The file ids to stop versioning.
1045
:raises: NoSuchId if any fileid is not currently versioned.
1047
for file_id in file_ids:
1048
if self._inventory.has_id(file_id):
1049
self._inventory.remove_recursive_id(file_id)
1051
raise errors.NoSuchId(self, file_id)
1053
# in the future this should just set a dirty bit to wait for the
1054
# final unlock. However, until all methods of workingtree start
1055
# with the current in -memory inventory rather than triggering
1056
# a read, it is more complex - we need to teach read_inventory
1057
# to know when to read, and when to not read first... and possibly
1058
# to save first when the in memory one may be corrupted.
1059
# so for now, we just only write it if it is indeed dirty.
1061
self._write_inventory(self._inventory)
1063
@deprecated_method(zero_eight)
1064
def iter_conflicts(self):
1065
"""List all files in the tree that have text or content conflicts.
1066
DEPRECATED. Use conflicts instead."""
1067
return self._iter_conflicts()
1069
def _iter_conflicts(self):
1071
for info in self.list_files():
1073
stem = get_conflicted_stem(path)
1076
if stem not in conflicted:
1077
conflicted.add(stem)
1081
def pull(self, source, overwrite=False, stop_revision=None):
1082
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1085
pp = ProgressPhase("Pull phase", 2, top_pb)
1087
old_revision_history = self.branch.revision_history()
1088
basis_tree = self.basis_tree()
1089
count = self.branch.pull(source, overwrite, stop_revision)
1090
new_revision_history = self.branch.revision_history()
1091
if new_revision_history != old_revision_history:
1093
if len(old_revision_history):
1094
other_revision = old_revision_history[-1]
1096
other_revision = None
1097
repository = self.branch.repository
1098
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1100
new_basis_tree = self.branch.basis_tree()
1101
merge_inner(self.branch,
1108
# TODO - dedup parents list with things merged by pull ?
1109
# reuse the revisiontree we merged against to set the new
1111
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1112
# we have to pull the merge trees out again, because
1113
# merge_inner has set the ids. - this corner is not yet
1114
# layered well enough to prevent double handling.
1115
merges = self.get_parent_ids()[1:]
1116
parent_trees.extend([
1117
(parent, repository.revision_tree(parent)) for
1119
self.set_parent_trees(parent_trees)
1126
def put_file_bytes_non_atomic(self, file_id, bytes):
1127
"""See MutableTree.put_file_bytes_non_atomic."""
1128
stream = file(self.id2abspath(file_id), 'wb')
1133
# TODO: update the hashcache here ?
197
1135
def extras(self):
198
1136
"""Yield all unknown files in this WorkingTree.
265
1281
# treat dotfiles correctly and allows * to match /.
266
1282
# Eventually it should be replaced with something more
269
for pat in self.get_ignore_list():
270
if '/' in pat or '\\' in pat:
272
# as a special case, you can put ./ at the start of a
273
# pattern; this is good to match in the top-level
276
if (pat[:2] == './') or (pat[:2] == '.\\'):
1285
rules = self._get_ignore_rules_as_regex()
1286
for regex, mapping in rules:
1287
match = regex.match(filename)
1288
if match is not None:
1289
# one or more of the groups in mapping will have a non-None
1291
groups = match.groups()
1292
rules = [mapping[group] for group in
1293
mapping if groups[group] is not None]
1297
def kind(self, file_id):
1298
return file_kind(self.id2abspath(file_id))
1301
def last_revision(self):
1302
"""Return the last revision of the branch for this tree.
1304
This format tree does not support a separate marker for last-revision
1305
compared to the branch.
1307
See MutableTree.last_revision
1309
return self.branch.last_revision()
1311
def is_locked(self):
1312
return self._control_files.is_locked()
1314
def lock_read(self):
1315
"""See Branch.lock_read, and WorkingTree.unlock."""
1316
self.branch.lock_read()
1318
return self._control_files.lock_read()
1320
self.branch.unlock()
1323
def lock_write(self):
1324
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1325
self.branch.lock_write()
1327
return self._control_files.lock_write()
1329
self.branch.unlock()
1332
def get_physical_lock_status(self):
1333
return self._control_files.get_physical_lock_status()
1335
def _basis_inventory_name(self):
1336
return 'basis-inventory'
1339
def set_last_revision(self, new_revision):
1340
"""Change the last revision in the working tree."""
1341
if self._change_last_revision(new_revision):
1342
self._cache_basis_inventory(new_revision)
1344
def _change_last_revision(self, new_revision):
1345
"""Template method part of set_last_revision to perform the change.
1347
This is used to allow WorkingTree3 instances to not affect branch
1348
when their last revision is set.
1350
if new_revision is None:
1351
self.branch.set_revision_history([])
1354
self.branch.generate_revision_history(new_revision)
1355
except errors.NoSuchRevision:
1356
# not present in the repo - dont try to set it deeper than the tip
1357
self.branch.set_revision_history([new_revision])
1360
def _cache_basis_inventory(self, new_revision):
1361
"""Cache new_revision as the basis inventory."""
1362
# TODO: this should allow the ready-to-use inventory to be passed in,
1363
# as commit already has that ready-to-use [while the format is the
1366
# this double handles the inventory - unpack and repack -
1367
# but is easier to understand. We can/should put a conditional
1368
# in here based on whether the inventory is in the latest format
1369
# - perhaps we should repack all inventories on a repository
1371
# the fast path is to copy the raw xml from the repository. If the
1372
# xml contains 'revision_id="', then we assume the right
1373
# revision_id is set. We must check for this full string, because a
1374
# root node id can legitimately look like 'revision_id' but cannot
1376
xml = self.branch.repository.get_inventory_xml(new_revision)
1377
if not 'revision_id="' in xml.split('\n', 1)[0]:
1378
inv = self.branch.repository.deserialise_inventory(
1380
inv.revision_id = new_revision
1381
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1382
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1383
path = self._basis_inventory_name()
1385
self._control_files.put(path, sio)
1386
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1389
def read_basis_inventory(self):
1390
"""Read the cached basis inventory."""
1391
path = self._basis_inventory_name()
1392
return self._control_files.get(path).read()
1395
def read_working_inventory(self):
1396
"""Read the working inventory."""
1397
# ElementTree does its own conversion from UTF-8, so open in
1399
result = bzrlib.xml5.serializer_v5.read_inventory(
1400
self._control_files.get('inventory'))
1401
self._set_inventory(result)
1405
def remove(self, files, verbose=False, to_file=None):
1406
"""Remove nominated files from the working inventory..
1408
This does not remove their text. This does not run on XXX on what? RBC
1410
TODO: Refuse to remove modified files unless --force is given?
1412
TODO: Do something useful with directories.
1414
TODO: Should this remove the text or not? Tough call; not
1415
removing may be useful and the user can just use use rm, and
1416
is the opposite of add. Removing it is consistent with most
1417
other tools. Maybe an option.
1419
## TODO: Normalize names
1420
## TODO: Remove nested loops; better scalability
1421
if isinstance(files, basestring):
1424
inv = self.inventory
1426
# do this before any modifications
1428
fid = inv.path2id(f)
1430
# TODO: Perhaps make this just a warning, and continue?
1431
# This tends to happen when
1432
raise NotVersionedError(path=f)
1434
# having remove it, it must be either ignored or unknown
1435
if self.is_ignored(f):
280
if fnmatch.fnmatchcase(filename, newpat):
1439
show_status(new_status, inv[fid].kind, f, to_file=to_file)
1442
self._write_inventory(inv)
1445
def revert(self, filenames, old_tree=None, backups=True,
1446
pb=DummyProgress()):
1447
from transform import revert
1448
from conflicts import resolve
1449
if old_tree is None:
1450
old_tree = self.basis_tree()
1451
conflicts = revert(self, old_tree, filenames, backups, pb)
1452
if not len(filenames):
1453
self.set_parent_ids(self.get_parent_ids()[:1])
1456
resolve(self, filenames, ignore_misses=True)
1459
# XXX: This method should be deprecated in favour of taking in a proper
1460
# new Inventory object.
1462
def set_inventory(self, new_inventory_list):
1463
from bzrlib.inventory import (Inventory,
1468
inv = Inventory(self.get_root_id())
1469
for path, file_id, parent, kind in new_inventory_list:
1470
name = os.path.basename(path)
1473
# fixme, there should be a factory function inv,add_??
1474
if kind == 'directory':
1475
inv.add(InventoryDirectory(file_id, name, parent))
1476
elif kind == 'file':
1477
inv.add(InventoryFile(file_id, name, parent))
1478
elif kind == 'symlink':
1479
inv.add(InventoryLink(file_id, name, parent))
283
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1481
raise BzrError("unknown kind %r" % kind)
1482
self._write_inventory(inv)
1485
def set_root_id(self, file_id):
1486
"""Set the root id for this tree."""
1487
inv = self.read_working_inventory()
1488
orig_root_id = inv.root.file_id
1489
del inv._byid[inv.root.file_id]
1490
inv.root.file_id = file_id
1491
inv._byid[inv.root.file_id] = inv.root
1494
if entry.parent_id == orig_root_id:
1495
entry.parent_id = inv.root.file_id
1496
self._write_inventory(inv)
1499
"""See Branch.unlock.
1501
WorkingTree locking just uses the Branch locking facilities.
1502
This is current because all working trees have an embedded branch
1503
within them. IF in the future, we were to make branch data shareable
1504
between multiple working trees, i.e. via shared storage, then we
1505
would probably want to lock both the local tree, and the branch.
1507
raise NotImplementedError(self.unlock)
1511
"""Update a working tree along its branch.
1513
This will update the branch if its bound too, which means we have multiple trees involved:
1514
The new basis tree of the master.
1515
The old basis tree of the branch.
1516
The old basis tree of the working tree.
1517
The current working tree state.
1518
pathologically all three may be different, and non ancestors of each other.
1519
Conceptually we want to:
1520
Preserve the wt.basis->wt.state changes
1521
Transform the wt.basis to the new master basis.
1522
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1523
Restore the wt.basis->wt.state changes.
1525
There isn't a single operation at the moment to do that, so we:
1526
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1527
Do a 'normal' merge of the old branch basis if it is relevant.
1529
old_tip = self.branch.update()
1530
# here if old_tip is not None, it is the old tip of the branch before
1531
# it was updated from the master branch. This should become a pending
1532
# merge in the working tree to preserve the user existing work. we
1533
# cant set that until we update the working trees last revision to be
1534
# one from the new branch, because it will just get absorbed by the
1535
# parent de-duplication logic.
1537
# We MUST save it even if an error occurs, because otherwise the users
1538
# local work is unreferenced and will appear to have been lost.
1541
if self.last_revision() != self.branch.last_revision():
1542
# merge tree state up to new branch tip.
1543
basis = self.basis_tree()
1544
to_tree = self.branch.basis_tree()
1545
result += merge_inner(self.branch,
1549
# TODO - dedup parents list with things merged by pull ?
1550
# reuse the tree we've updated to to set the basis:
1551
parent_trees = [(self.branch.last_revision(), to_tree)]
1552
merges = self.get_parent_ids()[1:]
1553
# Ideally we ask the tree for the trees here, that way the working
1554
# tree can decide whether to give us teh entire tree or give us a
1555
# lazy initialised tree. dirstate for instance will have the trees
1556
# in ram already, whereas a last-revision + basis-inventory tree
1557
# will not, but also does not need them when setting parents.
1558
for parent in merges:
1559
parent_trees.append(
1560
(parent, self.branch.repository.revision_tree(parent)))
1561
if old_tip is not None:
1562
parent_trees.append(
1563
(old_tip, self.branch.repository.revision_tree(old_tip)))
1564
self.set_parent_trees(parent_trees)
1566
# the working tree had the same last-revision as the master
1567
# branch did. We may still have pivot local work from the local
1568
# branch into old_tip:
1569
if old_tip is not None:
1570
self.add_parent_tree_id(old_tip)
1571
if old_tip and old_tip != self.last_revision():
1572
# our last revision was not the prior branch last revision
1573
# and we have converted that last revision to a pending merge.
1574
# base is somewhere between the branch tip now
1575
# and the now pending merge
1576
from bzrlib.revision import common_ancestor
1578
base_rev_id = common_ancestor(self.branch.last_revision(),
1580
self.branch.repository)
1581
except errors.NoCommonAncestor:
1583
base_tree = self.branch.repository.revision_tree(base_rev_id)
1584
other_tree = self.branch.repository.revision_tree(old_tip)
1585
result += merge_inner(self.branch,
1592
def _write_inventory(self, inv):
1593
"""Write inventory as the current inventory."""
1595
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1597
self._control_files.put('inventory', sio)
1598
self._set_inventory(inv)
1599
mutter('wrote working inventory')
1601
def set_conflicts(self, arg):
1602
raise UnsupportedOperation(self.set_conflicts, self)
1604
def add_conflicts(self, arg):
1605
raise UnsupportedOperation(self.add_conflicts, self)
1608
def conflicts(self):
1609
conflicts = ConflictList()
1610
for conflicted in self._iter_conflicts():
1613
if file_kind(self.abspath(conflicted)) != "file":
1615
except errors.NoSuchFile:
1618
for suffix in ('.THIS', '.OTHER'):
1620
kind = file_kind(self.abspath(conflicted+suffix))
1623
except errors.NoSuchFile:
1627
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1628
conflicts.append(Conflict.factory(ctype, path=conflicted,
1629
file_id=self.path2id(conflicted)))
1633
class WorkingTree2(WorkingTree):
1634
"""This is the Format 2 working tree.
1636
This was the first weave based working tree.
1637
- uses os locks for locking.
1638
- uses the branch last-revision.
1642
# we share control files:
1643
if self._hashcache.needs_write and self._control_files._lock_count==3:
1644
self._hashcache.write()
1645
# reverse order of locking.
1647
return self._control_files.unlock()
1649
self.branch.unlock()
1652
class WorkingTree3(WorkingTree):
1653
"""This is the Format 3 working tree.
1655
This differs from the base WorkingTree by:
1656
- having its own file lock
1657
- having its own last-revision property.
1659
This is new in bzr 0.8
1663
def last_revision(self):
1664
"""See Mutable.last_revision."""
1666
return self._control_files.get_utf8('last-revision').read()
1670
def _change_last_revision(self, revision_id):
1671
"""See WorkingTree._change_last_revision."""
1672
if revision_id is None or revision_id == NULL_REVISION:
1674
self._control_files._transport.delete('last-revision')
1675
except errors.NoSuchFile:
1679
self._control_files.put_utf8('last-revision', revision_id)
1683
def set_conflicts(self, conflicts):
1684
self._put_rio('conflicts', conflicts.to_stanzas(),
1688
def add_conflicts(self, new_conflicts):
1689
conflict_set = set(self.conflicts())
1690
conflict_set.update(set(list(new_conflicts)))
1691
self.set_conflicts(ConflictList(sorted(conflict_set,
1692
key=Conflict.sort_key)))
1695
def conflicts(self):
1697
confile = self._control_files.get('conflicts')
1699
return ConflictList()
1701
if confile.next() != CONFLICT_HEADER_1 + '\n':
1702
raise ConflictFormatError()
1703
except StopIteration:
1704
raise ConflictFormatError()
1705
return ConflictList.from_stanzas(RioReader(confile))
1708
if self._hashcache.needs_write and self._control_files._lock_count==1:
1709
self._hashcache.write()
1710
# reverse order of locking.
1712
return self._control_files.unlock()
1714
self.branch.unlock()
1717
def get_conflicted_stem(path):
1718
for suffix in CONFLICT_SUFFIXES:
1719
if path.endswith(suffix):
1720
return path[:-len(suffix)]
1722
@deprecated_function(zero_eight)
1723
def is_control_file(filename):
1724
"""See WorkingTree.is_control_filename(filename)."""
1725
## FIXME: better check
1726
filename = normpath(filename)
1727
while filename != '':
1728
head, tail = os.path.split(filename)
1729
## mutter('check %r for control file' % ((head, tail),))
1732
if filename == head:
1738
class WorkingTreeFormat(object):
1739
"""An encapsulation of the initialization and open routines for a format.
1741
Formats provide three things:
1742
* An initialization routine,
1746
Formats are placed in an dict by their format string for reference
1747
during workingtree opening. Its not required that these be instances, they
1748
can be classes themselves with class methods - it simply depends on
1749
whether state is needed for a given format or not.
1751
Once a format is deprecated, just deprecate the initialize and open
1752
methods on the format class. Do not deprecate the object, as the
1753
object will be created every time regardless.
1756
_default_format = None
1757
"""The default format used for new trees."""
1760
"""The known formats."""
1763
def find_format(klass, a_bzrdir):
1764
"""Return the format for the working tree object in a_bzrdir."""
1766
transport = a_bzrdir.get_workingtree_transport(None)
1767
format_string = transport.get("format").read()
1768
return klass._formats[format_string]
1770
raise errors.NoWorkingTree(base=transport.base)
1772
raise errors.UnknownFormatError(format=format_string)
1775
def get_default_format(klass):
1776
"""Return the current default format."""
1777
return klass._default_format
1779
def get_format_string(self):
1780
"""Return the ASCII format string that identifies this format."""
1781
raise NotImplementedError(self.get_format_string)
1783
def get_format_description(self):
1784
"""Return the short description for this format."""
1785
raise NotImplementedError(self.get_format_description)
1787
def is_supported(self):
1788
"""Is this format supported?
1790
Supported formats can be initialized and opened.
1791
Unsupported formats may not support initialization or committing or
1792
some other features depending on the reason for not being supported.
1797
def register_format(klass, format):
1798
klass._formats[format.get_format_string()] = format
1801
def set_default_format(klass, format):
1802
klass._default_format = format
1805
def unregister_format(klass, format):
1806
assert klass._formats[format.get_format_string()] is format
1807
del klass._formats[format.get_format_string()]
1811
class WorkingTreeFormat2(WorkingTreeFormat):
1812
"""The second working tree format.
1814
This format modified the hash cache from the format 1 hash cache.
1817
def get_format_description(self):
1818
"""See WorkingTreeFormat.get_format_description()."""
1819
return "Working tree format 2"
1821
def stub_initialize_remote(self, control_files):
1822
"""As a special workaround create critical control files for a remote working tree
1824
This ensures that it can later be updated and dealt with locally,
1825
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1826
no working tree. (See bug #43064).
1830
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1832
control_files.put('inventory', sio)
1834
control_files.put_utf8('pending-merges', '')
1837
def initialize(self, a_bzrdir, revision_id=None):
1838
"""See WorkingTreeFormat.initialize()."""
1839
if not isinstance(a_bzrdir.transport, LocalTransport):
1840
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1841
branch = a_bzrdir.open_branch()
1842
if revision_id is not None:
1845
revision_history = branch.revision_history()
1847
position = revision_history.index(revision_id)
1849
raise errors.NoSuchRevision(branch, revision_id)
1850
branch.set_revision_history(revision_history[:position + 1])
1853
revision = branch.last_revision()
1855
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1861
wt._write_inventory(inv)
1862
wt.set_root_id(inv.root.file_id)
1863
basis_tree = branch.repository.revision_tree(revision)
1864
wt.set_parent_trees([(revision, basis_tree)])
1865
build_tree(basis_tree, wt)
1869
super(WorkingTreeFormat2, self).__init__()
1870
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1872
def open(self, a_bzrdir, _found=False):
1873
"""Return the WorkingTree object for a_bzrdir
1875
_found is a private parameter, do not use it. It is used to indicate
1876
if format probing has already been done.
1879
# we are being called directly and must probe.
1880
raise NotImplementedError
1881
if not isinstance(a_bzrdir.transport, LocalTransport):
1882
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1883
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1889
class WorkingTreeFormat3(WorkingTreeFormat):
1890
"""The second working tree format updated to record a format marker.
1893
- exists within a metadir controlling .bzr
1894
- includes an explicit version marker for the workingtree control
1895
files, separate from the BzrDir format
1896
- modifies the hash cache format
1898
- uses a LockDir to guard access for writes.
1901
def get_format_string(self):
1902
"""See WorkingTreeFormat.get_format_string()."""
1903
return "Bazaar-NG Working Tree format 3"
1905
def get_format_description(self):
1906
"""See WorkingTreeFormat.get_format_description()."""
1907
return "Working tree format 3"
1909
_lock_file_name = 'lock'
1910
_lock_class = LockDir
1912
def _open_control_files(self, a_bzrdir):
1913
transport = a_bzrdir.get_workingtree_transport(None)
1914
return LockableFiles(transport, self._lock_file_name,
1917
def initialize(self, a_bzrdir, revision_id=None):
1918
"""See WorkingTreeFormat.initialize().
1920
revision_id allows creating a working tree at a different
1921
revision than the branch is at.
1923
if not isinstance(a_bzrdir.transport, LocalTransport):
1924
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1925
transport = a_bzrdir.get_workingtree_transport(self)
1926
control_files = self._open_control_files(a_bzrdir)
1927
control_files.create_lock()
1928
control_files.lock_write()
1929
control_files.put_utf8('format', self.get_format_string())
1930
branch = a_bzrdir.open_branch()
1931
if revision_id is None:
1932
revision_id = branch.last_revision()
1934
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1940
_control_files=control_files)
1943
wt._write_inventory(inv)
1944
wt.set_root_id(inv.root.file_id)
1945
basis_tree = branch.repository.revision_tree(revision_id)
1946
if revision_id == bzrlib.revision.NULL_REVISION:
1947
wt.set_parent_trees([])
1949
wt.set_parent_trees([(revision_id, basis_tree)])
1950
build_tree(basis_tree, wt)
1953
control_files.unlock()
1957
super(WorkingTreeFormat3, self).__init__()
1958
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1960
def open(self, a_bzrdir, _found=False):
1961
"""Return the WorkingTree object for a_bzrdir
1963
_found is a private parameter, do not use it. It is used to indicate
1964
if format probing has already been done.
1967
# we are being called directly and must probe.
1968
raise NotImplementedError
1969
if not isinstance(a_bzrdir.transport, LocalTransport):
1970
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1971
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
1973
def _open(self, a_bzrdir, control_files):
1974
"""Open the tree itself.
1976
:param a_bzrdir: the dir for the tree.
1977
:param control_files: the control files for the tree.
1979
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1983
_control_files=control_files)
1986
return self.get_format_string()
1989
# formats which have no format string are not discoverable
1990
# and not independently creatable, so are not registered.
1991
__default_format = WorkingTreeFormat3()
1992
WorkingTreeFormat.register_format(__default_format)
1993
WorkingTreeFormat.set_default_format(__default_format)
1994
_legacy_formats = [WorkingTreeFormat2(),
1998
class WorkingTreeTestProviderAdapter(object):
1999
"""A tool to generate a suite testing multiple workingtree formats at once.
2001
This is done by copying the test once for each transport and injecting
2002
the transport_server, transport_readonly_server, and workingtree_format
2003
classes into each copy. Each copy is also given a new id() to make it
2007
def __init__(self, transport_server, transport_readonly_server, formats):
2008
self._transport_server = transport_server
2009
self._transport_readonly_server = transport_readonly_server
2010
self._formats = formats
2012
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2013
"""Clone test for adaption."""
2014
new_test = deepcopy(test)
2015
new_test.transport_server = self._transport_server
2016
new_test.transport_readonly_server = self._transport_readonly_server
2017
new_test.bzrdir_format = bzrdir_format
2018
new_test.workingtree_format = workingtree_format
2019
def make_new_test_id():
2020
new_id = "%s(%s)" % (test.id(), variation)
2021
return lambda: new_id
2022
new_test.id = make_new_test_id()
2025
def adapt(self, test):
2026
from bzrlib.tests import TestSuite
2027
result = TestSuite()
2028
for workingtree_format, bzrdir_format in self._formats:
2029
new_test = self._clone_test(
2032
workingtree_format, workingtree_format.__class__.__name__)
2033
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
