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
raise NotImplementedError(self.get_push_location)
458
def set_push_location(self, location):
459
"""Set a new push location for this branch."""
460
raise NotImplementedError(self.set_push_location)
462
def set_parent(self, url):
463
raise NotImplementedError(self.set_parent)
467
"""Synchronise this branch with the master branch if any.
469
:return: None or the last_revision pivoted out during the update.
473
def check_revno(self, revno):
475
Check whether a revno corresponds to any revision.
476
Zero (the NULL revision) is considered valid.
479
self.check_real_revno(revno)
481
def check_real_revno(self, revno):
483
Check whether a revno corresponds to a real revision.
484
Zero (the NULL revision) is considered invalid
486
if revno < 1 or revno > self.revno():
487
raise InvalidRevisionNumber(revno)
490
def clone(self, *args, **kwargs):
491
"""Clone this branch into to_bzrdir preserving all semantic values.
493
revision_id: if not None, the revision history in the new branch will
494
be truncated to end with revision_id.
496
# for API compatibility, until 0.8 releases we provide the old api:
497
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
498
# after 0.8 releases, the *args and **kwargs should be changed:
499
# def clone(self, to_bzrdir, revision_id=None):
500
if (kwargs.get('to_location', None) or
501
kwargs.get('revision', None) or
502
kwargs.get('basis_branch', None) or
503
(len(args) and isinstance(args[0], basestring))):
504
# backwards compatibility api:
505
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
506
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
509
basis_branch = args[2]
511
basis_branch = kwargs.get('basis_branch', None)
513
basis = basis_branch.bzrdir
518
revision_id = args[1]
520
revision_id = kwargs.get('revision', None)
525
# no default to raise if not provided.
526
url = kwargs.get('to_location')
527
return self.bzrdir.clone(url,
528
revision_id=revision_id,
529
basis=basis).open_branch()
531
# generate args by hand
533
revision_id = args[1]
535
revision_id = kwargs.get('revision_id', None)
539
# no default to raise if not provided.
540
to_bzrdir = kwargs.get('to_bzrdir')
541
result = self._format.initialize(to_bzrdir)
542
self.copy_content_into(result, revision_id=revision_id)
546
def sprout(self, to_bzrdir, revision_id=None):
547
"""Create a new line of development from the branch, into to_bzrdir.
549
revision_id: if not None, the revision history in the new branch will
550
be truncated to end with revision_id.
552
result = self._format.initialize(to_bzrdir)
553
self.copy_content_into(result, revision_id=revision_id)
554
result.set_parent(self.bzrdir.root_transport.base)
558
def copy_content_into(self, destination, revision_id=None):
559
"""Copy the content of self into destination.
561
revision_id: if not None, the revision history in the new branch will
562
be truncated to end with revision_id.
564
new_history = self.revision_history()
565
if revision_id is not None:
567
new_history = new_history[:new_history.index(revision_id) + 1]
569
rev = self.repository.get_revision(revision_id)
570
new_history = rev.get_history(self.repository)[1:]
571
destination.set_revision_history(new_history)
573
parent = self.get_parent()
574
except errors.InaccessibleParent, e:
575
mutter('parent was not accessible to copy: %s', e)
578
destination.set_parent(parent)
582
"""Check consistency of the branch.
584
In particular this checks that revisions given in the revision-history
585
do actually match up in the revision graph, and that they're all
586
present in the repository.
588
Callers will typically also want to check the repository.
590
:return: A BranchCheckResult.
592
mainline_parent_id = None
593
for revision_id in self.revision_history():
595
revision = self.repository.get_revision(revision_id)
596
except errors.NoSuchRevision, e:
597
raise errors.BzrCheckError("mainline revision {%s} not in repository"
599
# In general the first entry on the revision history has no parents.
600
# But it's not illegal for it to have parents listed; this can happen
601
# in imports from Arch when the parents weren't reachable.
602
if mainline_parent_id is not None:
603
if mainline_parent_id not in revision.parent_ids:
604
raise errors.BzrCheckError("previous revision {%s} not listed among "
606
% (mainline_parent_id, revision_id))
607
mainline_parent_id = revision_id
608
return BranchCheckResult(self)
610
def _get_checkout_format(self):
611
"""Return the most suitable metadir for a checkout of this branch.
612
Weaves are used if this branch's repostory uses weaves.
614
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
615
from bzrlib import repository
616
format = bzrdir.BzrDirMetaFormat1()
617
format.repository_format = repository.RepositoryFormat7()
619
format = self.repository.bzrdir.cloning_metadir()
622
def create_checkout(self, to_location, revision_id=None,
624
"""Create a checkout of a branch.
626
:param to_location: The url to produce the checkout at
627
:param revision_id: The revision to check out
628
:param lightweight: If True, produce a lightweight checkout, otherwise,
629
produce a bound branch (heavyweight checkout)
630
:return: The tree of the created checkout
632
t = transport.get_transport(to_location)
635
except errors.FileExists:
638
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
639
BranchReferenceFormat().initialize(checkout, self)
641
format = self._get_checkout_format()
642
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
643
to_location, force_new_tree=False, format=format)
644
checkout = checkout_branch.bzrdir
645
checkout_branch.bind(self)
646
# pull up to the specified revision_id to set the initial
647
# branch tip correctly, and seed it with history.
648
checkout_branch.pull(self, stop_revision=revision_id)
649
return checkout.create_workingtree(revision_id)
652
class BranchFormat(object):
653
"""An encapsulation of the initialization and open routines for a format.
655
Formats provide three things:
656
* An initialization routine,
660
Formats are placed in an dict by their format string for reference
661
during branch opening. Its not required that these be instances, they
662
can be classes themselves with class methods - it simply depends on
663
whether state is needed for a given format or not.
665
Once a format is deprecated, just deprecate the initialize and open
666
methods on the format class. Do not deprecate the object, as the
667
object will be created every time regardless.
670
_default_format = None
671
"""The default format used for new branches."""
674
"""The known formats."""
677
def find_format(klass, a_bzrdir):
678
"""Return the format for the branch object in a_bzrdir."""
680
transport = a_bzrdir.get_branch_transport(None)
681
format_string = transport.get("format").read()
682
return klass._formats[format_string]
684
raise NotBranchError(path=transport.base)
686
raise errors.UnknownFormatError(format=format_string)
689
def get_default_format(klass):
690
"""Return the current default format."""
691
return klass._default_format
693
def get_format_string(self):
694
"""Return the ASCII format string that identifies this format."""
695
raise NotImplementedError(self.get_format_string)
697
def get_format_description(self):
698
"""Return the short format description for this format."""
699
raise NotImplementedError(self.get_format_string)
701
def initialize(self, a_bzrdir):
702
"""Create a branch of this format in a_bzrdir."""
703
raise NotImplementedError(self.initialize)
705
def is_supported(self):
706
"""Is this format supported?
708
Supported formats can be initialized and opened.
709
Unsupported formats may not support initialization or committing or
710
some other features depending on the reason for not being supported.
714
def open(self, a_bzrdir, _found=False):
715
"""Return the branch object for a_bzrdir
717
_found is a private parameter, do not use it. It is used to indicate
718
if format probing has already be done.
720
raise NotImplementedError(self.open)
723
def register_format(klass, format):
724
klass._formats[format.get_format_string()] = format
727
def set_default_format(klass, format):
728
klass._default_format = format
731
def unregister_format(klass, format):
732
assert klass._formats[format.get_format_string()] is format
733
del klass._formats[format.get_format_string()]
736
return self.get_format_string().rstrip()
739
class BranchHooks(dict):
740
"""A dictionary mapping hook name to a list of callables for branch hooks.
742
e.g. ['set_rh'] Is the list of items to be called when the
743
set_revision_history function is invoked.
747
"""Create the default hooks.
749
These are all empty initially, because by default nothing should get
753
# invoked whenever the revision history has been set
754
# with set_revision_history. The api signature is
755
# (branch, revision_history), and the branch will
756
# be write-locked. Introduced in 0.15.
759
def install_hook(self, hook_name, a_callable):
760
"""Install a_callable in to the hook hook_name.
762
:param hook_name: A hook name. See the __init__ method of BranchHooks
763
for the complete list of hooks.
764
:param a_callable: The callable to be invoked when the hook triggers.
765
The exact signature will depend on the hook - see the __init__
766
method of BranchHooks for details on each hook.
769
self[hook_name].append(a_callable)
771
raise errors.UnknownHook('branch', hook_name)
774
# install the default hooks into the Branch class.
775
Branch.hooks = BranchHooks()
778
class BzrBranchFormat4(BranchFormat):
779
"""Bzr branch format 4.
782
- a revision-history file.
783
- a branch-lock lock file [ to be shared with the bzrdir ]
786
def get_format_description(self):
787
"""See BranchFormat.get_format_description()."""
788
return "Branch format 4"
790
def initialize(self, a_bzrdir):
791
"""Create a branch of this format in a_bzrdir."""
792
mutter('creating branch in %s', a_bzrdir.transport.base)
793
branch_transport = a_bzrdir.get_branch_transport(self)
794
utf8_files = [('revision-history', ''),
797
control_files = lockable_files.LockableFiles(branch_transport,
798
'branch-lock', lockable_files.TransportLock)
799
control_files.create_lock()
800
control_files.lock_write()
802
for file, content in utf8_files:
803
control_files.put_utf8(file, content)
805
control_files.unlock()
806
return self.open(a_bzrdir, _found=True)
809
super(BzrBranchFormat4, self).__init__()
810
self._matchingbzrdir = bzrdir.BzrDirFormat6()
812
def open(self, a_bzrdir, _found=False):
813
"""Return the branch object for a_bzrdir
815
_found is a private parameter, do not use it. It is used to indicate
816
if format probing has already be done.
819
# we are being called directly and must probe.
820
raise NotImplementedError
821
return BzrBranch(_format=self,
822
_control_files=a_bzrdir._control_files,
824
_repository=a_bzrdir.open_repository())
827
return "Bazaar-NG branch format 4"
830
class BzrBranchFormat5(BranchFormat):
831
"""Bzr branch format 5.
834
- a revision-history file.
836
- a lock dir guarding the branch itself
837
- all of this stored in a branch/ subdirectory
838
- works with shared repositories.
840
This format is new in bzr 0.8.
843
def get_format_string(self):
844
"""See BranchFormat.get_format_string()."""
845
return "Bazaar-NG branch format 5\n"
847
def get_format_description(self):
848
"""See BranchFormat.get_format_description()."""
849
return "Branch format 5"
851
def initialize(self, a_bzrdir):
852
"""Create a branch of this format in a_bzrdir."""
853
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
854
branch_transport = a_bzrdir.get_branch_transport(self)
855
utf8_files = [('revision-history', ''),
858
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
860
control_files.create_lock()
861
control_files.lock_write()
862
control_files.put_utf8('format', self.get_format_string())
864
for file, content in utf8_files:
865
control_files.put_utf8(file, content)
867
control_files.unlock()
868
return self.open(a_bzrdir, _found=True, )
871
super(BzrBranchFormat5, self).__init__()
872
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
874
def open(self, a_bzrdir, _found=False):
875
"""Return the branch object for a_bzrdir
877
_found is a private parameter, do not use it. It is used to indicate
878
if format probing has already be done.
881
format = BranchFormat.find_format(a_bzrdir)
882
assert format.__class__ == self.__class__
883
transport = a_bzrdir.get_branch_transport(None)
884
control_files = lockable_files.LockableFiles(transport, 'lock',
886
return BzrBranch5(_format=self,
887
_control_files=control_files,
889
_repository=a_bzrdir.find_repository())
892
return "Bazaar-NG Metadir branch format 5"
895
class BranchReferenceFormat(BranchFormat):
896
"""Bzr branch reference format.
898
Branch references are used in implementing checkouts, they
899
act as an alias to the real branch which is at some other url.
906
def get_format_string(self):
907
"""See BranchFormat.get_format_string()."""
908
return "Bazaar-NG Branch Reference Format 1\n"
910
def get_format_description(self):
911
"""See BranchFormat.get_format_description()."""
912
return "Checkout reference format 1"
914
def initialize(self, a_bzrdir, target_branch=None):
915
"""Create a branch of this format in a_bzrdir."""
916
if target_branch is None:
917
# this format does not implement branch itself, thus the implicit
918
# creation contract must see it as uninitializable
919
raise errors.UninitializableFormat(self)
920
mutter('creating branch reference in %s', a_bzrdir.transport.base)
921
branch_transport = a_bzrdir.get_branch_transport(self)
922
branch_transport.put_bytes('location',
923
target_branch.bzrdir.root_transport.base)
924
branch_transport.put_bytes('format', self.get_format_string())
925
return self.open(a_bzrdir, _found=True)
928
super(BranchReferenceFormat, self).__init__()
929
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
931
def _make_reference_clone_function(format, a_branch):
932
"""Create a clone() routine for a branch dynamically."""
933
def clone(to_bzrdir, revision_id=None):
934
"""See Branch.clone()."""
935
return format.initialize(to_bzrdir, a_branch)
936
# cannot obey revision_id limits when cloning a reference ...
937
# FIXME RBC 20060210 either nuke revision_id for clone, or
938
# emit some sort of warning/error to the caller ?!
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch that the branch reference in a_bzrdir points at.
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
948
format = BranchFormat.find_format(a_bzrdir)
949
assert format.__class__ == self.__class__
950
transport = a_bzrdir.get_branch_transport(None)
951
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
952
result = real_bzrdir.open_branch()
953
# this changes the behaviour of result.clone to create a new reference
954
# rather than a copy of the content of the branch.
955
# I did not use a proxy object because that needs much more extensive
956
# testing, and we are only changing one behaviour at the moment.
957
# If we decide to alter more behaviours - i.e. the implicit nickname
958
# then this should be refactored to introduce a tested proxy branch
959
# and a subclass of that for use in overriding clone() and ....
961
result.clone = self._make_reference_clone_function(result)
965
# formats which have no format string are not discoverable
966
# and not independently creatable, so are not registered.
967
__default_format = BzrBranchFormat5()
968
BranchFormat.register_format(__default_format)
969
BranchFormat.register_format(BranchReferenceFormat())
970
BranchFormat.set_default_format(__default_format)
971
_legacy_formats = [BzrBranchFormat4(),
974
class BzrBranch(Branch):
975
"""A branch stored in the actual filesystem.
977
Note that it's "local" in the context of the filesystem; it doesn't
978
really matter if it's on an nfs/smb/afs/coda/... share, as long as
979
it's writable, and can be accessed via the normal filesystem API.
982
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
983
relax_version_check=DEPRECATED_PARAMETER, _format=None,
984
_control_files=None, a_bzrdir=None, _repository=None):
985
"""Create new branch object at a particular location.
987
transport -- A Transport object, defining how to access files.
989
init -- If True, create new control files in a previously
990
unversioned directory. If False, the branch must already
993
relax_version_check -- If true, the usual check for the branch
994
version is not applied. This is intended only for
995
upgrade/recovery type use; it's not guaranteed that
996
all operations will work on old format branches.
999
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1001
self.bzrdir = a_bzrdir
1002
self._transport = self.bzrdir.transport.clone('..')
1003
self._base = self._transport.base
1004
self._format = _format
1005
if _control_files is None:
1006
raise ValueError('BzrBranch _control_files is None')
1007
self.control_files = _control_files
1008
if deprecated_passed(init):
1009
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1010
"deprecated as of bzr 0.8. Please use Branch.create().",
1014
# this is slower than before deprecation, oh well never mind.
1015
# -> its deprecated.
1016
self._initialize(transport.base)
1017
self._check_format(_format)
1018
if deprecated_passed(relax_version_check):
1019
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1020
"relax_version_check parameter is deprecated as of bzr 0.8. "
1021
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1025
if (not relax_version_check
1026
and not self._format.is_supported()):
1027
raise errors.UnsupportedFormatError(format=fmt)
1028
if deprecated_passed(transport):
1029
warn("BzrBranch.__init__(transport=XXX...): The transport "
1030
"parameter is deprecated as of bzr 0.8. "
1031
"Please use Branch.open, or bzrdir.open_branch().",
1034
self.repository = _repository
1037
return '%s(%r)' % (self.__class__.__name__, self.base)
1041
def _get_base(self):
1044
base = property(_get_base, doc="The URL for the root of this branch.")
1046
def _finish_transaction(self):
1047
"""Exit the current transaction."""
1048
return self.control_files._finish_transaction()
1050
def get_transaction(self):
1051
"""Return the current active transaction.
1053
If no transaction is active, this returns a passthrough object
1054
for which all data is immediately flushed and no caching happens.
1056
# this is an explicit function so that we can do tricky stuff
1057
# when the storage in rev_storage is elsewhere.
1058
# we probably need to hook the two 'lock a location' and
1059
# 'have a transaction' together more delicately, so that
1060
# we can have two locks (branch and storage) and one transaction
1061
# ... and finishing the transaction unlocks both, but unlocking
1062
# does not. - RBC 20051121
1063
return self.control_files.get_transaction()
1065
def _set_transaction(self, transaction):
1066
"""Set a new active transaction."""
1067
return self.control_files._set_transaction(transaction)
1069
def abspath(self, name):
1070
"""See Branch.abspath."""
1071
return self.control_files._transport.abspath(name)
1073
def _check_format(self, format):
1074
"""Identify the branch format if needed.
1076
The format is stored as a reference to the format object in
1077
self._format for code that needs to check it later.
1079
The format parameter is either None or the branch format class
1080
used to open this branch.
1082
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1085
format = BranchFormat.find_format(self.bzrdir)
1086
self._format = format
1087
mutter("got branch format %s", self._format)
1090
def get_root_id(self):
1091
"""See Branch.get_root_id."""
1092
tree = self.repository.revision_tree(self.last_revision())
1093
return tree.inventory.root.file_id
1095
def is_locked(self):
1096
return self.control_files.is_locked()
1098
def lock_write(self):
1099
self.repository.lock_write()
1101
self.control_files.lock_write()
1103
self.repository.unlock()
1106
def lock_read(self):
1107
self.repository.lock_read()
1109
self.control_files.lock_read()
1111
self.repository.unlock()
1115
# TODO: test for failed two phase locks. This is known broken.
1117
self.control_files.unlock()
1119
self.repository.unlock()
1121
def peek_lock_mode(self):
1122
if self.control_files._lock_count == 0:
1125
return self.control_files._lock_mode
1127
def get_physical_lock_status(self):
1128
return self.control_files.get_physical_lock_status()
1131
def print_file(self, file, revision_id):
1132
"""See Branch.print_file."""
1133
return self.repository.print_file(file, revision_id)
1136
def append_revision(self, *revision_ids):
1137
"""See Branch.append_revision."""
1138
for revision_id in revision_ids:
1139
_mod_revision.check_not_reserved_id(revision_id)
1140
mutter("add {%s} to revision-history" % revision_id)
1141
rev_history = self.revision_history()
1142
rev_history.extend(revision_ids)
1143
self.set_revision_history(rev_history)
1146
def set_revision_history(self, rev_history):
1147
"""See Branch.set_revision_history."""
1148
self.control_files.put_utf8(
1149
'revision-history', '\n'.join(rev_history))
1150
transaction = self.get_transaction()
1151
history = transaction.map.find_revision_history()
1152
if history is not None:
1153
# update the revision history in the identity map.
1154
history[:] = list(rev_history)
1155
# this call is disabled because revision_history is
1156
# not really an object yet, and the transaction is for objects.
1157
# transaction.register_dirty(history)
1159
transaction.map.add_revision_history(rev_history)
1160
# this call is disabled because revision_history is
1161
# not really an object yet, and the transaction is for objects.
1162
# transaction.register_clean(history)
1163
for hook in Branch.hooks['set_rh']:
1164
hook(self, rev_history)
1167
def revision_history(self):
1168
"""See Branch.revision_history."""
1169
transaction = self.get_transaction()
1170
history = transaction.map.find_revision_history()
1171
if history is not None:
1172
# mutter("cache hit for revision-history in %s", self)
1173
return list(history)
1174
decode_utf8 = cache_utf8.decode
1175
history = [decode_utf8(l.rstrip('\r\n')) for l in
1176
self.control_files.get('revision-history').readlines()]
1177
transaction.map.add_revision_history(history)
1178
# this call is disabled because revision_history is
1179
# not really an object yet, and the transaction is for objects.
1180
# transaction.register_clean(history, precious=True)
1181
return list(history)
1184
def generate_revision_history(self, revision_id, last_rev=None,
1186
"""Create a new revision history that will finish with revision_id.
1188
:param revision_id: the new tip to use.
1189
:param last_rev: The previous last_revision. If not None, then this
1190
must be a ancestory of revision_id, or DivergedBranches is raised.
1191
:param other_branch: The other branch that DivergedBranches should
1192
raise with respect to.
1194
# stop_revision must be a descendant of last_revision
1195
stop_graph = self.repository.get_revision_graph(revision_id)
1196
if last_rev is not None and last_rev not in stop_graph:
1197
# our previous tip is not merged into stop_revision
1198
raise errors.DivergedBranches(self, other_branch)
1199
# make a new revision history from the graph
1200
current_rev_id = revision_id
1202
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1203
new_history.append(current_rev_id)
1204
current_rev_id_parents = stop_graph[current_rev_id]
1206
current_rev_id = current_rev_id_parents[0]
1208
current_rev_id = None
1209
new_history.reverse()
1210
self.set_revision_history(new_history)
1213
def update_revisions(self, other, stop_revision=None):
1214
"""See Branch.update_revisions."""
1217
if stop_revision is None:
1218
stop_revision = other.last_revision()
1219
if stop_revision is None:
1220
# if there are no commits, we're done.
1222
# whats the current last revision, before we fetch [and change it
1224
last_rev = self.last_revision()
1225
# we fetch here regardless of whether we need to so that we pickup
1227
self.fetch(other, stop_revision)
1228
my_ancestry = self.repository.get_ancestry(last_rev)
1229
if stop_revision in my_ancestry:
1230
# last_revision is a descendant of stop_revision
1232
self.generate_revision_history(stop_revision, last_rev=last_rev,
1237
def basis_tree(self):
1238
"""See Branch.basis_tree."""
1239
return self.repository.revision_tree(self.last_revision())
1241
@deprecated_method(zero_eight)
1242
def working_tree(self):
1243
"""Create a Working tree object for this branch."""
1245
from bzrlib.transport.local import LocalTransport
1246
if (self.base.find('://') != -1 or
1247
not isinstance(self._transport, LocalTransport)):
1248
raise NoWorkingTree(self.base)
1249
return self.bzrdir.open_workingtree()
1252
def pull(self, source, overwrite=False, stop_revision=None):
1253
"""See Branch.pull."""
1256
old_count = self.last_revision_info()[0]
1258
self.update_revisions(source, stop_revision)
1259
except DivergedBranches:
1263
self.set_revision_history(source.revision_history())
1264
new_count = self.last_revision_info()[0]
1265
return new_count - old_count
1270
def push(self, target, overwrite=False, stop_revision=None):
1271
"""See Branch.push."""
1274
old_count = len(target.revision_history())
1276
target.update_revisions(self, stop_revision)
1277
except DivergedBranches:
1281
target.set_revision_history(self.revision_history())
1282
new_count = len(target.revision_history())
1283
return new_count - old_count
1287
def get_parent(self):
1288
"""See Branch.get_parent."""
1290
_locs = ['parent', 'pull', 'x-pull']
1291
assert self.base[-1] == '/'
1294
parent = self.control_files.get(l).read().strip('\n')
1297
# This is an old-format absolute path to a local branch
1298
# turn it into a url
1299
if parent.startswith('/'):
1300
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1302
return urlutils.join(self.base[:-1], parent)
1303
except errors.InvalidURLJoin, e:
1304
raise errors.InaccessibleParent(parent, self.base)
1307
def get_push_location(self):
1308
"""See Branch.get_push_location."""
1309
push_loc = self.get_config().get_user_option('push_location')
1312
def set_push_location(self, location):
1313
"""See Branch.set_push_location."""
1314
self.get_config().set_user_option(
1315
'push_location', location,
1316
store=_mod_config.STORE_LOCATION_NORECURSE)
1319
def set_parent(self, url):
1320
"""See Branch.set_parent."""
1321
# TODO: Maybe delete old location files?
1322
# URLs should never be unicode, even on the local fs,
1323
# FIXUP this and get_parent in a future branch format bump:
1324
# read and rewrite the file, and have the new format code read
1325
# using .get not .get_utf8. RBC 20060125
1327
self.control_files._transport.delete('parent')
1329
if isinstance(url, unicode):
1331
url = url.encode('ascii')
1332
except UnicodeEncodeError:
1333
raise bzrlib.errors.InvalidURL(url,
1334
"Urls must be 7-bit ascii, "
1335
"use bzrlib.urlutils.escape")
1337
url = urlutils.relative_url(self.base, url)
1338
self.control_files.put('parent', StringIO(url + '\n'))
1340
@deprecated_function(zero_nine)
1341
def tree_config(self):
1342
"""DEPRECATED; call get_config instead.
1343
TreeConfig has become part of BranchConfig."""
1344
return TreeConfig(self)
1347
class BzrBranch5(BzrBranch):
1348
"""A format 5 branch. This supports new features over plan branches.
1350
It has support for a master_branch which is the data for bound branches.
1358
super(BzrBranch5, self).__init__(_format=_format,
1359
_control_files=_control_files,
1361
_repository=_repository)
1364
def pull(self, source, overwrite=False, stop_revision=None):
1365
"""Extends branch.pull to be bound branch aware."""
1366
bound_location = self.get_bound_location()
1367
if source.base != bound_location:
1368
# not pulling from master, so we need to update master.
1369
master_branch = self.get_master_branch()
1371
master_branch.pull(source)
1372
source = master_branch
1373
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1376
def push(self, target, overwrite=False, stop_revision=None):
1377
"""Updates branch.push to be bound branch aware."""
1378
bound_location = target.get_bound_location()
1379
if target.base != bound_location:
1380
# not pushing to master, so we need to update master.
1381
master_branch = target.get_master_branch()
1383
# push into the master from this branch.
1384
super(BzrBranch5, self).push(master_branch, overwrite,
1386
# and push into the target branch from this. Note that we push from
1387
# this branch again, because its considered the highest bandwidth
1389
return super(BzrBranch5, self).push(target, overwrite, stop_revision)
1391
def get_bound_location(self):
1393
return self.control_files.get_utf8('bound').read()[:-1]
1394
except errors.NoSuchFile:
1398
def get_master_branch(self):
1399
"""Return the branch we are bound to.
1401
:return: Either a Branch, or None
1403
This could memoise the branch, but if thats done
1404
it must be revalidated on each new lock.
1405
So for now we just don't memoise it.
1406
# RBC 20060304 review this decision.
1408
bound_loc = self.get_bound_location()
1412
return Branch.open(bound_loc)
1413
except (errors.NotBranchError, errors.ConnectionError), e:
1414
raise errors.BoundBranchConnectionFailure(
1418
def set_bound_location(self, location):
1419
"""Set the target where this branch is bound to.
1421
:param location: URL to the target branch
1424
self.control_files.put_utf8('bound', location+'\n')
1427
self.control_files._transport.delete('bound')
1433
def bind(self, other):
1434
"""Bind this branch to the branch other.
1436
This does not push or pull data between the branches, though it does
1437
check for divergence to raise an error when the branches are not
1438
either the same, or one a prefix of the other. That behaviour may not
1439
be useful, so that check may be removed in future.
1441
:param other: The branch to bind to
1444
# TODO: jam 20051230 Consider checking if the target is bound
1445
# It is debatable whether you should be able to bind to
1446
# a branch which is itself bound.
1447
# Committing is obviously forbidden,
1448
# but binding itself may not be.
1449
# Since we *have* to check at commit time, we don't
1450
# *need* to check here
1452
# we want to raise diverged if:
1453
# last_rev is not in the other_last_rev history, AND
1454
# other_last_rev is not in our history, and do it without pulling
1456
last_rev = self.last_revision()
1457
if last_rev is not None:
1460
other_last_rev = other.last_revision()
1461
if other_last_rev is not None:
1462
# neither branch is new, we have to do some work to
1463
# ascertain diversion.
1464
remote_graph = other.repository.get_revision_graph(
1466
local_graph = self.repository.get_revision_graph(last_rev)
1467
if (last_rev not in remote_graph and
1468
other_last_rev not in local_graph):
1469
raise errors.DivergedBranches(self, other)
1472
self.set_bound_location(other.base)
1476
"""If bound, unbind"""
1477
return self.set_bound_location(None)
1481
"""Synchronise this branch with the master branch if any.
1483
:return: None or the last_revision that was pivoted out during the
1486
master = self.get_master_branch()
1487
if master is not None:
1488
old_tip = self.last_revision()
1489
self.pull(master, overwrite=True)
1490
if old_tip in self.repository.get_ancestry(self.last_revision()):
1496
class BranchTestProviderAdapter(object):
1497
"""A tool to generate a suite testing multiple branch formats at once.
1499
This is done by copying the test once for each transport and injecting
1500
the transport_server, transport_readonly_server, and branch_format
1501
classes into each copy. Each copy is also given a new id() to make it
1505
def __init__(self, transport_server, transport_readonly_server, formats):
1506
self._transport_server = transport_server
1507
self._transport_readonly_server = transport_readonly_server
1508
self._formats = formats
1510
def adapt(self, test):
1511
result = TestSuite()
1512
for branch_format, bzrdir_format in self._formats:
1513
new_test = deepcopy(test)
1514
new_test.transport_server = self._transport_server
1515
new_test.transport_readonly_server = self._transport_readonly_server
1516
new_test.bzrdir_format = bzrdir_format
1517
new_test.branch_format = branch_format
1518
def make_new_test_id():
1519
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1520
return lambda: new_id
1521
new_test.id = make_new_test_id()
1522
result.addTest(new_test)
1526
class BranchCheckResult(object):
1527
"""Results of checking branch consistency.
1532
def __init__(self, branch):
1533
self.branch = branch
1535
def report_results(self, verbose):
1536
"""Report the check results via trace.note.
1538
:param verbose: Requests more detailed display of what was checked,
1541
note('checked branch %s format %s',
1543
self.branch._format)
1546
######################################################################
1550
@deprecated_function(zero_eight)
1551
def is_control_file(*args, **kwargs):
1552
"""See bzrlib.workingtree.is_control_file."""
1553
from bzrlib import workingtree
1554
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
