1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError(self.abspath)
196
def bind(self, other):
197
"""Bind the local branch the other branch.
199
:param other: The branch to bind to
202
raise errors.UpgradeRequired(self.base)
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
211
:param pb: An optional progress bar to use.
213
Returns the copied revision count and the failed revisions in a tuple:
216
if self.base == from_branch.base:
219
nested_pb = ui.ui_factory.nested_progress_bar()
224
from_branch.lock_read()
226
if last_revision is None:
227
pb.update('get source history')
228
last_revision = from_branch.last_revision_info()[1]
229
return self.repository.fetch(from_branch.repository,
230
revision_id=last_revision,
233
if nested_pb is not None:
237
def get_bound_location(self):
238
"""Return the URL of the branch we are bound to.
240
Older format branches cannot bind, please be sure to use a metadir
245
def get_commit_builder(self, parents, config=None, timestamp=None,
246
timezone=None, committer=None, revprops=None,
248
"""Obtain a CommitBuilder for this branch.
250
:param parents: Revision ids of the parents of the new revision.
251
:param config: Optional configuration to use.
252
:param timestamp: Optional timestamp recorded for commit.
253
:param timezone: Optional timezone for timestamp.
254
:param committer: Optional committer to set for commit.
255
:param revprops: Optional dictionary of revision properties.
256
:param revision_id: Optional revision id.
260
config = self.get_config()
262
return self.repository.get_commit_builder(self, parents, config,
263
timestamp, timezone, committer, revprops, revision_id)
265
def get_master_branch(self):
266
"""Return the branch we are bound to.
268
:return: Either a Branch, or None
272
def get_revision_delta(self, revno):
273
"""Return the delta for one revision.
275
The delta is relative to its mainline predecessor, or the
276
empty tree for revision 1.
278
assert isinstance(revno, int)
279
rh = self.revision_history()
280
if not (1 <= revno <= len(rh)):
281
raise InvalidRevisionNumber(revno)
282
return self.repository.get_revision_delta(rh[revno-1])
284
def get_root_id(self):
285
"""Return the id of this branches root"""
286
raise NotImplementedError(self.get_root_id)
288
def print_file(self, file, revision_id):
289
"""Print `file` to stdout."""
290
raise NotImplementedError(self.print_file)
292
def append_revision(self, *revision_ids):
293
raise NotImplementedError(self.append_revision)
295
def set_revision_history(self, rev_history):
296
raise NotImplementedError(self.set_revision_history)
298
def revision_history(self):
299
"""Return sequence of revision hashes on to this branch."""
300
raise NotImplementedError(self.revision_history)
303
"""Return current revision number for this branch.
305
That is equivalent to the number of revisions committed to
308
return len(self.revision_history())
311
"""Older format branches cannot bind or unbind."""
312
raise errors.UpgradeRequired(self.base)
314
def last_revision(self):
315
"""Return last revision id, or None"""
316
ph = self.revision_history()
322
def last_revision_info(self):
323
"""Return information about the last revision.
325
:return: A tuple (revno, last_revision_id).
327
rh = self.revision_history()
330
return (revno, rh[-1])
332
return (0, _mod_revision.NULL_REVISION)
334
def missing_revisions(self, other, stop_revision=None):
335
"""Return a list of new revisions that would perfectly fit.
337
If self and other have not diverged, return a list of the revisions
338
present in other, but missing from self.
340
self_history = self.revision_history()
341
self_len = len(self_history)
342
other_history = other.revision_history()
343
other_len = len(other_history)
344
common_index = min(self_len, other_len) -1
345
if common_index >= 0 and \
346
self_history[common_index] != other_history[common_index]:
347
raise DivergedBranches(self, other)
349
if stop_revision is None:
350
stop_revision = other_len
352
assert isinstance(stop_revision, int)
353
if stop_revision > other_len:
354
raise errors.NoSuchRevision(self, stop_revision)
355
return other_history[self_len:stop_revision]
357
def update_revisions(self, other, stop_revision=None):
358
"""Pull in new perfect-fit revisions.
360
:param other: Another Branch to pull from
361
:param stop_revision: Updated until the given revision
364
raise NotImplementedError(self.update_revisions)
366
def revision_id_to_revno(self, revision_id):
367
"""Given a revision id, return its revno"""
368
if revision_id is None:
370
history = self.revision_history()
372
return history.index(revision_id) + 1
374
raise bzrlib.errors.NoSuchRevision(self, revision_id)
376
def get_rev_id(self, revno, history=None):
377
"""Find the revision id of the specified revno."""
381
history = self.revision_history()
382
if revno <= 0 or revno > len(history):
383
raise bzrlib.errors.NoSuchRevision(self, revno)
384
return history[revno - 1]
386
def pull(self, source, overwrite=False, stop_revision=None):
387
"""Mirror source into this branch.
389
This branch is considered to be 'local', having low latency.
391
raise NotImplementedError(self.pull)
393
def push(self, target, overwrite=False, stop_revision=None):
394
"""Mirror this branch into target.
396
This branch is considered to be 'local', having low latency.
398
raise NotImplementedError(self.push)
400
def basis_tree(self):
401
"""Return `Tree` object for last revision."""
402
return self.repository.revision_tree(self.last_revision())
404
def rename_one(self, from_rel, to_rel):
407
This can change the directory or the filename or both.
409
raise NotImplementedError(self.rename_one)
411
def move(self, from_paths, to_name):
414
to_name must exist as a versioned directory.
416
If to_name exists and is a directory, the files are moved into
417
it, keeping their old names. If it is a directory,
419
Note that to_name is only the last component of the new name;
420
this doesn't change the directory.
422
This returns a list of (from_path, to_path) pairs for each
425
raise NotImplementedError(self.move)
427
def get_parent(self):
428
"""Return the parent location of the branch.
430
This is the default location for push/pull/missing. The usual
431
pattern is that the user can override it by specifying a
434
raise NotImplementedError(self.get_parent)
436
def get_submit_branch(self):
437
"""Return the submit location of the branch.
439
This is the default location for bundle. The usual
440
pattern is that the user can override it by specifying a
443
return self.get_config().get_user_option('submit_branch')
445
def set_submit_branch(self, location):
446
"""Return the submit location of the branch.
448
This is the default location for bundle. The usual
449
pattern is that the user can override it by specifying a
452
self.get_config().set_user_option('submit_branch', location)
454
def get_push_location(self):
455
"""Return the None or the location to push this branch to."""
456
push_loc = self.get_config().get_user_option('push_location')
459
def set_push_location(self, location):
460
"""Set a new push location for this branch."""
461
raise NotImplementedError(self.set_push_location)
463
def set_parent(self, url):
464
raise NotImplementedError(self.set_parent)
468
"""Synchronise this branch with the master branch if any.
470
:return: None or the last_revision pivoted out during the update.
474
def check_revno(self, revno):
476
Check whether a revno corresponds to any revision.
477
Zero (the NULL revision) is considered valid.
480
self.check_real_revno(revno)
482
def check_real_revno(self, revno):
484
Check whether a revno corresponds to a real revision.
485
Zero (the NULL revision) is considered invalid
487
if revno < 1 or revno > self.revno():
488
raise InvalidRevisionNumber(revno)
491
def clone(self, *args, **kwargs):
492
"""Clone this branch into to_bzrdir preserving all semantic values.
494
revision_id: if not None, the revision history in the new branch will
495
be truncated to end with revision_id.
497
# for API compatibility, until 0.8 releases we provide the old api:
498
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
499
# after 0.8 releases, the *args and **kwargs should be changed:
500
# def clone(self, to_bzrdir, revision_id=None):
501
if (kwargs.get('to_location', None) or
502
kwargs.get('revision', None) or
503
kwargs.get('basis_branch', None) or
504
(len(args) and isinstance(args[0], basestring))):
505
# backwards compatibility api:
506
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
507
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
510
basis_branch = args[2]
512
basis_branch = kwargs.get('basis_branch', None)
514
basis = basis_branch.bzrdir
519
revision_id = args[1]
521
revision_id = kwargs.get('revision', None)
526
# no default to raise if not provided.
527
url = kwargs.get('to_location')
528
return self.bzrdir.clone(url,
529
revision_id=revision_id,
530
basis=basis).open_branch()
532
# generate args by hand
534
revision_id = args[1]
536
revision_id = kwargs.get('revision_id', None)
540
# no default to raise if not provided.
541
to_bzrdir = kwargs.get('to_bzrdir')
542
result = self._format.initialize(to_bzrdir)
543
self.copy_content_into(result, revision_id=revision_id)
547
def sprout(self, to_bzrdir, revision_id=None):
548
"""Create a new line of development from the branch, into to_bzrdir.
550
revision_id: if not None, the revision history in the new branch will
551
be truncated to end with revision_id.
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
555
result.set_parent(self.bzrdir.root_transport.base)
559
def copy_content_into(self, destination, revision_id=None):
560
"""Copy the content of self into destination.
562
revision_id: if not None, the revision history in the new branch will
563
be truncated to end with revision_id.
565
new_history = self.revision_history()
566
if revision_id is not None:
568
new_history = new_history[:new_history.index(revision_id) + 1]
570
rev = self.repository.get_revision(revision_id)
571
new_history = rev.get_history(self.repository)[1:]
572
destination.set_revision_history(new_history)
574
parent = self.get_parent()
575
except errors.InaccessibleParent, e:
576
mutter('parent was not accessible to copy: %s', e)
579
destination.set_parent(parent)
583
"""Check consistency of the branch.
585
In particular this checks that revisions given in the revision-history
586
do actually match up in the revision graph, and that they're all
587
present in the repository.
589
Callers will typically also want to check the repository.
591
:return: A BranchCheckResult.
593
mainline_parent_id = None
594
for revision_id in self.revision_history():
596
revision = self.repository.get_revision(revision_id)
597
except errors.NoSuchRevision, e:
598
raise errors.BzrCheckError("mainline revision {%s} not in repository"
600
# In general the first entry on the revision history has no parents.
601
# But it's not illegal for it to have parents listed; this can happen
602
# in imports from Arch when the parents weren't reachable.
603
if mainline_parent_id is not None:
604
if mainline_parent_id not in revision.parent_ids:
605
raise errors.BzrCheckError("previous revision {%s} not listed among "
607
% (mainline_parent_id, revision_id))
608
mainline_parent_id = revision_id
609
return BranchCheckResult(self)
611
def _get_checkout_format(self):
612
"""Return the most suitable metadir for a checkout of this branch.
613
Weaves are used if this branch's repostory uses weaves.
615
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
616
from bzrlib import repository
617
format = bzrdir.BzrDirMetaFormat1()
618
format.repository_format = repository.RepositoryFormat7()
620
format = self.repository.bzrdir.cloning_metadir()
623
def create_checkout(self, to_location, revision_id=None,
625
"""Create a checkout of a branch.
627
:param to_location: The url to produce the checkout at
628
:param revision_id: The revision to check out
629
:param lightweight: If True, produce a lightweight checkout, otherwise,
630
produce a bound branch (heavyweight checkout)
631
:return: The tree of the created checkout
633
t = transport.get_transport(to_location)
636
except errors.FileExists:
639
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
640
BranchReferenceFormat().initialize(checkout, self)
642
format = self._get_checkout_format()
643
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
644
to_location, force_new_tree=False, format=format)
645
checkout = checkout_branch.bzrdir
646
checkout_branch.bind(self)
647
# pull up to the specified revision_id to set the initial
648
# branch tip correctly, and seed it with history.
649
checkout_branch.pull(self, stop_revision=revision_id)
650
return checkout.create_workingtree(revision_id)
653
class BranchFormat(object):
654
"""An encapsulation of the initialization and open routines for a format.
656
Formats provide three things:
657
* An initialization routine,
661
Formats are placed in an dict by their format string for reference
662
during branch opening. Its not required that these be instances, they
663
can be classes themselves with class methods - it simply depends on
664
whether state is needed for a given format or not.
666
Once a format is deprecated, just deprecate the initialize and open
667
methods on the format class. Do not deprecate the object, as the
668
object will be created every time regardless.
671
_default_format = None
672
"""The default format used for new branches."""
675
"""The known formats."""
678
def find_format(klass, a_bzrdir):
679
"""Return the format for the branch object in a_bzrdir."""
681
transport = a_bzrdir.get_branch_transport(None)
682
format_string = transport.get("format").read()
683
return klass._formats[format_string]
685
raise NotBranchError(path=transport.base)
687
raise errors.UnknownFormatError(format=format_string)
690
def get_default_format(klass):
691
"""Return the current default format."""
692
return klass._default_format
694
def get_format_string(self):
695
"""Return the ASCII format string that identifies this format."""
696
raise NotImplementedError(self.get_format_string)
698
def get_format_description(self):
699
"""Return the short format description for this format."""
700
raise NotImplementedError(self.get_format_description)
702
def get_reference(self, a_bzrdir):
703
"""Get the target reference of the branch in a_bzrdir.
705
format probing must have been completed before calling
706
this method - it is assumed that the format of the branch
707
in a_bzrdir is correct.
709
:param a_bzrdir: The bzrdir to get the branch data from.
710
:return: None if the branch is not a reference branch.
714
def initialize(self, a_bzrdir):
715
"""Create a branch of this format in a_bzrdir."""
716
raise NotImplementedError(self.initialize)
718
def is_supported(self):
719
"""Is this format supported?
721
Supported formats can be initialized and opened.
722
Unsupported formats may not support initialization or committing or
723
some other features depending on the reason for not being supported.
727
def open(self, a_bzrdir, _found=False):
728
"""Return the branch object for a_bzrdir
730
_found is a private parameter, do not use it. It is used to indicate
731
if format probing has already be done.
733
raise NotImplementedError(self.open)
736
def register_format(klass, format):
737
klass._formats[format.get_format_string()] = format
740
def set_default_format(klass, format):
741
klass._default_format = format
744
def unregister_format(klass, format):
745
assert klass._formats[format.get_format_string()] is format
746
del klass._formats[format.get_format_string()]
749
return self.get_format_string().rstrip()
752
class BranchHooks(dict):
753
"""A dictionary mapping hook name to a list of callables for branch hooks.
755
e.g. ['set_rh'] Is the list of items to be called when the
756
set_revision_history function is invoked.
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
# invoked whenever the revision history has been set
767
# with set_revision_history. The api signature is
768
# (branch, revision_history), and the branch will
769
# be write-locked. Introduced in 0.15.
772
def install_hook(self, hook_name, a_callable):
773
"""Install a_callable in to the hook hook_name.
775
:param hook_name: A hook name. See the __init__ method of BranchHooks
776
for the complete list of hooks.
777
:param a_callable: The callable to be invoked when the hook triggers.
778
The exact signature will depend on the hook - see the __init__
779
method of BranchHooks for details on each hook.
782
self[hook_name].append(a_callable)
784
raise errors.UnknownHook('branch', hook_name)
787
# install the default hooks into the Branch class.
788
Branch.hooks = BranchHooks()
791
class BzrBranchFormat4(BranchFormat):
792
"""Bzr branch format 4.
795
- a revision-history file.
796
- a branch-lock lock file [ to be shared with the bzrdir ]
799
def get_format_description(self):
800
"""See BranchFormat.get_format_description()."""
801
return "Branch format 4"
803
def initialize(self, a_bzrdir):
804
"""Create a branch of this format in a_bzrdir."""
805
mutter('creating branch in %s', a_bzrdir.transport.base)
806
branch_transport = a_bzrdir.get_branch_transport(self)
807
utf8_files = [('revision-history', ''),
810
control_files = lockable_files.LockableFiles(branch_transport,
811
'branch-lock', lockable_files.TransportLock)
812
control_files.create_lock()
813
control_files.lock_write()
815
for file, content in utf8_files:
816
control_files.put_utf8(file, content)
818
control_files.unlock()
819
return self.open(a_bzrdir, _found=True)
822
super(BzrBranchFormat4, self).__init__()
823
self._matchingbzrdir = bzrdir.BzrDirFormat6()
825
def open(self, a_bzrdir, _found=False):
826
"""Return the branch object for a_bzrdir
828
_found is a private parameter, do not use it. It is used to indicate
829
if format probing has already be done.
832
# we are being called directly and must probe.
833
raise NotImplementedError
834
return BzrBranch(_format=self,
835
_control_files=a_bzrdir._control_files,
837
_repository=a_bzrdir.open_repository())
840
return "Bazaar-NG branch format 4"
843
class BzrBranchFormat5(BranchFormat):
844
"""Bzr branch format 5.
847
- a revision-history file.
849
- a lock dir guarding the branch itself
850
- all of this stored in a branch/ subdirectory
851
- works with shared repositories.
853
This format is new in bzr 0.8.
856
def get_format_string(self):
857
"""See BranchFormat.get_format_string()."""
858
return "Bazaar-NG branch format 5\n"
860
def get_format_description(self):
861
"""See BranchFormat.get_format_description()."""
862
return "Branch format 5"
864
def initialize(self, a_bzrdir):
865
"""Create a branch of this format in a_bzrdir."""
866
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
867
branch_transport = a_bzrdir.get_branch_transport(self)
868
utf8_files = [('revision-history', ''),
871
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
873
control_files.create_lock()
874
control_files.lock_write()
875
control_files.put_utf8('format', self.get_format_string())
877
for file, content in utf8_files:
878
control_files.put_utf8(file, content)
880
control_files.unlock()
881
return self.open(a_bzrdir, _found=True, )
884
super(BzrBranchFormat5, self).__init__()
885
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
887
def open(self, a_bzrdir, _found=False):
888
"""Return the branch object for a_bzrdir
890
_found is a private parameter, do not use it. It is used to indicate
891
if format probing has already be done.
894
format = BranchFormat.find_format(a_bzrdir)
895
assert format.__class__ == self.__class__
897
transport = a_bzrdir.get_branch_transport(None)
898
control_files = lockable_files.LockableFiles(transport, 'lock',
900
return BzrBranch5(_format=self,
901
_control_files=control_files,
903
_repository=a_bzrdir.find_repository())
905
raise NotBranchError(path=transport.base)
908
return "Bazaar-NG Metadir branch format 5"
911
class BranchReferenceFormat(BranchFormat):
912
"""Bzr branch reference format.
914
Branch references are used in implementing checkouts, they
915
act as an alias to the real branch which is at some other url.
922
def get_format_string(self):
923
"""See BranchFormat.get_format_string()."""
924
return "Bazaar-NG Branch Reference Format 1\n"
926
def get_format_description(self):
927
"""See BranchFormat.get_format_description()."""
928
return "Checkout reference format 1"
930
def get_reference(self, a_bzrdir):
931
"""See BranchFormat.get_reference()."""
932
transport = a_bzrdir.get_branch_transport(None)
933
return transport.get('location').read()
935
def initialize(self, a_bzrdir, target_branch=None):
936
"""Create a branch of this format in a_bzrdir."""
937
if target_branch is None:
938
# this format does not implement branch itself, thus the implicit
939
# creation contract must see it as uninitializable
940
raise errors.UninitializableFormat(self)
941
mutter('creating branch reference in %s', a_bzrdir.transport.base)
942
branch_transport = a_bzrdir.get_branch_transport(self)
943
branch_transport.put_bytes('location',
944
target_branch.bzrdir.root_transport.base)
945
branch_transport.put_bytes('format', self.get_format_string())
946
return self.open(a_bzrdir, _found=True)
949
super(BranchReferenceFormat, self).__init__()
950
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
952
def _make_reference_clone_function(format, a_branch):
953
"""Create a clone() routine for a branch dynamically."""
954
def clone(to_bzrdir, revision_id=None):
955
"""See Branch.clone()."""
956
return format.initialize(to_bzrdir, a_branch)
957
# cannot obey revision_id limits when cloning a reference ...
958
# FIXME RBC 20060210 either nuke revision_id for clone, or
959
# emit some sort of warning/error to the caller ?!
962
def open(self, a_bzrdir, _found=False, location=None):
963
"""Return the branch that the branch reference in a_bzrdir points at.
965
_found is a private parameter, do not use it. It is used to indicate
966
if format probing has already be done.
969
format = BranchFormat.find_format(a_bzrdir)
970
assert format.__class__ == self.__class__
972
location = self.get_reference(a_bzrdir)
973
real_bzrdir = bzrdir.BzrDir.open(location)
974
result = real_bzrdir.open_branch()
975
# this changes the behaviour of result.clone to create a new reference
976
# rather than a copy of the content of the branch.
977
# I did not use a proxy object because that needs much more extensive
978
# testing, and we are only changing one behaviour at the moment.
979
# If we decide to alter more behaviours - i.e. the implicit nickname
980
# then this should be refactored to introduce a tested proxy branch
981
# and a subclass of that for use in overriding clone() and ....
983
result.clone = self._make_reference_clone_function(result)
987
# formats which have no format string are not discoverable
988
# and not independently creatable, so are not registered.
989
__default_format = BzrBranchFormat5()
990
BranchFormat.register_format(__default_format)
991
BranchFormat.register_format(BranchReferenceFormat())
992
BranchFormat.set_default_format(__default_format)
993
_legacy_formats = [BzrBranchFormat4(),
996
class BzrBranch(Branch):
997
"""A branch stored in the actual filesystem.
999
Note that it's "local" in the context of the filesystem; it doesn't
1000
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1001
it's writable, and can be accessed via the normal filesystem API.
1004
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1005
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1006
_control_files=None, a_bzrdir=None, _repository=None):
1007
"""Create new branch object at a particular location.
1009
transport -- A Transport object, defining how to access files.
1011
init -- If True, create new control files in a previously
1012
unversioned directory. If False, the branch must already
1015
relax_version_check -- If true, the usual check for the branch
1016
version is not applied. This is intended only for
1017
upgrade/recovery type use; it's not guaranteed that
1018
all operations will work on old format branches.
1020
if a_bzrdir is None:
1021
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1023
self.bzrdir = a_bzrdir
1024
self._transport = self.bzrdir.transport.clone('..')
1025
self._base = self._transport.base
1026
self._format = _format
1027
if _control_files is None:
1028
raise ValueError('BzrBranch _control_files is None')
1029
self.control_files = _control_files
1030
if deprecated_passed(init):
1031
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1032
"deprecated as of bzr 0.8. Please use Branch.create().",
1036
# this is slower than before deprecation, oh well never mind.
1037
# -> its deprecated.
1038
self._initialize(transport.base)
1039
self._check_format(_format)
1040
if deprecated_passed(relax_version_check):
1041
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1042
"relax_version_check parameter is deprecated as of bzr 0.8. "
1043
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1047
if (not relax_version_check
1048
and not self._format.is_supported()):
1049
raise errors.UnsupportedFormatError(format=fmt)
1050
if deprecated_passed(transport):
1051
warn("BzrBranch.__init__(transport=XXX...): The transport "
1052
"parameter is deprecated as of bzr 0.8. "
1053
"Please use Branch.open, or bzrdir.open_branch().",
1056
self.repository = _repository
1059
return '%s(%r)' % (self.__class__.__name__, self.base)
1063
def _get_base(self):
1066
base = property(_get_base, doc="The URL for the root of this branch.")
1068
def _finish_transaction(self):
1069
"""Exit the current transaction."""
1070
return self.control_files._finish_transaction()
1072
def get_transaction(self):
1073
"""Return the current active transaction.
1075
If no transaction is active, this returns a passthrough object
1076
for which all data is immediately flushed and no caching happens.
1078
# this is an explicit function so that we can do tricky stuff
1079
# when the storage in rev_storage is elsewhere.
1080
# we probably need to hook the two 'lock a location' and
1081
# 'have a transaction' together more delicately, so that
1082
# we can have two locks (branch and storage) and one transaction
1083
# ... and finishing the transaction unlocks both, but unlocking
1084
# does not. - RBC 20051121
1085
return self.control_files.get_transaction()
1087
def _set_transaction(self, transaction):
1088
"""Set a new active transaction."""
1089
return self.control_files._set_transaction(transaction)
1091
def abspath(self, name):
1092
"""See Branch.abspath."""
1093
return self.control_files._transport.abspath(name)
1095
def _check_format(self, format):
1096
"""Identify the branch format if needed.
1098
The format is stored as a reference to the format object in
1099
self._format for code that needs to check it later.
1101
The format parameter is either None or the branch format class
1102
used to open this branch.
1104
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1107
format = BranchFormat.find_format(self.bzrdir)
1108
self._format = format
1109
mutter("got branch format %s", self._format)
1112
def get_root_id(self):
1113
"""See Branch.get_root_id."""
1114
tree = self.repository.revision_tree(self.last_revision())
1115
return tree.inventory.root.file_id
1117
def is_locked(self):
1118
return self.control_files.is_locked()
1120
def lock_write(self):
1121
self.repository.lock_write()
1123
self.control_files.lock_write()
1125
self.repository.unlock()
1128
def lock_read(self):
1129
self.repository.lock_read()
1131
self.control_files.lock_read()
1133
self.repository.unlock()
1137
# TODO: test for failed two phase locks. This is known broken.
1139
self.control_files.unlock()
1141
self.repository.unlock()
1143
def peek_lock_mode(self):
1144
if self.control_files._lock_count == 0:
1147
return self.control_files._lock_mode
1149
def get_physical_lock_status(self):
1150
return self.control_files.get_physical_lock_status()
1153
def print_file(self, file, revision_id):
1154
"""See Branch.print_file."""
1155
return self.repository.print_file(file, revision_id)
1158
def append_revision(self, *revision_ids):
1159
"""See Branch.append_revision."""
1160
for revision_id in revision_ids:
1161
_mod_revision.check_not_reserved_id(revision_id)
1162
mutter("add {%s} to revision-history" % revision_id)
1163
rev_history = self.revision_history()
1164
rev_history.extend(revision_ids)
1165
self.set_revision_history(rev_history)
1168
def set_revision_history(self, rev_history):
1169
"""See Branch.set_revision_history."""
1170
self.control_files.put_utf8(
1171
'revision-history', '\n'.join(rev_history))
1172
transaction = self.get_transaction()
1173
history = transaction.map.find_revision_history()
1174
if history is not None:
1175
# update the revision history in the identity map.
1176
history[:] = list(rev_history)
1177
# this call is disabled because revision_history is
1178
# not really an object yet, and the transaction is for objects.
1179
# transaction.register_dirty(history)
1181
transaction.map.add_revision_history(rev_history)
1182
# this call is disabled because revision_history is
1183
# not really an object yet, and the transaction is for objects.
1184
# transaction.register_clean(history)
1185
for hook in Branch.hooks['set_rh']:
1186
hook(self, rev_history)
1189
def revision_history(self):
1190
"""See Branch.revision_history."""
1191
transaction = self.get_transaction()
1192
history = transaction.map.find_revision_history()
1193
if history is not None:
1194
# mutter("cache hit for revision-history in %s", self)
1195
return list(history)
1196
decode_utf8 = cache_utf8.decode
1197
history = [decode_utf8(l.rstrip('\r\n')) for l in
1198
self.control_files.get('revision-history').readlines()]
1199
transaction.map.add_revision_history(history)
1200
# this call is disabled because revision_history is
1201
# not really an object yet, and the transaction is for objects.
1202
# transaction.register_clean(history, precious=True)
1203
return list(history)
1206
def generate_revision_history(self, revision_id, last_rev=None,
1208
"""Create a new revision history that will finish with revision_id.
1210
:param revision_id: the new tip to use.
1211
:param last_rev: The previous last_revision. If not None, then this
1212
must be a ancestory of revision_id, or DivergedBranches is raised.
1213
:param other_branch: The other branch that DivergedBranches should
1214
raise with respect to.
1216
# stop_revision must be a descendant of last_revision
1217
stop_graph = self.repository.get_revision_graph(revision_id)
1218
if last_rev is not None and last_rev not in stop_graph:
1219
# our previous tip is not merged into stop_revision
1220
raise errors.DivergedBranches(self, other_branch)
1221
# make a new revision history from the graph
1222
current_rev_id = revision_id
1224
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1225
new_history.append(current_rev_id)
1226
current_rev_id_parents = stop_graph[current_rev_id]
1228
current_rev_id = current_rev_id_parents[0]
1230
current_rev_id = None
1231
new_history.reverse()
1232
self.set_revision_history(new_history)
1235
def update_revisions(self, other, stop_revision=None):
1236
"""See Branch.update_revisions."""
1239
if stop_revision is None:
1240
stop_revision = other.last_revision()
1241
if stop_revision is None:
1242
# if there are no commits, we're done.
1244
# whats the current last revision, before we fetch [and change it
1246
last_rev = self.last_revision()
1247
# we fetch here regardless of whether we need to so that we pickup
1249
self.fetch(other, stop_revision)
1250
my_ancestry = self.repository.get_ancestry(last_rev)
1251
if stop_revision in my_ancestry:
1252
# last_revision is a descendant of stop_revision
1254
self.generate_revision_history(stop_revision, last_rev=last_rev,
1259
def basis_tree(self):
1260
"""See Branch.basis_tree."""
1261
return self.repository.revision_tree(self.last_revision())
1263
@deprecated_method(zero_eight)
1264
def working_tree(self):
1265
"""Create a Working tree object for this branch."""
1267
from bzrlib.transport.local import LocalTransport
1268
if (self.base.find('://') != -1 or
1269
not isinstance(self._transport, LocalTransport)):
1270
raise NoWorkingTree(self.base)
1271
return self.bzrdir.open_workingtree()
1274
def pull(self, source, overwrite=False, stop_revision=None):
1275
"""See Branch.pull."""
1278
old_count = self.last_revision_info()[0]
1280
self.update_revisions(source, stop_revision)
1281
except DivergedBranches:
1285
self.set_revision_history(source.revision_history())
1286
new_count = self.last_revision_info()[0]
1287
return new_count - old_count
1292
def push(self, target, overwrite=False, stop_revision=None):
1293
"""See Branch.push."""
1296
old_count = len(target.revision_history())
1298
target.update_revisions(self, stop_revision)
1299
except DivergedBranches:
1303
target.set_revision_history(self.revision_history())
1304
new_count = len(target.revision_history())
1305
return new_count - old_count
1309
def get_parent(self):
1310
"""See Branch.get_parent."""
1312
_locs = ['parent', 'pull', 'x-pull']
1313
assert self.base[-1] == '/'
1316
parent = self.control_files.get(l).read().strip('\n')
1319
# This is an old-format absolute path to a local branch
1320
# turn it into a url
1321
if parent.startswith('/'):
1322
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1324
return urlutils.join(self.base[:-1], parent)
1325
except errors.InvalidURLJoin, e:
1326
raise errors.InaccessibleParent(parent, self.base)
1329
def set_push_location(self, location):
1330
"""See Branch.set_push_location."""
1331
self.get_config().set_user_option(
1332
'push_location', location,
1333
store=_mod_config.STORE_LOCATION_NORECURSE)
1336
def set_parent(self, url):
1337
"""See Branch.set_parent."""
1338
# TODO: Maybe delete old location files?
1339
# URLs should never be unicode, even on the local fs,
1340
# FIXUP this and get_parent in a future branch format bump:
1341
# read and rewrite the file, and have the new format code read
1342
# using .get not .get_utf8. RBC 20060125
1344
self.control_files._transport.delete('parent')
1346
if isinstance(url, unicode):
1348
url = url.encode('ascii')
1349
except UnicodeEncodeError:
1350
raise bzrlib.errors.InvalidURL(url,
1351
"Urls must be 7-bit ascii, "
1352
"use bzrlib.urlutils.escape")
1354
url = urlutils.relative_url(self.base, url)
1355
self.control_files.put('parent', StringIO(url + '\n'))
1357
@deprecated_function(zero_nine)
1358
def tree_config(self):
1359
"""DEPRECATED; call get_config instead.
1360
TreeConfig has become part of BranchConfig."""
1361
return TreeConfig(self)
1364
class BzrBranch5(BzrBranch):
1365
"""A format 5 branch. This supports new features over plan branches.
1367
It has support for a master_branch which is the data for bound branches.
1375
super(BzrBranch5, self).__init__(_format=_format,
1376
_control_files=_control_files,
1378
_repository=_repository)
1381
def pull(self, source, overwrite=False, stop_revision=None):
1382
"""Extends branch.pull to be bound branch aware."""
1383
bound_location = self.get_bound_location()
1384
if source.base != bound_location:
1385
# not pulling from master, so we need to update master.
1386
master_branch = self.get_master_branch()
1388
master_branch.pull(source)
1389
source = master_branch
1390
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1393
def push(self, target, overwrite=False, stop_revision=None):
1394
"""Updates branch.push to be bound branch aware."""
1395
bound_location = target.get_bound_location()
1396
if target.base != bound_location:
1397
# not pushing to master, so we need to update master.
1398
master_branch = target.get_master_branch()
1400
# push into the master from this branch.
1401
super(BzrBranch5, self).push(master_branch, overwrite,
1403
# and push into the target branch from this. Note that we push from
1404
# this branch again, because its considered the highest bandwidth
1406
return super(BzrBranch5, self).push(target, overwrite, stop_revision)
1408
def get_bound_location(self):
1410
return self.control_files.get_utf8('bound').read()[:-1]
1411
except errors.NoSuchFile:
1415
def get_master_branch(self):
1416
"""Return the branch we are bound to.
1418
:return: Either a Branch, or None
1420
This could memoise the branch, but if thats done
1421
it must be revalidated on each new lock.
1422
So for now we just don't memoise it.
1423
# RBC 20060304 review this decision.
1425
bound_loc = self.get_bound_location()
1429
return Branch.open(bound_loc)
1430
except (errors.NotBranchError, errors.ConnectionError), e:
1431
raise errors.BoundBranchConnectionFailure(
1435
def set_bound_location(self, location):
1436
"""Set the target where this branch is bound to.
1438
:param location: URL to the target branch
1441
self.control_files.put_utf8('bound', location+'\n')
1444
self.control_files._transport.delete('bound')
1450
def bind(self, other):
1451
"""Bind this branch to the branch other.
1453
This does not push or pull data between the branches, though it does
1454
check for divergence to raise an error when the branches are not
1455
either the same, or one a prefix of the other. That behaviour may not
1456
be useful, so that check may be removed in future.
1458
:param other: The branch to bind to
1461
# TODO: jam 20051230 Consider checking if the target is bound
1462
# It is debatable whether you should be able to bind to
1463
# a branch which is itself bound.
1464
# Committing is obviously forbidden,
1465
# but binding itself may not be.
1466
# Since we *have* to check at commit time, we don't
1467
# *need* to check here
1469
# we want to raise diverged if:
1470
# last_rev is not in the other_last_rev history, AND
1471
# other_last_rev is not in our history, and do it without pulling
1473
last_rev = self.last_revision()
1474
if last_rev is not None:
1477
other_last_rev = other.last_revision()
1478
if other_last_rev is not None:
1479
# neither branch is new, we have to do some work to
1480
# ascertain diversion.
1481
remote_graph = other.repository.get_revision_graph(
1483
local_graph = self.repository.get_revision_graph(last_rev)
1484
if (last_rev not in remote_graph and
1485
other_last_rev not in local_graph):
1486
raise errors.DivergedBranches(self, other)
1489
self.set_bound_location(other.base)
1493
"""If bound, unbind"""
1494
return self.set_bound_location(None)
1498
"""Synchronise this branch with the master branch if any.
1500
:return: None or the last_revision that was pivoted out during the
1503
master = self.get_master_branch()
1504
if master is not None:
1505
old_tip = self.last_revision()
1506
self.pull(master, overwrite=True)
1507
if old_tip in self.repository.get_ancestry(self.last_revision()):
1513
class BranchTestProviderAdapter(object):
1514
"""A tool to generate a suite testing multiple branch formats at once.
1516
This is done by copying the test once for each transport and injecting
1517
the transport_server, transport_readonly_server, and branch_format
1518
classes into each copy. Each copy is also given a new id() to make it
1522
def __init__(self, transport_server, transport_readonly_server, formats):
1523
self._transport_server = transport_server
1524
self._transport_readonly_server = transport_readonly_server
1525
self._formats = formats
1527
def adapt(self, test):
1528
result = TestSuite()
1529
for branch_format, bzrdir_format in self._formats:
1530
new_test = deepcopy(test)
1531
new_test.transport_server = self._transport_server
1532
new_test.transport_readonly_server = self._transport_readonly_server
1533
new_test.bzrdir_format = bzrdir_format
1534
new_test.branch_format = branch_format
1535
def make_new_test_id():
1536
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1537
return lambda: new_id
1538
new_test.id = make_new_test_id()
1539
result.addTest(new_test)
1543
class BranchCheckResult(object):
1544
"""Results of checking branch consistency.
1549
def __init__(self, branch):
1550
self.branch = branch
1552
def report_results(self, verbose):
1553
"""Report the check results via trace.note.
1555
:param verbose: Requests more detailed display of what was checked,
1558
note('checked branch %s format %s',
1560
self.branch._format)
1563
######################################################################
1567
@deprecated_function(zero_eight)
1568
def is_control_file(*args, **kwargs):
1569
"""See bzrlib.workingtree.is_control_file."""
1570
from bzrlib import workingtree
1571
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
