1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
27
import xml.sax.saxutils
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
33
from cStringIO import StringIO
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
56
from bzrlib.textui import show_status
57
from bzrlib.trace import mutter, note
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
61
from bzrlib.store import copy_all
62
from bzrlib.symbol_versioning import *
63
import bzrlib.transactions as transactions
64
from bzrlib.transport import Transport, get_transport
65
from bzrlib.tree import EmptyTree, RevisionTree
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
75
# TODO: Maybe include checks for common corruption of newlines, etc?
77
# TODO: Some operations like log might retrieve the same revisions
78
# repeatedly to calculate deltas. We could perhaps have a weakref
79
# cache in memory to make this faster. In general anything can be
80
# cached in memory between lock and unlock operations. .. nb thats
81
# what the transaction identity map provides
84
######################################################################
88
"""Branch holding a history of revisions.
91
Base directory/url of the branch.
93
# this is really an instance variable - FIXME move it there
97
_default_initializer = None
98
"""The default initializer for making new branches."""
100
def __init__(self, *ignored, **ignored_too):
101
raise NotImplementedError('The Branch class is abstract')
104
def open_downlevel(base):
105
"""Open a branch which may be of an old format."""
106
return Branch.open(base, _unsupported=True)
109
def open(base, _unsupported=False):
110
"""Open an existing branch, rooted at 'base' (url)
112
_unsupported is a private parameter to the Branch class.
114
t = get_transport(base)
115
mutter("trying to open %r with transport %r", base, t)
116
format = BzrBranchFormat.find_format(t)
117
if not _unsupported and not format.is_supported():
118
# see open_downlevel to open legacy branches.
119
raise errors.UnsupportedFormatError(
120
'sorry, branch format %s not supported' % format,
121
['use a different bzr version',
122
'or remove the .bzr directory'
123
' and "bzr init" again'])
124
return format.open(t)
127
def open_containing(url):
128
"""Open an existing branch which contains url.
130
This probes for a branch at url, and searches upwards from there.
132
Basically we keep looking up until we find the control directory or
133
run into the root. If there isn't one, raises NotBranchError.
134
If there is one and it is either an unrecognised format or an unsupported
135
format, UnknownFormatError or UnsupportedFormatError are raised.
136
If there is one, it is returned, along with the unused portion of url.
138
t = get_transport(url)
139
# this gets the normalised url back. I.e. '.' -> the full path.
143
format = BzrBranchFormat.find_format(t)
144
return format.open(t), t.relpath(url)
145
except NotBranchError, e:
146
mutter('not a branch in: %r %s', t.base, e)
147
new_t = t.clone('..')
148
if new_t.base == t.base:
149
# reached the root, whatever that may be
150
raise NotBranchError(path=url)
155
"""Create a new Branch at the url 'bzr'.
157
This will call the current default initializer with base
158
as the only parameter.
160
return Branch._default_initializer(safe_unicode(base))
163
@deprecated_function(zero_eight)
164
def initialize(base):
165
"""Create a new working tree and branch, rooted at 'base' (url)
167
# imported here to prevent scope creep as this is going.
168
from bzrlib.workingtree import WorkingTree
169
return WorkingTree.create_standalone(safe_unicode(base)).branch
172
def get_default_initializer():
173
"""Return the initializer being used for new branches."""
174
return Branch._default_initializer
177
def set_default_initializer(initializer):
178
"""Set the initializer to be used for new branches."""
179
Branch._default_initializer = staticmethod(initializer)
181
def setup_caching(self, cache_root):
182
"""Subclasses that care about caching should override this, and set
183
up cached stores located under cache_root.
185
# seems to be unused, 2006-01-13 mbp
186
warn('%s is deprecated' % self.setup_caching)
187
self.cache_root = cache_root
190
cfg = self.tree_config()
191
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
193
def _set_nick(self, nick):
194
cfg = self.tree_config()
195
cfg.set_option(nick, "nickname")
196
assert cfg.get_option("nickname") == nick
198
nick = property(_get_nick, _set_nick)
200
def push_stores(self, branch_to):
201
"""Copy the content of this branches store to branch_to."""
202
raise NotImplementedError('push_stores is abstract')
204
def lock_write(self):
205
raise NotImplementedError('lock_write is abstract')
208
raise NotImplementedError('lock_read is abstract')
211
raise NotImplementedError('unlock is abstract')
213
def peek_lock_mode(self):
214
"""Return lock mode for the Branch: 'r', 'w' or None"""
215
raise NotImplementedError(self.peek_lock_mode)
217
def abspath(self, name):
218
"""Return absolute filename for something in the branch
220
XXX: Robert Collins 20051017 what is this used for? why is it a branch
221
method and not a tree method.
223
raise NotImplementedError('abspath is abstract')
225
def get_root_id(self):
226
"""Return the id of this branches root"""
227
raise NotImplementedError('get_root_id is abstract')
229
def print_file(self, file, revision_id):
230
"""Print `file` to stdout."""
231
raise NotImplementedError('print_file is abstract')
233
def append_revision(self, *revision_ids):
234
raise NotImplementedError('append_revision is abstract')
236
def set_revision_history(self, rev_history):
237
raise NotImplementedError('set_revision_history is abstract')
239
def revision_history(self):
240
"""Return sequence of revision hashes on to this branch."""
241
raise NotImplementedError('revision_history is abstract')
244
"""Return current revision number for this branch.
246
That is equivalent to the number of revisions committed to
249
return len(self.revision_history())
251
def last_revision(self):
252
"""Return last patch hash, or None if no history."""
253
ph = self.revision_history()
259
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
260
"""Return a list of new revisions that would perfectly fit.
262
If self and other have not diverged, return a list of the revisions
263
present in other, but missing from self.
265
>>> bzrlib.trace.silent = True
266
>>> br1 = ScratchBranch()
267
>>> br2 = ScratchBranch()
268
>>> br1.missing_revisions(br2)
270
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-1")
271
>>> br1.missing_revisions(br2)
273
>>> br2.missing_revisions(br1)
275
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-1")
276
>>> br1.missing_revisions(br2)
278
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-2A")
279
>>> br1.missing_revisions(br2)
281
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-2B")
282
>>> br1.missing_revisions(br2)
283
Traceback (most recent call last):
284
DivergedBranches: These branches have diverged. Try merge.
286
self_history = self.revision_history()
287
self_len = len(self_history)
288
other_history = other.revision_history()
289
other_len = len(other_history)
290
common_index = min(self_len, other_len) -1
291
if common_index >= 0 and \
292
self_history[common_index] != other_history[common_index]:
293
raise DivergedBranches(self, other)
295
if stop_revision is None:
296
stop_revision = other_len
298
assert isinstance(stop_revision, int)
299
if stop_revision > other_len:
300
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
301
return other_history[self_len:stop_revision]
303
def update_revisions(self, other, stop_revision=None):
304
"""Pull in new perfect-fit revisions."""
305
raise NotImplementedError('update_revisions is abstract')
307
def pullable_revisions(self, other, stop_revision):
308
raise NotImplementedError('pullable_revisions is abstract')
310
def revision_id_to_revno(self, revision_id):
311
"""Given a revision id, return its revno"""
312
if revision_id is None:
314
history = self.revision_history()
316
return history.index(revision_id) + 1
318
raise bzrlib.errors.NoSuchRevision(self, revision_id)
320
def get_rev_id(self, revno, history=None):
321
"""Find the revision id of the specified revno."""
325
history = self.revision_history()
326
elif revno <= 0 or revno > len(history):
327
raise bzrlib.errors.NoSuchRevision(self, revno)
328
return history[revno - 1]
330
def working_tree(self):
331
"""Return a `Tree` for the working copy if this is a local branch."""
332
raise NotImplementedError('working_tree is abstract')
334
def pull(self, source, overwrite=False):
335
raise NotImplementedError('pull is abstract')
337
def basis_tree(self):
338
"""Return `Tree` object for last revision.
340
If there are no revisions yet, return an `EmptyTree`.
342
return self.repository.revision_tree(self.last_revision())
344
def rename_one(self, from_rel, to_rel):
347
This can change the directory or the filename or both.
349
raise NotImplementedError('rename_one is abstract')
351
def move(self, from_paths, to_name):
354
to_name must exist as a versioned directory.
356
If to_name exists and is a directory, the files are moved into
357
it, keeping their old names. If it is a directory,
359
Note that to_name is only the last component of the new name;
360
this doesn't change the directory.
362
This returns a list of (from_path, to_path) pairs for each
365
raise NotImplementedError('move is abstract')
367
def get_parent(self):
368
"""Return the parent location of the branch.
370
This is the default location for push/pull/missing. The usual
371
pattern is that the user can override it by specifying a
374
raise NotImplementedError('get_parent is abstract')
376
def get_push_location(self):
377
"""Return the None or the location to push this branch to."""
378
raise NotImplementedError('get_push_location is abstract')
380
def set_push_location(self, location):
381
"""Set a new push location for this branch."""
382
raise NotImplementedError('set_push_location is abstract')
384
def set_parent(self, url):
385
raise NotImplementedError('set_parent is abstract')
387
def check_revno(self, revno):
389
Check whether a revno corresponds to any revision.
390
Zero (the NULL revision) is considered valid.
393
self.check_real_revno(revno)
395
def check_real_revno(self, revno):
397
Check whether a revno corresponds to a real revision.
398
Zero (the NULL revision) is considered invalid
400
if revno < 1 or revno > self.revno():
401
raise InvalidRevisionNumber(revno)
403
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
404
"""Copy this branch into the existing directory to_location.
406
Returns the newly created branch object.
409
If not None, only revisions up to this point will be copied.
410
The head of the new branch will be that revision. Must be a
413
to_location -- The destination directory; must either exist and be
414
empty, or not exist, in which case it is created.
417
A local branch to copy revisions from, related to this branch.
418
This is used when branching from a remote (slow) branch, and we have
419
a local branch that might contain some relevant revisions.
422
Branch type of destination branch
424
from bzrlib.workingtree import WorkingTree
425
assert isinstance(to_location, basestring)
426
if not bzrlib.osutils.lexists(to_location):
427
os.mkdir(to_location)
428
if to_branch_type is None:
429
to_branch_type = BzrBranch
430
print "FIXME use a branch format here"
431
br_to = to_branch_type.initialize(to_location)
432
mutter("copy branch from %s to %s", self, br_to)
433
if basis_branch is not None:
434
basis_branch.push_stores(br_to)
436
revision = self.last_revision()
437
br_to.update_revisions(self, stop_revision=revision)
438
br_to.set_parent(self.base)
439
WorkingTree.create(br_to, to_location).set_root_id(self.get_root_id())
443
def fileid_involved_between_revs(self, from_revid, to_revid):
444
""" This function returns the file_id(s) involved in the
445
changes between the from_revid revision and the to_revid
448
raise NotImplementedError('fileid_involved_between_revs is abstract')
450
def fileid_involved(self, last_revid=None):
451
""" This function returns the file_id(s) involved in the
452
changes up to the revision last_revid
453
If no parametr is passed, then all file_id[s] present in the
454
repository are returned
456
raise NotImplementedError('fileid_involved is abstract')
458
def fileid_involved_by_set(self, changes):
459
""" This function returns the file_id(s) involved in the
460
changes present in the set 'changes'
462
raise NotImplementedError('fileid_involved_by_set is abstract')
464
def fileid_involved_between_revs(self, from_revid, to_revid):
465
""" This function returns the file_id(s) involved in the
466
changes between the from_revid revision and the to_revid
469
raise NotImplementedError('fileid_involved_between_revs is abstract')
471
def fileid_involved(self, last_revid=None):
472
""" This function returns the file_id(s) involved in the
473
changes up to the revision last_revid
474
If no parametr is passed, then all file_id[s] present in the
475
repository are returned
477
raise NotImplementedError('fileid_involved is abstract')
479
def fileid_involved_by_set(self, changes):
480
""" This function returns the file_id(s) involved in the
481
changes present in the set 'changes'
483
raise NotImplementedError('fileid_involved_by_set is abstract')
485
class BzrBranchFormat(object):
486
"""An encapsulation of the initialization and open routines for a format.
488
Formats provide three things:
489
* An initialization routine,
493
Formats are placed in an dict by their format string for reference
494
during branch opening. Its not required that these be instances, they
495
can be classes themselves with class methods - it simply depends on
496
whether state is needed for a given format or not.
498
Once a format is deprecated, just deprecate the initialize and open
499
methods on the format class. Do not deprecate the object, as the
500
object will be created every time regardless.
504
"""The known formats."""
507
def find_format(klass, transport):
508
"""Return the format registered for URL."""
510
format_string = transport.get(".bzr/branch-format").read()
511
return klass._formats[format_string]
513
raise NotBranchError(path=transport.base)
515
raise errors.UnknownFormatError(format_string)
517
def get_format_string(self):
518
"""Return the ASCII format string that identifies this format."""
519
raise NotImplementedError(self.get_format_string)
521
def _find_modes(self, t):
522
"""Determine the appropriate modes for files and directories.
524
FIXME: When this merges into, or from storage,
525
this code becomes delgatable to a LockableFiles instance.
527
For now its cribbed and returns (dir_mode, file_mode)
531
except errors.TransportNotPossible:
535
dir_mode = st.st_mode & 07777
536
# Remove the sticky and execute bits for files
537
file_mode = dir_mode & ~07111
538
if not BzrBranch._set_dir_mode:
540
if not BzrBranch._set_file_mode:
542
return dir_mode, file_mode
544
def initialize(self, url):
545
"""Create a branch of this format at url and return an open branch."""
546
t = get_transport(url)
547
from bzrlib.weavefile import write_weave_v5
548
from bzrlib.weave import Weave
550
# Create an empty weave
552
bzrlib.weavefile.write_weave_v5(Weave(), sio)
553
empty_weave = sio.getvalue()
555
# Since we don't have a .bzr directory, inherit the
556
# mode from the root directory
557
temp_control = LockableFiles(t, '')
558
temp_control._transport.mkdir('.bzr',
559
mode=temp_control._dir_mode)
560
file_mode = temp_control._file_mode
562
mutter('created control directory in ' + t.base)
563
control = t.clone('.bzr')
564
dirs = ['revision-store', 'weaves']
565
lock_file = 'branch-lock'
566
utf8_files = [('README',
567
"This is a Bazaar-NG control directory.\n"
568
"Do not change any files in this directory.\n"),
569
('branch-format', self.get_format_string()),
570
('revision-history', ''),
573
files = [('inventory.weave', StringIO(empty_weave)),
576
# FIXME: RBC 20060125 dont peek under the covers
577
# NB: no need to escape relative paths that are url safe.
578
control.put(lock_file, StringIO(), mode=file_mode)
579
control_files = LockableFiles(control, lock_file)
580
control_files.lock_write()
581
control_files._transport.mkdir_multi(dirs,
582
mode=control_files._dir_mode)
584
for file, content in utf8_files:
585
control_files.put_utf8(file, content)
586
for file, content in files:
587
control_files.put(file, content)
589
control_files.unlock()
590
return BzrBranch(t, _format=self, _control_files=control_files)
592
def is_supported(self):
593
"""Is this format supported?
595
Supported formats can be initialized and opened.
596
Unsupported formats may not support initialization or committing or
597
some other features depending on the reason for not being supported.
601
def open(self, transport):
602
"""Fill out the data in branch for the branch at url."""
603
return BzrBranch(transport, _format=self)
606
def register_format(klass, format):
607
klass._formats[format.get_format_string()] = format
610
def unregister_format(klass, format):
611
assert klass._formats[format.get_format_string()] is format
612
del klass._formats[format.get_format_string()]
615
class BzrBranchFormat4(BzrBranchFormat):
616
"""Bzr branch format 4.
620
- TextStores for texts, inventories,revisions.
622
This format is deprecated: it indexes texts using a text it which is
623
removed in format 5; write support for this format has been removed.
626
def get_format_string(self):
627
"""See BzrBranchFormat.get_format_string()."""
628
return BZR_BRANCH_FORMAT_4
630
def initialize(self, url):
631
"""Format 4 branches cannot be created."""
632
raise UninitializableFormat(self)
634
def is_supported(self):
635
"""Format 4 is not supported.
637
It is not supported because the model changed from 4 to 5 and the
638
conversion logic is expensive - so doing it on the fly was not
644
class BzrBranchFormat5(BzrBranchFormat):
645
"""Bzr branch format 5.
648
- weaves for file texts and inventory
650
- TextStores for revisions and signatures.
653
def get_format_string(self):
654
"""See BzrBranchFormat.get_format_string()."""
655
return BZR_BRANCH_FORMAT_5
658
class BzrBranchFormat6(BzrBranchFormat):
659
"""Bzr branch format 6.
662
- weaves for file texts and inventory
663
- hash subdirectory based stores.
664
- TextStores for revisions and signatures.
667
def get_format_string(self):
668
"""See BzrBranchFormat.get_format_string()."""
669
return BZR_BRANCH_FORMAT_6
672
BzrBranchFormat.register_format(BzrBranchFormat4())
673
BzrBranchFormat.register_format(BzrBranchFormat5())
674
BzrBranchFormat.register_format(BzrBranchFormat6())
676
# TODO: jam 20060108 Create a new branch format, and as part of upgrade
677
# make sure that ancestry.weave is deleted (it is never used, but
678
# used to be created)
681
class BzrBranch(Branch):
682
"""A branch stored in the actual filesystem.
684
Note that it's "local" in the context of the filesystem; it doesn't
685
really matter if it's on an nfs/smb/afs/coda/... share, as long as
686
it's writable, and can be accessed via the normal filesystem API.
689
# We actually expect this class to be somewhat short-lived; part of its
690
# purpose is to try to isolate what bits of the branch logic are tied to
691
# filesystem access, so that in a later step, we can extricate them to
692
# a separarte ("storage") class.
693
_inventory_weave = None
695
# Map some sort of prefix into a namespace
696
# stuff like "revno:10", "revid:", etc.
697
# This should match a prefix with a function which accepts
698
REVISION_NAMESPACES = {}
700
def push_stores(self, branch_to):
701
"""See Branch.push_stores."""
702
if (not isinstance(self._branch_format, BzrBranchFormat4) or
703
self._branch_format != branch_to._branch_format):
704
from bzrlib.fetch import greedy_fetch
705
mutter("Using fetch logic to push between %s(%s) and %s(%s)",
706
self, self._branch_format, branch_to, branch_to._branch_format)
707
greedy_fetch(to_branch=branch_to, from_branch=self,
708
revision=self.last_revision())
711
# format 4 to format 4 logic only.
712
store_pairs = ((self.text_store, branch_to.text_store),
713
(self.inventory_store, branch_to.inventory_store),
714
(self.revision_store, branch_to.revision_store))
716
for from_store, to_store in store_pairs:
717
copy_all(from_store, to_store)
718
except UnlistableStore:
719
raise UnlistableBranch(from_store)
721
def __init__(self, transport, init=DEPRECATED_PARAMETER,
722
relax_version_check=DEPRECATED_PARAMETER, _format=None,
723
_control_files=None):
724
"""Create new branch object at a particular location.
726
transport -- A Transport object, defining how to access files.
728
init -- If True, create new control files in a previously
729
unversioned directory. If False, the branch must already
732
relax_version_check -- If true, the usual check for the branch
733
version is not applied. This is intended only for
734
upgrade/recovery type use; it's not guaranteed that
735
all operations will work on old format branches.
737
In the test suite, creation of new trees is tested using the
738
`ScratchBranch` class.
740
assert isinstance(transport, Transport), \
741
"%r is not a Transport" % transport
742
self._transport = transport
743
self._base = self._transport.base
744
if _control_files is None:
745
_control_files = LockableFiles(self._transport.clone(bzrlib.BZRDIR),
747
self.control_files = _control_files
748
if deprecated_passed(init):
749
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
750
"deprecated as of bzr 0.8. Please use Branch.create().",
754
# this is slower than before deprecation, oh well never mind.
756
self._initialize(transport.base)
757
self._check_format(_format)
758
if deprecated_passed(relax_version_check):
759
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
760
"relax_version_check parameter is deprecated as of bzr 0.8. "
761
"Please use Branch.open_downlevel, or a BzrBranchFormat's "
765
if (not relax_version_check
766
and not self._branch_format.is_supported()):
767
raise errors.UnsupportedFormatError(
768
'sorry, branch format %r not supported' % fmt,
769
['use a different bzr version',
770
'or remove the .bzr directory'
771
' and "bzr init" again'])
772
self.repository = Repository(transport, self._branch_format)
776
def _initialize(base):
777
"""Create a bzr branch in the latest format."""
778
return BzrBranchFormat6().initialize(base)
781
return '%s(%r)' % (self.__class__.__name__, self.base)
786
# TODO: It might be best to do this somewhere else,
787
# but it is nice for a Branch object to automatically
788
# cache it's information.
789
# Alternatively, we could have the Transport objects cache requests
790
# See the earlier discussion about how major objects (like Branch)
791
# should never expect their __del__ function to run.
792
# XXX: cache_root seems to be unused, 2006-01-13 mbp
793
if hasattr(self, 'cache_root') and self.cache_root is not None:
795
shutil.rmtree(self.cache_root)
798
self.cache_root = None
803
base = property(_get_base, doc="The URL for the root of this branch.")
805
def _finish_transaction(self):
806
"""Exit the current transaction."""
807
return self.control_files._finish_transaction()
809
def get_transaction(self):
810
"""Return the current active transaction.
812
If no transaction is active, this returns a passthrough object
813
for which all data is immediately flushed and no caching happens.
815
# this is an explicit function so that we can do tricky stuff
816
# when the storage in rev_storage is elsewhere.
817
# we probably need to hook the two 'lock a location' and
818
# 'have a transaction' together more delicately, so that
819
# we can have two locks (branch and storage) and one transaction
820
# ... and finishing the transaction unlocks both, but unlocking
821
# does not. - RBC 20051121
822
return self.control_files.get_transaction()
824
def _set_transaction(self, transaction):
825
"""Set a new active transaction."""
826
return self.control_files._set_transaction(transaction)
828
def abspath(self, name):
829
"""See Branch.abspath."""
830
return self.control_files._transport.abspath(name)
832
def _check_format(self, format):
833
"""Identify the branch format if needed.
835
The format is stored as a reference to the format object in
836
self._branch_format for code that needs to check it later.
838
The format parameter is either None or the branch format class
839
used to open this branch.
842
format = BzrBranchFormat.find_format(self._transport)
843
self._branch_format = format
844
mutter("got branch format %s", self._branch_format)
847
def get_root_id(self):
848
"""See Branch.get_root_id."""
849
tree = self.repository.revision_tree(self.last_revision())
850
return tree.inventory.root.file_id
852
def lock_write(self):
853
# TODO: test for failed two phase locks. This is known broken.
854
self.control_files.lock_write()
855
self.repository.lock_write()
858
# TODO: test for failed two phase locks. This is known broken.
859
self.control_files.lock_read()
860
self.repository.lock_read()
863
# TODO: test for failed two phase locks. This is known broken.
864
self.repository.unlock()
865
self.control_files.unlock()
867
def peek_lock_mode(self):
868
if self.control_files._lock_count == 0:
871
return self.control_files._lock_mode
874
def print_file(self, file, revision_id):
875
"""See Branch.print_file."""
876
return self.repository.print_file(file, revision_id)
879
def append_revision(self, *revision_ids):
880
"""See Branch.append_revision."""
881
for revision_id in revision_ids:
882
mutter("add {%s} to revision-history" % revision_id)
883
rev_history = self.revision_history()
884
rev_history.extend(revision_ids)
885
self.set_revision_history(rev_history)
888
def set_revision_history(self, rev_history):
889
"""See Branch.set_revision_history."""
890
self.control_files.put_utf8(
891
'revision-history', '\n'.join(rev_history))
893
def get_revision_delta(self, revno):
894
"""Return the delta for one revision.
896
The delta is relative to its mainline predecessor, or the
897
empty tree for revision 1.
899
assert isinstance(revno, int)
900
rh = self.revision_history()
901
if not (1 <= revno <= len(rh)):
902
raise InvalidRevisionNumber(revno)
904
# revno is 1-based; list is 0-based
906
new_tree = self.repository.revision_tree(rh[revno-1])
908
old_tree = EmptyTree()
910
old_tree = self.repository.revision_tree(rh[revno-2])
911
return compare_trees(old_tree, new_tree)
914
def revision_history(self):
915
"""See Branch.revision_history."""
916
# FIXME are transactions bound to control files ? RBC 20051121
917
transaction = self.get_transaction()
918
history = transaction.map.find_revision_history()
919
if history is not None:
920
mutter("cache hit for revision-history in %s", self)
922
history = [l.rstrip('\r\n') for l in
923
self.control_files.get_utf8('revision-history').readlines()]
924
transaction.map.add_revision_history(history)
925
# this call is disabled because revision_history is
926
# not really an object yet, and the transaction is for objects.
927
# transaction.register_clean(history, precious=True)
930
def update_revisions(self, other, stop_revision=None):
931
"""See Branch.update_revisions."""
932
from bzrlib.fetch import greedy_fetch
933
if stop_revision is None:
934
stop_revision = other.last_revision()
935
### Should this be checking is_ancestor instead of revision_history?
936
if (stop_revision is not None and
937
stop_revision in self.revision_history()):
939
greedy_fetch(to_branch=self, from_branch=other,
940
revision=stop_revision)
941
pullable_revs = self.pullable_revisions(other, stop_revision)
942
if len(pullable_revs) > 0:
943
self.append_revision(*pullable_revs)
945
def pullable_revisions(self, other, stop_revision):
946
"""See Branch.pullable_revisions."""
947
other_revno = other.revision_id_to_revno(stop_revision)
949
return self.missing_revisions(other, other_revno)
950
except DivergedBranches, e:
952
pullable_revs = get_intervening_revisions(self.last_revision(),
955
assert self.last_revision() not in pullable_revs
957
except bzrlib.errors.NotAncestor:
958
if is_ancestor(self.last_revision(), stop_revision, self):
963
def basis_tree(self):
964
"""See Branch.basis_tree."""
966
revision_id = self.revision_history()[-1]
967
# FIXME: This is an abstraction violation, the basis tree
968
# here as defined is on the working tree, the method should
969
# be too. The basis tree for a branch can be different than
970
# that for a working tree. RBC 20051207
971
xml = self.working_tree().read_basis_inventory(revision_id)
972
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
973
return RevisionTree(self.repository, inv, revision_id)
974
except (IndexError, NoSuchFile, NoWorkingTree), e:
975
return self.repository.revision_tree(self.last_revision())
977
def working_tree(self):
978
"""See Branch.working_tree."""
979
from bzrlib.workingtree import WorkingTree
980
from bzrlib.transport.local import LocalTransport
981
if (self.base.find('://') != -1 or
982
not isinstance(self._transport, LocalTransport)):
983
raise NoWorkingTree(self.base)
984
return WorkingTree(self.base, branch=self)
987
def pull(self, source, overwrite=False):
988
"""See Branch.pull."""
991
old_count = len(self.revision_history())
993
self.update_revisions(source)
994
except DivergedBranches:
998
self.set_revision_history(source.revision_history())
999
new_count = len(self.revision_history())
1000
return new_count - old_count
1004
def get_parent(self):
1005
"""See Branch.get_parent."""
1007
_locs = ['parent', 'pull', 'x-pull']
1010
return self.control_files.get_utf8(l).read().strip('\n')
1015
def get_push_location(self):
1016
"""See Branch.get_push_location."""
1017
config = bzrlib.config.BranchConfig(self)
1018
push_loc = config.get_user_option('push_location')
1021
def set_push_location(self, location):
1022
"""See Branch.set_push_location."""
1023
config = bzrlib.config.LocationConfig(self.base)
1024
config.set_user_option('push_location', location)
1027
def set_parent(self, url):
1028
"""See Branch.set_parent."""
1029
# TODO: Maybe delete old location files?
1030
# URLs should never be unicode, even on the local fs,
1031
# FIXUP this and get_parent in a future branch format bump:
1032
# read and rewrite the file, and have the new format code read
1033
# using .get not .get_utf8. RBC 20060125
1034
self.control_files.put_utf8('parent', url + '\n')
1036
def tree_config(self):
1037
return TreeConfig(self)
1039
def _get_truncated_history(self, revision_id):
1040
history = self.revision_history()
1041
if revision_id is None:
1044
idx = history.index(revision_id)
1046
raise InvalidRevisionId(revision_id=revision, branch=self)
1047
return history[:idx+1]
1050
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1052
from bzrlib.workingtree import WorkingTree
1053
assert isinstance(to_location, basestring)
1054
if basis_branch is not None:
1055
note("basis_branch is not supported for fast weave copy yet.")
1057
history = self._get_truncated_history(revision)
1058
if not bzrlib.osutils.lexists(to_location):
1059
os.mkdir(to_location)
1060
branch_to = Branch.initialize(to_location)
1061
mutter("copy branch from %s to %s", self, branch_to)
1063
self.repository.copy(branch_to.repository)
1065
# must be done *after* history is copied across
1066
# FIXME duplicate code with base .clone().
1067
# .. would template method be useful here? RBC 20051207
1068
branch_to.set_parent(self.base)
1069
branch_to.append_revision(*history)
1070
# FIXME: this should be in workingtree.clone
1071
WorkingTree.create(branch_to, to_location).set_root_id(self.get_root_id())
1075
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
1076
print "FIXME: clone via create and fetch is probably faster when versioned file comes in."
1077
if to_branch_type is None:
1078
to_branch_type = BzrBranch
1080
if to_branch_type == BzrBranch \
1081
and self.repository.weave_store.listable() \
1082
and self.repository.revision_store.listable():
1083
return self._clone_weave(to_location, revision, basis_branch)
1085
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
1087
def fileid_involved_between_revs(self, from_revid, to_revid):
1088
"""Find file_id(s) which are involved in the changes between revisions.
1090
This determines the set of revisions which are involved, and then
1091
finds all file ids affected by those revisions.
1093
# TODO: jam 20060119 This code assumes that w.inclusions will
1094
# always be correct. But because of the presence of ghosts
1095
# it is possible to be wrong.
1096
# One specific example from Robert Collins:
1097
# Two branches, with revisions ABC, and AD
1098
# C is a ghost merge of D.
1099
# Inclusions doesn't recognize D as an ancestor.
1100
# If D is ever merged in the future, the weave
1101
# won't be fixed, because AD never saw revision C
1102
# to cause a conflict which would force a reweave.
1103
w = self.repository.get_inventory_weave()
1104
from_set = set(w.inclusions([w.lookup(from_revid)]))
1105
to_set = set(w.inclusions([w.lookup(to_revid)]))
1106
included = to_set.difference(from_set)
1107
changed = map(w.idx_to_name, included)
1108
return self._fileid_involved_by_set(changed)
1110
def fileid_involved(self, last_revid=None):
1111
"""Find all file_ids modified in the ancestry of last_revid.
1113
:param last_revid: If None, last_revision() will be used.
1115
w = self.repository.get_inventory_weave()
1117
changed = set(w._names)
1119
included = w.inclusions([w.lookup(last_revid)])
1120
changed = map(w.idx_to_name, included)
1121
return self._fileid_involved_by_set(changed)
1123
def fileid_involved_by_set(self, changes):
1124
"""Find all file_ids modified by the set of revisions passed in.
1126
:param changes: A set() of revision ids
1128
# TODO: jam 20060119 This line does *nothing*, remove it.
1129
# or better yet, change _fileid_involved_by_set so
1130
# that it takes the inventory weave, rather than
1131
# pulling it out by itself.
1132
w = self.repository.get_inventory_weave()
1133
return self._fileid_involved_by_set(changes)
1135
def _fileid_involved_by_set(self, changes):
1136
"""Find the set of file-ids affected by the set of revisions.
1138
:param changes: A set() of revision ids.
1139
:return: A set() of file ids.
1141
This peaks at the Weave, interpreting each line, looking to
1142
see if it mentions one of the revisions. And if so, includes
1143
the file id mentioned.
1144
This expects both the Weave format, and the serialization
1145
to have a single line per file/directory, and to have
1146
fileid="" and revision="" on that line.
1148
assert (isinstance(self._branch_format, BzrBranchFormat5) or
1149
isinstance(self._branch_format, BzrBranchFormat6)), \
1150
"fileid_involved only supported for branches which store inventory as xml"
1152
w = self.repository.get_inventory_weave()
1154
for line in w._weave:
1156
# it is ugly, but it is due to the weave structure
1157
if not isinstance(line, basestring): continue
1159
start = line.find('file_id="')+9
1160
if start < 9: continue
1161
end = line.find('"', start)
1163
file_id = xml.sax.saxutils.unescape(line[start:end])
1165
# check if file_id is already present
1166
if file_id in file_ids: continue
1168
start = line.find('revision="')+10
1169
if start < 10: continue
1170
end = line.find('"', start)
1172
revision_id = xml.sax.saxutils.unescape(line[start:end])
1174
if revision_id in changes:
1175
file_ids.add(file_id)
1180
Branch.set_default_initializer(BzrBranch._initialize)
1183
class BranchTestProviderAdapter(object):
1184
"""A tool to generate a suite testing multiple branch formats at once.
1186
This is done by copying the test once for each transport and injecting
1187
the transport_server, transport_readonly_server, and branch_format
1188
classes into each copy. Each copy is also given a new id() to make it
1192
def __init__(self, transport_server, transport_readonly_server, formats):
1193
self._transport_server = transport_server
1194
self._transport_readonly_server = transport_readonly_server
1195
self._formats = formats
1197
def adapt(self, test):
1198
result = TestSuite()
1199
for format in self._formats:
1200
new_test = deepcopy(test)
1201
new_test.transport_server = self._transport_server
1202
new_test.transport_readonly_server = self._transport_readonly_server
1203
new_test.branch_format = format
1204
def make_new_test_id():
1205
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1206
return lambda: new_id
1207
new_test.id = make_new_test_id()
1208
result.addTest(new_test)
1212
class ScratchBranch(BzrBranch):
1213
"""Special test class: a branch that cleans up after itself.
1215
>>> b = ScratchBranch()
1219
>>> b._transport.__del__()
1224
def __init__(self, files=[], dirs=[], transport=None):
1225
"""Make a test branch.
1227
This creates a temporary directory and runs init-tree in it.
1229
If any files are listed, they are created in the working copy.
1231
if transport is None:
1232
transport = bzrlib.transport.local.ScratchTransport()
1233
# local import for scope restriction
1234
from bzrlib.workingtree import WorkingTree
1235
WorkingTree.create_standalone(transport.base)
1236
super(ScratchBranch, self).__init__(transport)
1238
super(ScratchBranch, self).__init__(transport)
1240
# BzrBranch creates a clone to .bzr and then forgets about the
1241
# original transport. A ScratchTransport() deletes itself and
1242
# everything underneath it when it goes away, so we need to
1243
# grab a local copy to prevent that from happening
1244
self._transport = transport
1247
self._transport.mkdir(d)
1250
self._transport.put(f, 'content of %s' % f)
1254
>>> orig = ScratchBranch(files=["file1", "file2"])
1255
>>> os.listdir(orig.base)
1256
[u'.bzr', u'file1', u'file2']
1257
>>> clone = orig.clone()
1258
>>> if os.name != 'nt':
1259
... os.path.samefile(orig.base, clone.base)
1261
... orig.base == clone.base
1264
>>> os.listdir(clone.base)
1265
[u'.bzr', u'file1', u'file2']
1267
from shutil import copytree
1268
from bzrlib.osutils import mkdtemp
1271
copytree(self.base, base, symlinks=True)
1272
return ScratchBranch(
1273
transport=bzrlib.transport.local.ScratchTransport(base))
1276
######################################################################
1280
def is_control_file(filename):
1281
## FIXME: better check
1282
filename = normpath(filename)
1283
while filename != '':
1284
head, tail = os.path.split(filename)
1285
## mutter('check %r for control file' % ((head, tail),))
1286
if tail == bzrlib.BZRDIR:
1288
if filename == head:
added
removed
bzrlib/branch.py
