1
# Copyright (C) 2005, 2006, 2007 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 leave_lock_in_place(self):
189
"""Tell this branch object not to release the physical lock when this
192
If lock_write doesn't return a token, then this method is not supported.
194
self.control_files.leave_in_place()
196
def dont_leave_lock_in_place(self):
197
"""Tell this branch object to release the physical lock when this
198
object is unlocked, even if it didn't originally acquire it.
200
If lock_write doesn't return a token, then this method is not supported.
202
self.control_files.dont_leave_in_place()
204
def abspath(self, name):
205
"""Return absolute filename for something in the branch
207
XXX: Robert Collins 20051017 what is this used for? why is it a branch
208
method and not a tree method.
210
raise NotImplementedError(self.abspath)
212
def bind(self, other):
213
"""Bind the local branch the other branch.
215
:param other: The branch to bind to
218
raise errors.UpgradeRequired(self.base)
221
def fetch(self, from_branch, last_revision=None, pb=None):
222
"""Copy revisions from from_branch into this branch.
224
:param from_branch: Where to copy from.
225
:param last_revision: What revision to stop at (None for at the end
227
:param pb: An optional progress bar to use.
229
Returns the copied revision count and the failed revisions in a tuple:
232
if self.base == from_branch.base:
235
nested_pb = ui.ui_factory.nested_progress_bar()
240
from_branch.lock_read()
242
if last_revision is None:
243
pb.update('get source history')
244
last_revision = from_branch.last_revision_info()[1]
245
return self.repository.fetch(from_branch.repository,
246
revision_id=last_revision,
249
if nested_pb is not None:
253
def get_bound_location(self):
254
"""Return the URL of the branch we are bound to.
256
Older format branches cannot bind, please be sure to use a metadir
261
def get_commit_builder(self, parents, config=None, timestamp=None,
262
timezone=None, committer=None, revprops=None,
264
"""Obtain a CommitBuilder for this branch.
266
:param parents: Revision ids of the parents of the new revision.
267
:param config: Optional configuration to use.
268
:param timestamp: Optional timestamp recorded for commit.
269
:param timezone: Optional timezone for timestamp.
270
:param committer: Optional committer to set for commit.
271
:param revprops: Optional dictionary of revision properties.
272
:param revision_id: Optional revision id.
276
config = self.get_config()
278
return self.repository.get_commit_builder(self, parents, config,
279
timestamp, timezone, committer, revprops, revision_id)
281
def get_master_branch(self):
282
"""Return the branch we are bound to.
284
:return: Either a Branch, or None
288
def get_revision_delta(self, revno):
289
"""Return the delta for one revision.
291
The delta is relative to its mainline predecessor, or the
292
empty tree for revision 1.
294
assert isinstance(revno, int)
295
rh = self.revision_history()
296
if not (1 <= revno <= len(rh)):
297
raise InvalidRevisionNumber(revno)
298
return self.repository.get_revision_delta(rh[revno-1])
300
def get_root_id(self):
301
"""Return the id of this branches root"""
302
raise NotImplementedError(self.get_root_id)
304
def print_file(self, file, revision_id):
305
"""Print `file` to stdout."""
306
raise NotImplementedError(self.print_file)
308
def append_revision(self, *revision_ids):
309
raise NotImplementedError(self.append_revision)
311
def set_revision_history(self, rev_history):
312
raise NotImplementedError(self.set_revision_history)
314
def revision_history(self):
315
"""Return sequence of revision hashes on to this branch."""
316
raise NotImplementedError(self.revision_history)
319
"""Return current revision number for this branch.
321
That is equivalent to the number of revisions committed to
324
return len(self.revision_history())
327
"""Older format branches cannot bind or unbind."""
328
raise errors.UpgradeRequired(self.base)
330
def last_revision(self):
331
"""Return last revision id, or None"""
332
ph = self.revision_history()
338
def last_revision_info(self):
339
"""Return information about the last revision.
341
:return: A tuple (revno, last_revision_id).
343
rh = self.revision_history()
346
return (revno, rh[-1])
348
return (0, _mod_revision.NULL_REVISION)
350
def missing_revisions(self, other, stop_revision=None):
351
"""Return a list of new revisions that would perfectly fit.
353
If self and other have not diverged, return a list of the revisions
354
present in other, but missing from self.
356
self_history = self.revision_history()
357
self_len = len(self_history)
358
other_history = other.revision_history()
359
other_len = len(other_history)
360
common_index = min(self_len, other_len) -1
361
if common_index >= 0 and \
362
self_history[common_index] != other_history[common_index]:
363
raise DivergedBranches(self, other)
365
if stop_revision is None:
366
stop_revision = other_len
368
assert isinstance(stop_revision, int)
369
if stop_revision > other_len:
370
raise errors.NoSuchRevision(self, stop_revision)
371
return other_history[self_len:stop_revision]
373
def update_revisions(self, other, stop_revision=None):
374
"""Pull in new perfect-fit revisions.
376
:param other: Another Branch to pull from
377
:param stop_revision: Updated until the given revision
380
raise NotImplementedError(self.update_revisions)
382
def revision_id_to_revno(self, revision_id):
383
"""Given a revision id, return its revno"""
384
if revision_id is None:
386
history = self.revision_history()
388
return history.index(revision_id) + 1
390
raise bzrlib.errors.NoSuchRevision(self, revision_id)
392
def get_rev_id(self, revno, history=None):
393
"""Find the revision id of the specified revno."""
397
history = self.revision_history()
398
if revno <= 0 or revno > len(history):
399
raise bzrlib.errors.NoSuchRevision(self, revno)
400
return history[revno - 1]
402
def pull(self, source, overwrite=False, stop_revision=None):
403
"""Mirror source into this branch.
405
This branch is considered to be 'local', having low latency.
407
raise NotImplementedError(self.pull)
409
def push(self, target, overwrite=False, stop_revision=None):
410
"""Mirror this branch into target.
412
This branch is considered to be 'local', having low latency.
414
raise NotImplementedError(self.push)
416
def basis_tree(self):
417
"""Return `Tree` object for last revision."""
418
return self.repository.revision_tree(self.last_revision())
420
def rename_one(self, from_rel, to_rel):
423
This can change the directory or the filename or both.
425
raise NotImplementedError(self.rename_one)
427
def move(self, from_paths, to_name):
430
to_name must exist as a versioned directory.
432
If to_name exists and is a directory, the files are moved into
433
it, keeping their old names. If it is a directory,
435
Note that to_name is only the last component of the new name;
436
this doesn't change the directory.
438
This returns a list of (from_path, to_path) pairs for each
441
raise NotImplementedError(self.move)
443
def get_parent(self):
444
"""Return the parent location of the branch.
446
This is the default location for push/pull/missing. The usual
447
pattern is that the user can override it by specifying a
450
raise NotImplementedError(self.get_parent)
452
def get_submit_branch(self):
453
"""Return the submit location of the branch.
455
This is the default location for bundle. The usual
456
pattern is that the user can override it by specifying a
459
return self.get_config().get_user_option('submit_branch')
461
def set_submit_branch(self, location):
462
"""Return the submit location of the branch.
464
This is the default location for bundle. The usual
465
pattern is that the user can override it by specifying a
468
self.get_config().set_user_option('submit_branch', location)
470
def get_push_location(self):
471
"""Return the None or the location to push this branch to."""
472
push_loc = self.get_config().get_user_option('push_location')
475
def set_push_location(self, location):
476
"""Set a new push location for this branch."""
477
raise NotImplementedError(self.set_push_location)
479
def set_parent(self, url):
480
raise NotImplementedError(self.set_parent)
484
"""Synchronise this branch with the master branch if any.
486
:return: None or the last_revision pivoted out during the update.
490
def check_revno(self, revno):
492
Check whether a revno corresponds to any revision.
493
Zero (the NULL revision) is considered valid.
496
self.check_real_revno(revno)
498
def check_real_revno(self, revno):
500
Check whether a revno corresponds to a real revision.
501
Zero (the NULL revision) is considered invalid
503
if revno < 1 or revno > self.revno():
504
raise InvalidRevisionNumber(revno)
507
def clone(self, *args, **kwargs):
508
"""Clone this branch into to_bzrdir preserving all semantic values.
510
revision_id: if not None, the revision history in the new branch will
511
be truncated to end with revision_id.
513
# for API compatibility, until 0.8 releases we provide the old api:
514
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
515
# after 0.8 releases, the *args and **kwargs should be changed:
516
# def clone(self, to_bzrdir, revision_id=None):
517
if (kwargs.get('to_location', None) or
518
kwargs.get('revision', None) or
519
kwargs.get('basis_branch', None) or
520
(len(args) and isinstance(args[0], basestring))):
521
# backwards compatibility api:
522
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
523
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
526
basis_branch = args[2]
528
basis_branch = kwargs.get('basis_branch', None)
530
basis = basis_branch.bzrdir
535
revision_id = args[1]
537
revision_id = kwargs.get('revision', None)
542
# no default to raise if not provided.
543
url = kwargs.get('to_location')
544
return self.bzrdir.clone(url,
545
revision_id=revision_id,
546
basis=basis).open_branch()
548
# generate args by hand
550
revision_id = args[1]
552
revision_id = kwargs.get('revision_id', None)
556
# no default to raise if not provided.
557
to_bzrdir = kwargs.get('to_bzrdir')
558
result = self._format.initialize(to_bzrdir)
559
self.copy_content_into(result, revision_id=revision_id)
563
def sprout(self, to_bzrdir, revision_id=None):
564
"""Create a new line of development from the branch, into to_bzrdir.
566
revision_id: if not None, the revision history in the new branch will
567
be truncated to end with revision_id.
569
result = self._format.initialize(to_bzrdir)
570
self.copy_content_into(result, revision_id=revision_id)
571
result.set_parent(self.bzrdir.root_transport.base)
575
def copy_content_into(self, destination, revision_id=None):
576
"""Copy the content of self into destination.
578
revision_id: if not None, the revision history in the new branch will
579
be truncated to end with revision_id.
581
new_history = self.revision_history()
582
if revision_id is not None:
584
new_history = new_history[:new_history.index(revision_id) + 1]
586
rev = self.repository.get_revision(revision_id)
587
new_history = rev.get_history(self.repository)[1:]
588
destination.set_revision_history(new_history)
590
parent = self.get_parent()
591
except errors.InaccessibleParent, e:
592
mutter('parent was not accessible to copy: %s', e)
595
destination.set_parent(parent)
599
"""Check consistency of the branch.
601
In particular this checks that revisions given in the revision-history
602
do actually match up in the revision graph, and that they're all
603
present in the repository.
605
Callers will typically also want to check the repository.
607
:return: A BranchCheckResult.
609
mainline_parent_id = None
610
for revision_id in self.revision_history():
612
revision = self.repository.get_revision(revision_id)
613
except errors.NoSuchRevision, e:
614
raise errors.BzrCheckError("mainline revision {%s} not in repository"
616
# In general the first entry on the revision history has no parents.
617
# But it's not illegal for it to have parents listed; this can happen
618
# in imports from Arch when the parents weren't reachable.
619
if mainline_parent_id is not None:
620
if mainline_parent_id not in revision.parent_ids:
621
raise errors.BzrCheckError("previous revision {%s} not listed among "
623
% (mainline_parent_id, revision_id))
624
mainline_parent_id = revision_id
625
return BranchCheckResult(self)
627
def _get_checkout_format(self):
628
"""Return the most suitable metadir for a checkout of this branch.
629
Weaves are used if this branch's repostory uses weaves.
631
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
632
from bzrlib import repository
633
format = bzrdir.BzrDirMetaFormat1()
634
format.repository_format = repository.RepositoryFormat7()
636
format = self.repository.bzrdir.cloning_metadir()
639
def create_checkout(self, to_location, revision_id=None,
641
"""Create a checkout of a branch.
643
:param to_location: The url to produce the checkout at
644
:param revision_id: The revision to check out
645
:param lightweight: If True, produce a lightweight checkout, otherwise,
646
produce a bound branch (heavyweight checkout)
647
:return: The tree of the created checkout
649
t = transport.get_transport(to_location)
652
except errors.FileExists:
655
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
656
BranchReferenceFormat().initialize(checkout, self)
658
format = self._get_checkout_format()
659
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
660
to_location, force_new_tree=False, format=format)
661
checkout = checkout_branch.bzrdir
662
checkout_branch.bind(self)
663
# pull up to the specified revision_id to set the initial
664
# branch tip correctly, and seed it with history.
665
checkout_branch.pull(self, stop_revision=revision_id)
666
return checkout.create_workingtree(revision_id)
669
class BranchFormat(object):
670
"""An encapsulation of the initialization and open routines for a format.
672
Formats provide three things:
673
* An initialization routine,
677
Formats are placed in an dict by their format string for reference
678
during branch opening. Its not required that these be instances, they
679
can be classes themselves with class methods - it simply depends on
680
whether state is needed for a given format or not.
682
Once a format is deprecated, just deprecate the initialize and open
683
methods on the format class. Do not deprecate the object, as the
684
object will be created every time regardless.
687
_default_format = None
688
"""The default format used for new branches."""
691
"""The known formats."""
694
def find_format(klass, a_bzrdir):
695
"""Return the format for the branch object in a_bzrdir."""
697
transport = a_bzrdir.get_branch_transport(None)
698
format_string = transport.get("format").read()
699
return klass._formats[format_string]
701
raise NotBranchError(path=transport.base)
703
raise errors.UnknownFormatError(format=format_string)
706
def get_default_format(klass):
707
"""Return the current default format."""
708
return klass._default_format
710
def get_format_string(self):
711
"""Return the ASCII format string that identifies this format."""
712
raise NotImplementedError(self.get_format_string)
714
def get_format_description(self):
715
"""Return the short format description for this format."""
716
raise NotImplementedError(self.get_format_description)
718
def get_reference(self, a_bzrdir):
719
"""Get the target reference of the branch in a_bzrdir.
721
format probing must have been completed before calling
722
this method - it is assumed that the format of the branch
723
in a_bzrdir is correct.
725
:param a_bzrdir: The bzrdir to get the branch data from.
726
:return: None if the branch is not a reference branch.
730
def initialize(self, a_bzrdir):
731
"""Create a branch of this format in a_bzrdir."""
732
raise NotImplementedError(self.initialize)
734
def is_supported(self):
735
"""Is this format supported?
737
Supported formats can be initialized and opened.
738
Unsupported formats may not support initialization or committing or
739
some other features depending on the reason for not being supported.
743
def open(self, a_bzrdir, _found=False):
744
"""Return the branch object for a_bzrdir
746
_found is a private parameter, do not use it. It is used to indicate
747
if format probing has already be done.
749
raise NotImplementedError(self.open)
752
def register_format(klass, format):
753
klass._formats[format.get_format_string()] = format
756
def set_default_format(klass, format):
757
klass._default_format = format
760
def unregister_format(klass, format):
761
assert klass._formats[format.get_format_string()] is format
762
del klass._formats[format.get_format_string()]
765
return self.get_format_string().rstrip()
768
class BranchHooks(dict):
769
"""A dictionary mapping hook name to a list of callables for branch hooks.
771
e.g. ['set_rh'] Is the list of items to be called when the
772
set_revision_history function is invoked.
776
"""Create the default hooks.
778
These are all empty initially, because by default nothing should get
782
# Introduced in 0.15:
783
# invoked whenever the revision history has been set
784
# with set_revision_history. The api signature is
785
# (branch, revision_history), and the branch will
788
# invoked after a push operation completes.
789
# the api signature is
790
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
791
# where local is the local branch or None, master is the target
792
# master branch, and the rest should be self explanatory. The source
793
# is read locked and the target branches write locked. Source will
794
# be the local low-latency branch.
795
self['post_push'] = []
796
# invoked after a pull operation completes.
797
# the api signature is
798
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
799
# where local is the local branch or None, master is the target
800
# master branch, and the rest should be self explanatory. The source
801
# is read locked and the target branches write locked. The local
802
# branch is the low-latency branch.
803
self['post_pull'] = []
804
# invoked after a commit operation completes.
805
# the api signature is
806
# (local, master, old_revno, old_revid, new_revno, new_revid)
807
# old_revid is NULL_REVISION for the first commit to a branch.
808
self['post_commit'] = []
809
# invoked after a uncommit operation completes.
810
# the api signature is
811
# (local, master, old_revno, old_revid, new_revno, new_revid) where
812
# local is the local branch or None, master is the target branch,
813
# and an empty branch recieves new_revno of 0, new_revid of None.
814
self['post_uncommit'] = []
816
def install_hook(self, hook_name, a_callable):
817
"""Install a_callable in to the hook hook_name.
819
:param hook_name: A hook name. See the __init__ method of BranchHooks
820
for the complete list of hooks.
821
:param a_callable: The callable to be invoked when the hook triggers.
822
The exact signature will depend on the hook - see the __init__
823
method of BranchHooks for details on each hook.
826
self[hook_name].append(a_callable)
828
raise errors.UnknownHook('branch', hook_name)
831
# install the default hooks into the Branch class.
832
Branch.hooks = BranchHooks()
835
class BzrBranchFormat4(BranchFormat):
836
"""Bzr branch format 4.
839
- a revision-history file.
840
- a branch-lock lock file [ to be shared with the bzrdir ]
843
def get_format_description(self):
844
"""See BranchFormat.get_format_description()."""
845
return "Branch format 4"
847
def initialize(self, a_bzrdir):
848
"""Create a branch of this format in a_bzrdir."""
849
mutter('creating branch in %s', a_bzrdir.transport.base)
850
branch_transport = a_bzrdir.get_branch_transport(self)
851
utf8_files = [('revision-history', ''),
854
control_files = lockable_files.LockableFiles(branch_transport,
855
'branch-lock', lockable_files.TransportLock)
856
control_files.create_lock()
857
control_files.lock_write()
859
for file, content in utf8_files:
860
control_files.put_utf8(file, content)
862
control_files.unlock()
863
return self.open(a_bzrdir, _found=True)
866
super(BzrBranchFormat4, self).__init__()
867
self._matchingbzrdir = bzrdir.BzrDirFormat6()
869
def open(self, a_bzrdir, _found=False):
870
"""Return the branch object for a_bzrdir
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
876
# we are being called directly and must probe.
877
raise NotImplementedError
878
return BzrBranch(_format=self,
879
_control_files=a_bzrdir._control_files,
881
_repository=a_bzrdir.open_repository())
884
return "Bazaar-NG branch format 4"
887
class BzrBranchFormat5(BranchFormat):
888
"""Bzr branch format 5.
891
- a revision-history file.
893
- a lock dir guarding the branch itself
894
- all of this stored in a branch/ subdirectory
895
- works with shared repositories.
897
This format is new in bzr 0.8.
900
def get_format_string(self):
901
"""See BranchFormat.get_format_string()."""
902
return "Bazaar-NG branch format 5\n"
904
def get_format_description(self):
905
"""See BranchFormat.get_format_description()."""
906
return "Branch format 5"
908
def initialize(self, a_bzrdir):
909
"""Create a branch of this format in a_bzrdir."""
910
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
911
branch_transport = a_bzrdir.get_branch_transport(self)
912
utf8_files = [('revision-history', ''),
915
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
917
control_files.create_lock()
918
control_files.lock_write()
919
control_files.put_utf8('format', self.get_format_string())
921
for file, content in utf8_files:
922
control_files.put_utf8(file, content)
924
control_files.unlock()
925
return self.open(a_bzrdir, _found=True, )
928
super(BzrBranchFormat5, self).__init__()
929
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
931
def open(self, a_bzrdir, _found=False):
932
"""Return the branch object for a_bzrdir
934
_found is a private parameter, do not use it. It is used to indicate
935
if format probing has already be done.
938
format = BranchFormat.find_format(a_bzrdir)
939
assert format.__class__ == self.__class__
941
transport = a_bzrdir.get_branch_transport(None)
942
control_files = lockable_files.LockableFiles(transport, 'lock',
944
return BzrBranch5(_format=self,
945
_control_files=control_files,
947
_repository=a_bzrdir.find_repository())
949
raise NotBranchError(path=transport.base)
952
return "Bazaar-NG Metadir branch format 5"
955
class BranchReferenceFormat(BranchFormat):
956
"""Bzr branch reference format.
958
Branch references are used in implementing checkouts, they
959
act as an alias to the real branch which is at some other url.
966
def get_format_string(self):
967
"""See BranchFormat.get_format_string()."""
968
return "Bazaar-NG Branch Reference Format 1\n"
970
def get_format_description(self):
971
"""See BranchFormat.get_format_description()."""
972
return "Checkout reference format 1"
974
def get_reference(self, a_bzrdir):
975
"""See BranchFormat.get_reference()."""
976
transport = a_bzrdir.get_branch_transport(None)
977
return transport.get('location').read()
979
def initialize(self, a_bzrdir, target_branch=None):
980
"""Create a branch of this format in a_bzrdir."""
981
if target_branch is None:
982
# this format does not implement branch itself, thus the implicit
983
# creation contract must see it as uninitializable
984
raise errors.UninitializableFormat(self)
985
mutter('creating branch reference in %s', a_bzrdir.transport.base)
986
branch_transport = a_bzrdir.get_branch_transport(self)
987
branch_transport.put_bytes('location',
988
target_branch.bzrdir.root_transport.base)
989
branch_transport.put_bytes('format', self.get_format_string())
990
return self.open(a_bzrdir, _found=True)
993
super(BranchReferenceFormat, self).__init__()
994
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
996
def _make_reference_clone_function(format, a_branch):
997
"""Create a clone() routine for a branch dynamically."""
998
def clone(to_bzrdir, revision_id=None):
999
"""See Branch.clone()."""
1000
return format.initialize(to_bzrdir, a_branch)
1001
# cannot obey revision_id limits when cloning a reference ...
1002
# FIXME RBC 20060210 either nuke revision_id for clone, or
1003
# emit some sort of warning/error to the caller ?!
1006
def open(self, a_bzrdir, _found=False, location=None):
1007
"""Return the branch that the branch reference in a_bzrdir points at.
1009
_found is a private parameter, do not use it. It is used to indicate
1010
if format probing has already be done.
1013
format = BranchFormat.find_format(a_bzrdir)
1014
assert format.__class__ == self.__class__
1015
if location is None:
1016
location = self.get_reference(a_bzrdir)
1017
real_bzrdir = bzrdir.BzrDir.open(location)
1018
result = real_bzrdir.open_branch()
1019
# this changes the behaviour of result.clone to create a new reference
1020
# rather than a copy of the content of the branch.
1021
# I did not use a proxy object because that needs much more extensive
1022
# testing, and we are only changing one behaviour at the moment.
1023
# If we decide to alter more behaviours - i.e. the implicit nickname
1024
# then this should be refactored to introduce a tested proxy branch
1025
# and a subclass of that for use in overriding clone() and ....
1027
result.clone = self._make_reference_clone_function(result)
1031
# formats which have no format string are not discoverable
1032
# and not independently creatable, so are not registered.
1033
__default_format = BzrBranchFormat5()
1034
BranchFormat.register_format(__default_format)
1035
BranchFormat.register_format(BranchReferenceFormat())
1036
BranchFormat.set_default_format(__default_format)
1037
_legacy_formats = [BzrBranchFormat4(),
1040
class BzrBranch(Branch):
1041
"""A branch stored in the actual filesystem.
1043
Note that it's "local" in the context of the filesystem; it doesn't
1044
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1045
it's writable, and can be accessed via the normal filesystem API.
1048
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1049
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1050
_control_files=None, a_bzrdir=None, _repository=None):
1051
"""Create new branch object at a particular location.
1053
transport -- A Transport object, defining how to access files.
1055
init -- If True, create new control files in a previously
1056
unversioned directory. If False, the branch must already
1059
relax_version_check -- If true, the usual check for the branch
1060
version is not applied. This is intended only for
1061
upgrade/recovery type use; it's not guaranteed that
1062
all operations will work on old format branches.
1064
if a_bzrdir is None:
1065
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1067
self.bzrdir = a_bzrdir
1068
self._transport = self.bzrdir.transport.clone('..')
1069
self._base = self._transport.base
1070
self._format = _format
1071
if _control_files is None:
1072
raise ValueError('BzrBranch _control_files is None')
1073
self.control_files = _control_files
1074
if deprecated_passed(init):
1075
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1076
"deprecated as of bzr 0.8. Please use Branch.create().",
1080
# this is slower than before deprecation, oh well never mind.
1081
# -> its deprecated.
1082
self._initialize(transport.base)
1083
self._check_format(_format)
1084
if deprecated_passed(relax_version_check):
1085
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1086
"relax_version_check parameter is deprecated as of bzr 0.8. "
1087
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1091
if (not relax_version_check
1092
and not self._format.is_supported()):
1093
raise errors.UnsupportedFormatError(format=fmt)
1094
if deprecated_passed(transport):
1095
warn("BzrBranch.__init__(transport=XXX...): The transport "
1096
"parameter is deprecated as of bzr 0.8. "
1097
"Please use Branch.open, or bzrdir.open_branch().",
1100
self.repository = _repository
1103
return '%s(%r)' % (self.__class__.__name__, self.base)
1107
def _get_base(self):
1110
base = property(_get_base, doc="The URL for the root of this branch.")
1112
def _finish_transaction(self):
1113
"""Exit the current transaction."""
1114
return self.control_files._finish_transaction()
1116
def get_transaction(self):
1117
"""Return the current active transaction.
1119
If no transaction is active, this returns a passthrough object
1120
for which all data is immediately flushed and no caching happens.
1122
# this is an explicit function so that we can do tricky stuff
1123
# when the storage in rev_storage is elsewhere.
1124
# we probably need to hook the two 'lock a location' and
1125
# 'have a transaction' together more delicately, so that
1126
# we can have two locks (branch and storage) and one transaction
1127
# ... and finishing the transaction unlocks both, but unlocking
1128
# does not. - RBC 20051121
1129
return self.control_files.get_transaction()
1131
def _set_transaction(self, transaction):
1132
"""Set a new active transaction."""
1133
return self.control_files._set_transaction(transaction)
1135
def abspath(self, name):
1136
"""See Branch.abspath."""
1137
return self.control_files._transport.abspath(name)
1139
def _check_format(self, format):
1140
"""Identify the branch format if needed.
1142
The format is stored as a reference to the format object in
1143
self._format for code that needs to check it later.
1145
The format parameter is either None or the branch format class
1146
used to open this branch.
1148
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1151
format = BranchFormat.find_format(self.bzrdir)
1152
self._format = format
1153
mutter("got branch format %s", self._format)
1156
def get_root_id(self):
1157
"""See Branch.get_root_id."""
1158
tree = self.repository.revision_tree(self.last_revision())
1159
return tree.inventory.root.file_id
1161
def is_locked(self):
1162
return self.control_files.is_locked()
1164
def lock_write(self, tokens=None):
1165
if tokens is not None:
1166
branch_token, repo_token = tokens
1168
branch_token = repo_token = None
1169
repo_token = self.repository.lock_write(token=repo_token)
1171
branch_token = self.control_files.lock_write(token=branch_token)
1173
self.repository.unlock()
1176
tokens = (branch_token, repo_token)
1177
assert tokens == (None, None) or None not in tokens, (
1178
'Both branch and repository locks must return tokens, or else '
1179
'neither must return tokens. Got %r.' % (tokens,))
1180
if tokens == (None, None):
1185
def lock_read(self):
1186
self.repository.lock_read()
1188
self.control_files.lock_read()
1190
self.repository.unlock()
1194
# TODO: test for failed two phase locks. This is known broken.
1196
self.control_files.unlock()
1198
self.repository.unlock()
1200
def peek_lock_mode(self):
1201
if self.control_files._lock_count == 0:
1204
return self.control_files._lock_mode
1206
def get_physical_lock_status(self):
1207
return self.control_files.get_physical_lock_status()
1210
def print_file(self, file, revision_id):
1211
"""See Branch.print_file."""
1212
return self.repository.print_file(file, revision_id)
1215
def append_revision(self, *revision_ids):
1216
"""See Branch.append_revision."""
1217
for revision_id in revision_ids:
1218
_mod_revision.check_not_reserved_id(revision_id)
1219
mutter("add {%s} to revision-history" % revision_id)
1220
rev_history = self.revision_history()
1221
rev_history.extend(revision_ids)
1222
self.set_revision_history(rev_history)
1225
def set_revision_history(self, rev_history):
1226
"""See Branch.set_revision_history."""
1227
self.control_files.put_utf8(
1228
'revision-history', '\n'.join(rev_history))
1229
transaction = self.get_transaction()
1230
history = transaction.map.find_revision_history()
1231
if history is not None:
1232
# update the revision history in the identity map.
1233
history[:] = list(rev_history)
1234
# this call is disabled because revision_history is
1235
# not really an object yet, and the transaction is for objects.
1236
# transaction.register_dirty(history)
1238
transaction.map.add_revision_history(rev_history)
1239
# this call is disabled because revision_history is
1240
# not really an object yet, and the transaction is for objects.
1241
# transaction.register_clean(history)
1242
for hook in Branch.hooks['set_rh']:
1243
hook(self, rev_history)
1246
def revision_history(self):
1247
"""See Branch.revision_history."""
1248
transaction = self.get_transaction()
1249
history = transaction.map.find_revision_history()
1250
if history is not None:
1251
# mutter("cache hit for revision-history in %s", self)
1252
return list(history)
1253
decode_utf8 = cache_utf8.decode
1254
history = [decode_utf8(l.rstrip('\r\n')) for l in
1255
self.control_files.get('revision-history').readlines()]
1256
transaction.map.add_revision_history(history)
1257
# this call is disabled because revision_history is
1258
# not really an object yet, and the transaction is for objects.
1259
# transaction.register_clean(history, precious=True)
1260
return list(history)
1263
def generate_revision_history(self, revision_id, last_rev=None,
1265
"""Create a new revision history that will finish with revision_id.
1267
:param revision_id: the new tip to use.
1268
:param last_rev: The previous last_revision. If not None, then this
1269
must be a ancestory of revision_id, or DivergedBranches is raised.
1270
:param other_branch: The other branch that DivergedBranches should
1271
raise with respect to.
1273
# stop_revision must be a descendant of last_revision
1274
stop_graph = self.repository.get_revision_graph(revision_id)
1275
if last_rev is not None and last_rev not in stop_graph:
1276
# our previous tip is not merged into stop_revision
1277
raise errors.DivergedBranches(self, other_branch)
1278
# make a new revision history from the graph
1279
current_rev_id = revision_id
1281
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1282
new_history.append(current_rev_id)
1283
current_rev_id_parents = stop_graph[current_rev_id]
1285
current_rev_id = current_rev_id_parents[0]
1287
current_rev_id = None
1288
new_history.reverse()
1289
self.set_revision_history(new_history)
1292
def update_revisions(self, other, stop_revision=None):
1293
"""See Branch.update_revisions."""
1296
if stop_revision is None:
1297
stop_revision = other.last_revision()
1298
if stop_revision is None:
1299
# if there are no commits, we're done.
1301
# whats the current last revision, before we fetch [and change it
1303
last_rev = self.last_revision()
1304
# we fetch here regardless of whether we need to so that we pickup
1306
self.fetch(other, stop_revision)
1307
my_ancestry = self.repository.get_ancestry(last_rev)
1308
if stop_revision in my_ancestry:
1309
# last_revision is a descendant of stop_revision
1311
self.generate_revision_history(stop_revision, last_rev=last_rev,
1316
def basis_tree(self):
1317
"""See Branch.basis_tree."""
1318
return self.repository.revision_tree(self.last_revision())
1320
@deprecated_method(zero_eight)
1321
def working_tree(self):
1322
"""Create a Working tree object for this branch."""
1324
from bzrlib.transport.local import LocalTransport
1325
if (self.base.find('://') != -1 or
1326
not isinstance(self._transport, LocalTransport)):
1327
raise NoWorkingTree(self.base)
1328
return self.bzrdir.open_workingtree()
1331
def pull(self, source, overwrite=False, stop_revision=None,
1332
_hook_master=None, _run_hooks=True):
1335
:param _hook_master: Private parameter - set the branch to
1336
be supplied as the master to push hooks.
1337
:param _run_hooks: Private parameter - allow disabling of
1338
hooks, used when pushing to a master branch.
1342
old_count, old_tip = self.last_revision_info()
1344
self.update_revisions(source, stop_revision)
1345
except DivergedBranches:
1349
self.set_revision_history(source.revision_history())
1350
new_count, new_tip = self.last_revision_info()
1357
for hook in Branch.hooks['post_pull']:
1358
hook(source, _hook_local, _hook_master, old_count, old_tip,
1360
return new_count - old_count
1365
def push(self, target, overwrite=False, stop_revision=None,
1366
_hook_master=None, _run_hooks=True):
1369
:param _hook_master: Private parameter - set the branch to
1370
be supplied as the master to push hooks.
1371
:param _run_hooks: Private parameter - allow disabling of
1372
hooks, used when pushing to a master branch.
1376
old_count, old_tip = target.last_revision_info()
1378
target.update_revisions(self, stop_revision)
1379
except DivergedBranches:
1383
target.set_revision_history(self.revision_history())
1384
new_count, new_tip = target.last_revision_info()
1387
_hook_local = target
1389
_hook_master = target
1391
for hook in Branch.hooks['post_push']:
1392
hook(self, _hook_local, _hook_master, old_count, old_tip,
1394
return new_count - old_count
1398
def get_parent(self):
1399
"""See Branch.get_parent."""
1401
_locs = ['parent', 'pull', 'x-pull']
1402
assert self.base[-1] == '/'
1405
parent = self.control_files.get(l).read().strip('\n')
1408
# This is an old-format absolute path to a local branch
1409
# turn it into a url
1410
if parent.startswith('/'):
1411
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1413
return urlutils.join(self.base[:-1], parent)
1414
except errors.InvalidURLJoin, e:
1415
raise errors.InaccessibleParent(parent, self.base)
1418
def set_push_location(self, location):
1419
"""See Branch.set_push_location."""
1420
self.get_config().set_user_option(
1421
'push_location', location,
1422
store=_mod_config.STORE_LOCATION_NORECURSE)
1425
def set_parent(self, url):
1426
"""See Branch.set_parent."""
1427
# TODO: Maybe delete old location files?
1428
# URLs should never be unicode, even on the local fs,
1429
# FIXUP this and get_parent in a future branch format bump:
1430
# read and rewrite the file, and have the new format code read
1431
# using .get not .get_utf8. RBC 20060125
1433
self.control_files._transport.delete('parent')
1435
if isinstance(url, unicode):
1437
url = url.encode('ascii')
1438
except UnicodeEncodeError:
1439
raise bzrlib.errors.InvalidURL(url,
1440
"Urls must be 7-bit ascii, "
1441
"use bzrlib.urlutils.escape")
1443
url = urlutils.relative_url(self.base, url)
1444
self.control_files.put('parent', StringIO(url + '\n'))
1446
@deprecated_function(zero_nine)
1447
def tree_config(self):
1448
"""DEPRECATED; call get_config instead.
1449
TreeConfig has become part of BranchConfig."""
1450
return TreeConfig(self)
1453
class BzrBranch5(BzrBranch):
1454
"""A format 5 branch. This supports new features over plan branches.
1456
It has support for a master_branch which is the data for bound branches.
1464
super(BzrBranch5, self).__init__(_format=_format,
1465
_control_files=_control_files,
1467
_repository=_repository)
1470
def pull(self, source, overwrite=False, stop_revision=None,
1472
"""Extends branch.pull to be bound branch aware.
1474
:param _run_hooks: Private parameter used to force hook running
1475
off during bound branch double-pushing.
1477
bound_location = self.get_bound_location()
1478
master_branch = None
1479
if bound_location and source.base != bound_location:
1480
# not pulling from master, so we need to update master.
1481
master_branch = self.get_master_branch()
1482
master_branch.lock_write()
1485
# pull from source into master.
1486
master_branch.pull(source, overwrite, stop_revision,
1488
return super(BzrBranch5, self).pull(source, overwrite,
1489
stop_revision, _hook_master=master_branch,
1490
_run_hooks=_run_hooks)
1493
master_branch.unlock()
1496
def push(self, target, overwrite=False, stop_revision=None):
1497
"""Updates branch.push to be bound branch aware."""
1498
bound_location = target.get_bound_location()
1499
master_branch = None
1500
if bound_location and target.base != bound_location:
1501
# not pushing to master, so we need to update master.
1502
master_branch = target.get_master_branch()
1503
master_branch.lock_write()
1506
# push into the master from this branch.
1507
super(BzrBranch5, self).push(master_branch, overwrite,
1508
stop_revision, _run_hooks=False)
1509
# and push into the target branch from this. Note that we push from
1510
# this branch again, because its considered the highest bandwidth
1512
return super(BzrBranch5, self).push(target, overwrite,
1513
stop_revision, _hook_master=master_branch)
1516
master_branch.unlock()
1518
def get_bound_location(self):
1520
return self.control_files.get_utf8('bound').read()[:-1]
1521
except errors.NoSuchFile:
1525
def get_master_branch(self):
1526
"""Return the branch we are bound to.
1528
:return: Either a Branch, or None
1530
This could memoise the branch, but if thats done
1531
it must be revalidated on each new lock.
1532
So for now we just don't memoise it.
1533
# RBC 20060304 review this decision.
1535
bound_loc = self.get_bound_location()
1539
return Branch.open(bound_loc)
1540
except (errors.NotBranchError, errors.ConnectionError), e:
1541
raise errors.BoundBranchConnectionFailure(
1545
def set_bound_location(self, location):
1546
"""Set the target where this branch is bound to.
1548
:param location: URL to the target branch
1551
self.control_files.put_utf8('bound', location+'\n')
1554
self.control_files._transport.delete('bound')
1560
def bind(self, other):
1561
"""Bind this branch to the branch other.
1563
This does not push or pull data between the branches, though it does
1564
check for divergence to raise an error when the branches are not
1565
either the same, or one a prefix of the other. That behaviour may not
1566
be useful, so that check may be removed in future.
1568
:param other: The branch to bind to
1571
# TODO: jam 20051230 Consider checking if the target is bound
1572
# It is debatable whether you should be able to bind to
1573
# a branch which is itself bound.
1574
# Committing is obviously forbidden,
1575
# but binding itself may not be.
1576
# Since we *have* to check at commit time, we don't
1577
# *need* to check here
1579
# we want to raise diverged if:
1580
# last_rev is not in the other_last_rev history, AND
1581
# other_last_rev is not in our history, and do it without pulling
1583
last_rev = self.last_revision()
1584
if last_rev is not None:
1587
other_last_rev = other.last_revision()
1588
if other_last_rev is not None:
1589
# neither branch is new, we have to do some work to
1590
# ascertain diversion.
1591
remote_graph = other.repository.get_revision_graph(
1593
local_graph = self.repository.get_revision_graph(last_rev)
1594
if (last_rev not in remote_graph and
1595
other_last_rev not in local_graph):
1596
raise errors.DivergedBranches(self, other)
1599
self.set_bound_location(other.base)
1603
"""If bound, unbind"""
1604
return self.set_bound_location(None)
1608
"""Synchronise this branch with the master branch if any.
1610
:return: None or the last_revision that was pivoted out during the
1613
master = self.get_master_branch()
1614
if master is not None:
1615
old_tip = self.last_revision()
1616
self.pull(master, overwrite=True)
1617
if old_tip in self.repository.get_ancestry(self.last_revision()):
1623
class BranchTestProviderAdapter(object):
1624
"""A tool to generate a suite testing multiple branch formats at once.
1626
This is done by copying the test once for each transport and injecting
1627
the transport_server, transport_readonly_server, and branch_format
1628
classes into each copy. Each copy is also given a new id() to make it
1632
def __init__(self, transport_server, transport_readonly_server, formats,
1633
vfs_transport_factory=None):
1634
self._transport_server = transport_server
1635
self._transport_readonly_server = transport_readonly_server
1636
self._formats = formats
1637
self._vfs_transport_factory = vfs_transport_factory
1639
def adapt(self, test):
1640
result = TestSuite()
1641
for branch_format, bzrdir_format in self._formats:
1642
new_test = deepcopy(test)
1643
new_test.transport_server = self._transport_server
1644
new_test.transport_readonly_server = self._transport_readonly_server
1645
if self._vfs_transport_factory:
1646
new_test.vfs_transport_factory = self._vfs_transport_factory
1647
new_test.bzrdir_format = bzrdir_format
1648
new_test.branch_format = branch_format
1649
def make_new_test_id():
1650
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1651
return lambda: new_id
1652
new_test.id = make_new_test_id()
1653
result.addTest(new_test)
1657
class BranchCheckResult(object):
1658
"""Results of checking branch consistency.
1663
def __init__(self, branch):
1664
self.branch = branch
1666
def report_results(self, verbose):
1667
"""Report the check results via trace.note.
1669
:param verbose: Requests more detailed display of what was checked,
1672
note('checked branch %s format %s',
1674
self.branch._format)
1677
######################################################################
1681
@deprecated_function(zero_eight)
1682
def is_control_file(*args, **kwargs):
1683
"""See bzrlib.workingtree.is_control_file."""
1684
from bzrlib import workingtree
1685
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
