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 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_description)
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
# Introduced in 0.15:
754
# invoked whenever the revision history has been set
755
# with set_revision_history. The api signature is
756
# (branch, revision_history), and the branch will
759
# invoked after a push operation completes.
760
# the api signature is
761
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
762
# where local is the local branch or None, master is the target
763
# master branch, and the rest should be self explanatory. The source
764
# is read locked and the target branches write locked. Source will
765
# be the local low-latency branch.
766
self['post_push'] = []
767
# invoked after a pull operation completes.
768
# the api signature is
769
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
770
# where local is the local branch or None, master is the target
771
# master branch, and the rest should be self explanatory. The source
772
# is read locked and the target branches write locked. The local
773
# branch is the low-latency branch.
774
self['post_pull'] = []
775
# invoked after a commit operation completes.
776
# the api signature is
777
# (local, master, old_revno, old_revid, new_revno, new_revid)
778
# old_revid is NULL_REVISION for the first commit to a branch.
779
self['post_commit'] = []
780
# invoked after a uncommit operation completes.
781
# the api signature is
782
# (local, master, old_revno, old_revid, new_revno, new_revid) where
783
# local is the local branch or None, master is the target branch,
784
# and an empty branch recieves new_revno of 0, new_revid of None.
785
self['post_uncommit'] = []
787
def install_hook(self, hook_name, a_callable):
788
"""Install a_callable in to the hook hook_name.
790
:param hook_name: A hook name. See the __init__ method of BranchHooks
791
for the complete list of hooks.
792
:param a_callable: The callable to be invoked when the hook triggers.
793
The exact signature will depend on the hook - see the __init__
794
method of BranchHooks for details on each hook.
797
self[hook_name].append(a_callable)
799
raise errors.UnknownHook('branch', hook_name)
802
# install the default hooks into the Branch class.
803
Branch.hooks = BranchHooks()
806
class BzrBranchFormat4(BranchFormat):
807
"""Bzr branch format 4.
810
- a revision-history file.
811
- a branch-lock lock file [ to be shared with the bzrdir ]
814
def get_format_description(self):
815
"""See BranchFormat.get_format_description()."""
816
return "Branch format 4"
818
def initialize(self, a_bzrdir):
819
"""Create a branch of this format in a_bzrdir."""
820
mutter('creating branch in %s', a_bzrdir.transport.base)
821
branch_transport = a_bzrdir.get_branch_transport(self)
822
utf8_files = [('revision-history', ''),
825
control_files = lockable_files.LockableFiles(branch_transport,
826
'branch-lock', lockable_files.TransportLock)
827
control_files.create_lock()
828
control_files.lock_write()
830
for file, content in utf8_files:
831
control_files.put_utf8(file, content)
833
control_files.unlock()
834
return self.open(a_bzrdir, _found=True)
837
super(BzrBranchFormat4, self).__init__()
838
self._matchingbzrdir = bzrdir.BzrDirFormat6()
840
def open(self, a_bzrdir, _found=False):
841
"""Return the branch object for a_bzrdir
843
_found is a private parameter, do not use it. It is used to indicate
844
if format probing has already be done.
847
# we are being called directly and must probe.
848
raise NotImplementedError
849
return BzrBranch(_format=self,
850
_control_files=a_bzrdir._control_files,
852
_repository=a_bzrdir.open_repository())
855
return "Bazaar-NG branch format 4"
858
class BzrBranchFormat5(BranchFormat):
859
"""Bzr branch format 5.
862
- a revision-history file.
864
- a lock dir guarding the branch itself
865
- all of this stored in a branch/ subdirectory
866
- works with shared repositories.
868
This format is new in bzr 0.8.
871
def get_format_string(self):
872
"""See BranchFormat.get_format_string()."""
873
return "Bazaar-NG branch format 5\n"
875
def get_format_description(self):
876
"""See BranchFormat.get_format_description()."""
877
return "Branch format 5"
879
def initialize(self, a_bzrdir):
880
"""Create a branch of this format in a_bzrdir."""
881
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
882
branch_transport = a_bzrdir.get_branch_transport(self)
883
utf8_files = [('revision-history', ''),
886
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
888
control_files.create_lock()
889
control_files.lock_write()
890
control_files.put_utf8('format', self.get_format_string())
892
for file, content in utf8_files:
893
control_files.put_utf8(file, content)
895
control_files.unlock()
896
return self.open(a_bzrdir, _found=True, )
899
super(BzrBranchFormat5, self).__init__()
900
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
902
def open(self, a_bzrdir, _found=False):
903
"""Return the branch object for a_bzrdir
905
_found is a private parameter, do not use it. It is used to indicate
906
if format probing has already be done.
909
format = BranchFormat.find_format(a_bzrdir)
910
assert format.__class__ == self.__class__
911
transport = a_bzrdir.get_branch_transport(None)
912
control_files = lockable_files.LockableFiles(transport, 'lock',
914
return BzrBranch5(_format=self,
915
_control_files=control_files,
917
_repository=a_bzrdir.find_repository())
920
return "Bazaar-NG Metadir branch format 5"
923
class BranchReferenceFormat(BranchFormat):
924
"""Bzr branch reference format.
926
Branch references are used in implementing checkouts, they
927
act as an alias to the real branch which is at some other url.
934
def get_format_string(self):
935
"""See BranchFormat.get_format_string()."""
936
return "Bazaar-NG Branch Reference Format 1\n"
938
def get_format_description(self):
939
"""See BranchFormat.get_format_description()."""
940
return "Checkout reference format 1"
942
def initialize(self, a_bzrdir, target_branch=None):
943
"""Create a branch of this format in a_bzrdir."""
944
if target_branch is None:
945
# this format does not implement branch itself, thus the implicit
946
# creation contract must see it as uninitializable
947
raise errors.UninitializableFormat(self)
948
mutter('creating branch reference in %s', a_bzrdir.transport.base)
949
branch_transport = a_bzrdir.get_branch_transport(self)
950
branch_transport.put_bytes('location',
951
target_branch.bzrdir.root_transport.base)
952
branch_transport.put_bytes('format', self.get_format_string())
953
return self.open(a_bzrdir, _found=True)
956
super(BranchReferenceFormat, self).__init__()
957
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
959
def _make_reference_clone_function(format, a_branch):
960
"""Create a clone() routine for a branch dynamically."""
961
def clone(to_bzrdir, revision_id=None):
962
"""See Branch.clone()."""
963
return format.initialize(to_bzrdir, a_branch)
964
# cannot obey revision_id limits when cloning a reference ...
965
# FIXME RBC 20060210 either nuke revision_id for clone, or
966
# emit some sort of warning/error to the caller ?!
969
def open(self, a_bzrdir, _found=False):
970
"""Return the branch that the branch reference in a_bzrdir points at.
972
_found is a private parameter, do not use it. It is used to indicate
973
if format probing has already be done.
976
format = BranchFormat.find_format(a_bzrdir)
977
assert format.__class__ == self.__class__
978
transport = a_bzrdir.get_branch_transport(None)
979
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
980
result = real_bzrdir.open_branch()
981
# this changes the behaviour of result.clone to create a new reference
982
# rather than a copy of the content of the branch.
983
# I did not use a proxy object because that needs much more extensive
984
# testing, and we are only changing one behaviour at the moment.
985
# If we decide to alter more behaviours - i.e. the implicit nickname
986
# then this should be refactored to introduce a tested proxy branch
987
# and a subclass of that for use in overriding clone() and ....
989
result.clone = self._make_reference_clone_function(result)
993
# formats which have no format string are not discoverable
994
# and not independently creatable, so are not registered.
995
__default_format = BzrBranchFormat5()
996
BranchFormat.register_format(__default_format)
997
BranchFormat.register_format(BranchReferenceFormat())
998
BranchFormat.set_default_format(__default_format)
999
_legacy_formats = [BzrBranchFormat4(),
1002
class BzrBranch(Branch):
1003
"""A branch stored in the actual filesystem.
1005
Note that it's "local" in the context of the filesystem; it doesn't
1006
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1007
it's writable, and can be accessed via the normal filesystem API.
1010
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1011
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1012
_control_files=None, a_bzrdir=None, _repository=None):
1013
"""Create new branch object at a particular location.
1015
transport -- A Transport object, defining how to access files.
1017
init -- If True, create new control files in a previously
1018
unversioned directory. If False, the branch must already
1021
relax_version_check -- If true, the usual check for the branch
1022
version is not applied. This is intended only for
1023
upgrade/recovery type use; it's not guaranteed that
1024
all operations will work on old format branches.
1026
if a_bzrdir is None:
1027
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1029
self.bzrdir = a_bzrdir
1030
self._transport = self.bzrdir.transport.clone('..')
1031
self._base = self._transport.base
1032
self._format = _format
1033
if _control_files is None:
1034
raise ValueError('BzrBranch _control_files is None')
1035
self.control_files = _control_files
1036
if deprecated_passed(init):
1037
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1038
"deprecated as of bzr 0.8. Please use Branch.create().",
1042
# this is slower than before deprecation, oh well never mind.
1043
# -> its deprecated.
1044
self._initialize(transport.base)
1045
self._check_format(_format)
1046
if deprecated_passed(relax_version_check):
1047
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1048
"relax_version_check parameter is deprecated as of bzr 0.8. "
1049
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1053
if (not relax_version_check
1054
and not self._format.is_supported()):
1055
raise errors.UnsupportedFormatError(format=fmt)
1056
if deprecated_passed(transport):
1057
warn("BzrBranch.__init__(transport=XXX...): The transport "
1058
"parameter is deprecated as of bzr 0.8. "
1059
"Please use Branch.open, or bzrdir.open_branch().",
1062
self.repository = _repository
1065
return '%s(%r)' % (self.__class__.__name__, self.base)
1069
def _get_base(self):
1072
base = property(_get_base, doc="The URL for the root of this branch.")
1074
def _finish_transaction(self):
1075
"""Exit the current transaction."""
1076
return self.control_files._finish_transaction()
1078
def get_transaction(self):
1079
"""Return the current active transaction.
1081
If no transaction is active, this returns a passthrough object
1082
for which all data is immediately flushed and no caching happens.
1084
# this is an explicit function so that we can do tricky stuff
1085
# when the storage in rev_storage is elsewhere.
1086
# we probably need to hook the two 'lock a location' and
1087
# 'have a transaction' together more delicately, so that
1088
# we can have two locks (branch and storage) and one transaction
1089
# ... and finishing the transaction unlocks both, but unlocking
1090
# does not. - RBC 20051121
1091
return self.control_files.get_transaction()
1093
def _set_transaction(self, transaction):
1094
"""Set a new active transaction."""
1095
return self.control_files._set_transaction(transaction)
1097
def abspath(self, name):
1098
"""See Branch.abspath."""
1099
return self.control_files._transport.abspath(name)
1101
def _check_format(self, format):
1102
"""Identify the branch format if needed.
1104
The format is stored as a reference to the format object in
1105
self._format for code that needs to check it later.
1107
The format parameter is either None or the branch format class
1108
used to open this branch.
1110
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1113
format = BranchFormat.find_format(self.bzrdir)
1114
self._format = format
1115
mutter("got branch format %s", self._format)
1118
def get_root_id(self):
1119
"""See Branch.get_root_id."""
1120
tree = self.repository.revision_tree(self.last_revision())
1121
return tree.inventory.root.file_id
1123
def is_locked(self):
1124
return self.control_files.is_locked()
1126
def lock_write(self):
1127
self.repository.lock_write()
1129
self.control_files.lock_write()
1131
self.repository.unlock()
1134
def lock_read(self):
1135
self.repository.lock_read()
1137
self.control_files.lock_read()
1139
self.repository.unlock()
1143
# TODO: test for failed two phase locks. This is known broken.
1145
self.control_files.unlock()
1147
self.repository.unlock()
1149
def peek_lock_mode(self):
1150
if self.control_files._lock_count == 0:
1153
return self.control_files._lock_mode
1155
def get_physical_lock_status(self):
1156
return self.control_files.get_physical_lock_status()
1159
def print_file(self, file, revision_id):
1160
"""See Branch.print_file."""
1161
return self.repository.print_file(file, revision_id)
1164
def append_revision(self, *revision_ids):
1165
"""See Branch.append_revision."""
1166
for revision_id in revision_ids:
1167
_mod_revision.check_not_reserved_id(revision_id)
1168
mutter("add {%s} to revision-history" % revision_id)
1169
rev_history = self.revision_history()
1170
rev_history.extend(revision_ids)
1171
self.set_revision_history(rev_history)
1174
def set_revision_history(self, rev_history):
1175
"""See Branch.set_revision_history."""
1176
self.control_files.put_utf8(
1177
'revision-history', '\n'.join(rev_history))
1178
transaction = self.get_transaction()
1179
history = transaction.map.find_revision_history()
1180
if history is not None:
1181
# update the revision history in the identity map.
1182
history[:] = list(rev_history)
1183
# this call is disabled because revision_history is
1184
# not really an object yet, and the transaction is for objects.
1185
# transaction.register_dirty(history)
1187
transaction.map.add_revision_history(rev_history)
1188
# this call is disabled because revision_history is
1189
# not really an object yet, and the transaction is for objects.
1190
# transaction.register_clean(history)
1191
for hook in Branch.hooks['set_rh']:
1192
hook(self, rev_history)
1195
def revision_history(self):
1196
"""See Branch.revision_history."""
1197
transaction = self.get_transaction()
1198
history = transaction.map.find_revision_history()
1199
if history is not None:
1200
# mutter("cache hit for revision-history in %s", self)
1201
return list(history)
1202
decode_utf8 = cache_utf8.decode
1203
history = [decode_utf8(l.rstrip('\r\n')) for l in
1204
self.control_files.get('revision-history').readlines()]
1205
transaction.map.add_revision_history(history)
1206
# this call is disabled because revision_history is
1207
# not really an object yet, and the transaction is for objects.
1208
# transaction.register_clean(history, precious=True)
1209
return list(history)
1212
def generate_revision_history(self, revision_id, last_rev=None,
1214
"""Create a new revision history that will finish with revision_id.
1216
:param revision_id: the new tip to use.
1217
:param last_rev: The previous last_revision. If not None, then this
1218
must be a ancestory of revision_id, or DivergedBranches is raised.
1219
:param other_branch: The other branch that DivergedBranches should
1220
raise with respect to.
1222
# stop_revision must be a descendant of last_revision
1223
stop_graph = self.repository.get_revision_graph(revision_id)
1224
if last_rev is not None and last_rev not in stop_graph:
1225
# our previous tip is not merged into stop_revision
1226
raise errors.DivergedBranches(self, other_branch)
1227
# make a new revision history from the graph
1228
current_rev_id = revision_id
1230
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1231
new_history.append(current_rev_id)
1232
current_rev_id_parents = stop_graph[current_rev_id]
1234
current_rev_id = current_rev_id_parents[0]
1236
current_rev_id = None
1237
new_history.reverse()
1238
self.set_revision_history(new_history)
1241
def update_revisions(self, other, stop_revision=None):
1242
"""See Branch.update_revisions."""
1245
if stop_revision is None:
1246
stop_revision = other.last_revision()
1247
if stop_revision is None:
1248
# if there are no commits, we're done.
1250
# whats the current last revision, before we fetch [and change it
1252
last_rev = self.last_revision()
1253
# we fetch here regardless of whether we need to so that we pickup
1255
self.fetch(other, stop_revision)
1256
my_ancestry = self.repository.get_ancestry(last_rev)
1257
if stop_revision in my_ancestry:
1258
# last_revision is a descendant of stop_revision
1260
self.generate_revision_history(stop_revision, last_rev=last_rev,
1265
def basis_tree(self):
1266
"""See Branch.basis_tree."""
1267
return self.repository.revision_tree(self.last_revision())
1269
@deprecated_method(zero_eight)
1270
def working_tree(self):
1271
"""Create a Working tree object for this branch."""
1273
from bzrlib.transport.local import LocalTransport
1274
if (self.base.find('://') != -1 or
1275
not isinstance(self._transport, LocalTransport)):
1276
raise NoWorkingTree(self.base)
1277
return self.bzrdir.open_workingtree()
1280
def pull(self, source, overwrite=False, stop_revision=None,
1281
_hook_master=None, _run_hooks=True):
1284
:param _hook_master: Private parameter - set the branch to
1285
be supplied as the master to push hooks.
1286
:param _run_hooks: Private parameter - allow disabling of
1287
hooks, used when pushing to a master branch.
1291
old_count, old_tip = self.last_revision_info()
1293
self.update_revisions(source, stop_revision)
1294
except DivergedBranches:
1298
self.set_revision_history(source.revision_history())
1299
new_count, new_tip = self.last_revision_info()
1306
for hook in Branch.hooks['post_pull']:
1307
hook(source, _hook_local, _hook_master, old_count, old_tip,
1309
return new_count - old_count
1314
def push(self, target, overwrite=False, stop_revision=None,
1315
_hook_master=None, _run_hooks=True):
1318
:param _hook_master: Private parameter - set the branch to
1319
be supplied as the master to push hooks.
1320
:param _run_hooks: Private parameter - allow disabling of
1321
hooks, used when pushing to a master branch.
1325
old_count, old_tip = target.last_revision_info()
1327
target.update_revisions(self, stop_revision)
1328
except DivergedBranches:
1332
target.set_revision_history(self.revision_history())
1333
new_count, new_tip = target.last_revision_info()
1336
_hook_local = target
1338
_hook_master = target
1340
for hook in Branch.hooks['post_push']:
1341
hook(self, _hook_local, _hook_master, old_count, old_tip,
1343
return new_count - old_count
1347
def get_parent(self):
1348
"""See Branch.get_parent."""
1350
_locs = ['parent', 'pull', 'x-pull']
1351
assert self.base[-1] == '/'
1354
parent = self.control_files.get(l).read().strip('\n')
1357
# This is an old-format absolute path to a local branch
1358
# turn it into a url
1359
if parent.startswith('/'):
1360
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1362
return urlutils.join(self.base[:-1], parent)
1363
except errors.InvalidURLJoin, e:
1364
raise errors.InaccessibleParent(parent, self.base)
1367
def get_push_location(self):
1368
"""See Branch.get_push_location."""
1369
push_loc = self.get_config().get_user_option('push_location')
1372
def set_push_location(self, location):
1373
"""See Branch.set_push_location."""
1374
self.get_config().set_user_option(
1375
'push_location', location,
1376
store=_mod_config.STORE_LOCATION_NORECURSE)
1379
def set_parent(self, url):
1380
"""See Branch.set_parent."""
1381
# TODO: Maybe delete old location files?
1382
# URLs should never be unicode, even on the local fs,
1383
# FIXUP this and get_parent in a future branch format bump:
1384
# read and rewrite the file, and have the new format code read
1385
# using .get not .get_utf8. RBC 20060125
1387
self.control_files._transport.delete('parent')
1389
if isinstance(url, unicode):
1391
url = url.encode('ascii')
1392
except UnicodeEncodeError:
1393
raise bzrlib.errors.InvalidURL(url,
1394
"Urls must be 7-bit ascii, "
1395
"use bzrlib.urlutils.escape")
1397
url = urlutils.relative_url(self.base, url)
1398
self.control_files.put('parent', StringIO(url + '\n'))
1400
@deprecated_function(zero_nine)
1401
def tree_config(self):
1402
"""DEPRECATED; call get_config instead.
1403
TreeConfig has become part of BranchConfig."""
1404
return TreeConfig(self)
1407
class BzrBranch5(BzrBranch):
1408
"""A format 5 branch. This supports new features over plan branches.
1410
It has support for a master_branch which is the data for bound branches.
1418
super(BzrBranch5, self).__init__(_format=_format,
1419
_control_files=_control_files,
1421
_repository=_repository)
1424
def pull(self, source, overwrite=False, stop_revision=None,
1426
"""Extends branch.pull to be bound branch aware.
1428
:param _run_hooks: Private parameter used to force hook running
1429
off during bound branch double-pushing.
1431
bound_location = self.get_bound_location()
1432
master_branch = None
1433
if bound_location and source.base != bound_location:
1434
# not pulling from master, so we need to update master.
1435
master_branch = self.get_master_branch()
1436
master_branch.lock_write()
1439
# pull from source into master.
1440
master_branch.pull(source, overwrite, stop_revision,
1442
return super(BzrBranch5, self).pull(source, overwrite,
1443
stop_revision, _hook_master=master_branch,
1444
_run_hooks=_run_hooks)
1447
master_branch.unlock()
1450
def push(self, target, overwrite=False, stop_revision=None):
1451
"""Updates branch.push to be bound branch aware."""
1452
bound_location = target.get_bound_location()
1453
master_branch = None
1454
if bound_location and target.base != bound_location:
1455
# not pushing to master, so we need to update master.
1456
master_branch = target.get_master_branch()
1457
master_branch.lock_write()
1460
# push into the master from this branch.
1461
super(BzrBranch5, self).push(master_branch, overwrite,
1462
stop_revision, _run_hooks=False)
1463
# and push into the target branch from this. Note that we push from
1464
# this branch again, because its considered the highest bandwidth
1466
return super(BzrBranch5, self).push(target, overwrite,
1467
stop_revision, _hook_master=master_branch)
1470
master_branch.unlock()
1472
def get_bound_location(self):
1474
return self.control_files.get_utf8('bound').read()[:-1]
1475
except errors.NoSuchFile:
1479
def get_master_branch(self):
1480
"""Return the branch we are bound to.
1482
:return: Either a Branch, or None
1484
This could memoise the branch, but if thats done
1485
it must be revalidated on each new lock.
1486
So for now we just don't memoise it.
1487
# RBC 20060304 review this decision.
1489
bound_loc = self.get_bound_location()
1493
return Branch.open(bound_loc)
1494
except (errors.NotBranchError, errors.ConnectionError), e:
1495
raise errors.BoundBranchConnectionFailure(
1499
def set_bound_location(self, location):
1500
"""Set the target where this branch is bound to.
1502
:param location: URL to the target branch
1505
self.control_files.put_utf8('bound', location+'\n')
1508
self.control_files._transport.delete('bound')
1514
def bind(self, other):
1515
"""Bind this branch to the branch other.
1517
This does not push or pull data between the branches, though it does
1518
check for divergence to raise an error when the branches are not
1519
either the same, or one a prefix of the other. That behaviour may not
1520
be useful, so that check may be removed in future.
1522
:param other: The branch to bind to
1525
# TODO: jam 20051230 Consider checking if the target is bound
1526
# It is debatable whether you should be able to bind to
1527
# a branch which is itself bound.
1528
# Committing is obviously forbidden,
1529
# but binding itself may not be.
1530
# Since we *have* to check at commit time, we don't
1531
# *need* to check here
1533
# we want to raise diverged if:
1534
# last_rev is not in the other_last_rev history, AND
1535
# other_last_rev is not in our history, and do it without pulling
1537
last_rev = self.last_revision()
1538
if last_rev is not None:
1541
other_last_rev = other.last_revision()
1542
if other_last_rev is not None:
1543
# neither branch is new, we have to do some work to
1544
# ascertain diversion.
1545
remote_graph = other.repository.get_revision_graph(
1547
local_graph = self.repository.get_revision_graph(last_rev)
1548
if (last_rev not in remote_graph and
1549
other_last_rev not in local_graph):
1550
raise errors.DivergedBranches(self, other)
1553
self.set_bound_location(other.base)
1557
"""If bound, unbind"""
1558
return self.set_bound_location(None)
1562
"""Synchronise this branch with the master branch if any.
1564
:return: None or the last_revision that was pivoted out during the
1567
master = self.get_master_branch()
1568
if master is not None:
1569
old_tip = self.last_revision()
1570
self.pull(master, overwrite=True)
1571
if old_tip in self.repository.get_ancestry(self.last_revision()):
1577
class BranchTestProviderAdapter(object):
1578
"""A tool to generate a suite testing multiple branch formats at once.
1580
This is done by copying the test once for each transport and injecting
1581
the transport_server, transport_readonly_server, and branch_format
1582
classes into each copy. Each copy is also given a new id() to make it
1586
def __init__(self, transport_server, transport_readonly_server, formats):
1587
self._transport_server = transport_server
1588
self._transport_readonly_server = transport_readonly_server
1589
self._formats = formats
1591
def adapt(self, test):
1592
result = TestSuite()
1593
for branch_format, bzrdir_format in self._formats:
1594
new_test = deepcopy(test)
1595
new_test.transport_server = self._transport_server
1596
new_test.transport_readonly_server = self._transport_readonly_server
1597
new_test.bzrdir_format = bzrdir_format
1598
new_test.branch_format = branch_format
1599
def make_new_test_id():
1600
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1601
return lambda: new_id
1602
new_test.id = make_new_test_id()
1603
result.addTest(new_test)
1607
class BranchCheckResult(object):
1608
"""Results of checking branch consistency.
1613
def __init__(self, branch):
1614
self.branch = branch
1616
def report_results(self, verbose):
1617
"""Report the check results via trace.note.
1619
:param verbose: Requests more detailed display of what was checked,
1622
note('checked branch %s format %s',
1624
self.branch._format)
1627
######################################################################
1631
@deprecated_function(zero_eight)
1632
def is_control_file(*args, **kwargs):
1633
"""See bzrlib.workingtree.is_control_file."""
1634
from bzrlib import workingtree
1635
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
