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
34
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
46
HistoryMissing, InvalidRevisionId,
47
InvalidRevisionNumber, LockError, NoSuchFile,
48
NoSuchRevision, NoWorkingTree, NotVersionedError,
49
NotBranchError, UninitializableFormat,
50
UnlistableStore, UnlistableBranch,
52
from bzrlib.symbol_versioning import (deprecated_function,
56
zero_eight, zero_nine,
58
from bzrlib.trace import mutter, note
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
# this is really an instance variable - FIXME move it there
88
def __init__(self, *ignored, **ignored_too):
89
raise NotImplementedError('The Branch class is abstract')
92
"""Break a lock if one is present from another instance.
94
Uses the ui factory to ask for confirmation if the lock may be from
97
This will probe the repository for its lock as well.
99
self.control_files.break_lock()
100
self.repository.break_lock()
101
master = self.get_master_branch()
102
if master is not None:
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
113
"""Open the branch rooted at base.
115
For instance, if the branch is at URL/.bzr/branch,
116
Branch.open(URL) -> a Branch instance.
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
@deprecated_function(zero_eight)
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
151
NOTE: This is unused.
155
def get_config(self):
156
return BranchConfig(self)
159
return self.get_config().get_nickname()
161
def _set_nick(self, nick):
162
self.get_config().set_user_option('nickname', nick)
164
nick = property(_get_nick, _set_nick)
167
raise NotImplementedError(self.is_locked)
169
def lock_write(self):
170
raise NotImplementedError(self.lock_write)
173
raise NotImplementedError(self.lock_read)
176
raise NotImplementedError(self.unlock)
178
def peek_lock_mode(self):
179
"""Return lock mode for the Branch: 'r', 'w' or None"""
180
raise NotImplementedError(self.peek_lock_mode)
182
def get_physical_lock_status(self):
183
raise NotImplementedError(self.get_physical_lock_status)
185
def abspath(self, name):
186
"""Return absolute filename for something in the branch
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
method and not a tree method.
191
raise NotImplementedError(self.abspath)
193
def bind(self, other):
194
"""Bind the local branch the other branch.
196
:param other: The branch to bind to
199
raise errors.UpgradeRequired(self.base)
202
def fetch(self, from_branch, last_revision=None, pb=None):
203
"""Copy revisions from from_branch into this branch.
205
:param from_branch: Where to copy from.
206
:param last_revision: What revision to stop at (None for at the end
208
:param pb: An optional progress bar to use.
210
Returns the copied revision count and the failed revisions in a tuple:
213
if self.base == from_branch.base:
216
nested_pb = ui.ui_factory.nested_progress_bar()
221
from_branch.lock_read()
223
if last_revision is None:
224
pb.update('get source history')
225
from_history = from_branch.revision_history()
227
last_revision = from_history[-1]
229
# no history in the source branch
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_commit_builder(self, parents, config=None, timestamp=None,
248
timezone=None, committer=None, revprops=None,
250
"""Obtain a CommitBuilder for this branch.
252
:param parents: Revision ids of the parents of the new revision.
253
:param config: Optional configuration to use.
254
:param timestamp: Optional timestamp recorded for commit.
255
:param timezone: Optional timezone for timestamp.
256
:param committer: Optional committer to set for commit.
257
:param revprops: Optional dictionary of revision properties.
258
:param revision_id: Optional revision id.
262
config = self.get_config()
264
return self.repository.get_commit_builder(self, parents, config,
265
timestamp, timezone, committer, revprops, revision_id)
267
def get_master_branch(self):
268
"""Return the branch we are bound to.
270
:return: Either a Branch, or None
274
def get_revision_delta(self, revno):
275
"""Return the delta for one revision.
277
The delta is relative to its mainline predecessor, or the
278
empty tree for revision 1.
280
assert isinstance(revno, int)
281
rh = self.revision_history()
282
if not (1 <= revno <= len(rh)):
283
raise InvalidRevisionNumber(revno)
284
return self.repository.get_revision_delta(rh[revno-1])
286
def get_root_id(self):
287
"""Return the id of this branches root"""
288
raise NotImplementedError(self.get_root_id)
290
def print_file(self, file, revision_id):
291
"""Print `file` to stdout."""
292
raise NotImplementedError(self.print_file)
294
def append_revision(self, *revision_ids):
295
raise NotImplementedError(self.append_revision)
297
def set_revision_history(self, rev_history):
298
raise NotImplementedError(self.set_revision_history)
300
def revision_history(self):
301
"""Return sequence of revision hashes on to this branch."""
302
raise NotImplementedError('revision_history is abstract')
305
"""Return current revision number for this branch.
307
That is equivalent to the number of revisions committed to
310
return len(self.revision_history())
313
"""Older format branches cannot bind or unbind."""
314
raise errors.UpgradeRequired(self.base)
316
def last_revision(self):
317
"""Return last revision id, or None"""
318
ph = self.revision_history()
324
def missing_revisions(self, other, stop_revision=None):
325
"""Return a list of new revisions that would perfectly fit.
327
If self and other have not diverged, return a list of the revisions
328
present in other, but missing from self.
330
self_history = self.revision_history()
331
self_len = len(self_history)
332
other_history = other.revision_history()
333
other_len = len(other_history)
334
common_index = min(self_len, other_len) -1
335
if common_index >= 0 and \
336
self_history[common_index] != other_history[common_index]:
337
raise DivergedBranches(self, other)
339
if stop_revision is None:
340
stop_revision = other_len
342
assert isinstance(stop_revision, int)
343
if stop_revision > other_len:
344
raise errors.NoSuchRevision(self, stop_revision)
345
return other_history[self_len:stop_revision]
347
def update_revisions(self, other, stop_revision=None):
348
"""Pull in new perfect-fit revisions.
350
:param other: Another Branch to pull from
351
:param stop_revision: Updated until the given revision
354
raise NotImplementedError(self.update_revisions)
356
def revision_id_to_revno(self, revision_id):
357
"""Given a revision id, return its revno"""
358
if revision_id is None:
360
history = self.revision_history()
362
return history.index(revision_id) + 1
364
raise bzrlib.errors.NoSuchRevision(self, revision_id)
366
def get_rev_id(self, revno, history=None):
367
"""Find the revision id of the specified revno."""
371
history = self.revision_history()
372
if revno <= 0 or revno > len(history):
373
raise bzrlib.errors.NoSuchRevision(self, revno)
374
return history[revno - 1]
376
def pull(self, source, overwrite=False, stop_revision=None):
377
raise NotImplementedError(self.pull)
379
def basis_tree(self):
380
"""Return `Tree` object for last revision."""
381
return self.repository.revision_tree(self.last_revision())
383
def rename_one(self, from_rel, to_rel):
386
This can change the directory or the filename or both.
388
raise NotImplementedError(self.rename_one)
390
def move(self, from_paths, to_name):
393
to_name must exist as a versioned directory.
395
If to_name exists and is a directory, the files are moved into
396
it, keeping their old names. If it is a directory,
398
Note that to_name is only the last component of the new name;
399
this doesn't change the directory.
401
This returns a list of (from_path, to_path) pairs for each
404
raise NotImplementedError(self.move)
406
def get_parent(self):
407
"""Return the parent location of the branch.
409
This is the default location for push/pull/missing. The usual
410
pattern is that the user can override it by specifying a
413
raise NotImplementedError(self.get_parent)
415
def get_submit_branch(self):
416
"""Return the submit location of the branch.
418
This is the default location for bundle. The usual
419
pattern is that the user can override it by specifying a
422
return self.get_config().get_user_option('submit_branch')
424
def set_submit_branch(self, location):
425
"""Return the submit location of the branch.
427
This is the default location for bundle. The usual
428
pattern is that the user can override it by specifying a
431
self.get_config().set_user_option('submit_branch', location)
433
def get_push_location(self):
434
"""Return the None or the location to push this branch to."""
435
raise NotImplementedError(self.get_push_location)
437
def set_push_location(self, location):
438
"""Set a new push location for this branch."""
439
raise NotImplementedError(self.set_push_location)
441
def set_parent(self, url):
442
raise NotImplementedError(self.set_parent)
446
"""Synchronise this branch with the master branch if any.
448
:return: None or the last_revision pivoted out during the update.
452
def check_revno(self, revno):
454
Check whether a revno corresponds to any revision.
455
Zero (the NULL revision) is considered valid.
458
self.check_real_revno(revno)
460
def check_real_revno(self, revno):
462
Check whether a revno corresponds to a real revision.
463
Zero (the NULL revision) is considered invalid
465
if revno < 1 or revno > self.revno():
466
raise InvalidRevisionNumber(revno)
469
def clone(self, *args, **kwargs):
470
"""Clone this branch into to_bzrdir preserving all semantic values.
472
revision_id: if not None, the revision history in the new branch will
473
be truncated to end with revision_id.
475
# for API compatibility, until 0.8 releases we provide the old api:
476
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
477
# after 0.8 releases, the *args and **kwargs should be changed:
478
# def clone(self, to_bzrdir, revision_id=None):
479
if (kwargs.get('to_location', None) or
480
kwargs.get('revision', None) or
481
kwargs.get('basis_branch', None) or
482
(len(args) and isinstance(args[0], basestring))):
483
# backwards compatibility api:
484
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
485
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
488
basis_branch = args[2]
490
basis_branch = kwargs.get('basis_branch', None)
492
basis = basis_branch.bzrdir
497
revision_id = args[1]
499
revision_id = kwargs.get('revision', None)
504
# no default to raise if not provided.
505
url = kwargs.get('to_location')
506
return self.bzrdir.clone(url,
507
revision_id=revision_id,
508
basis=basis).open_branch()
510
# generate args by hand
512
revision_id = args[1]
514
revision_id = kwargs.get('revision_id', None)
518
# no default to raise if not provided.
519
to_bzrdir = kwargs.get('to_bzrdir')
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
525
def sprout(self, to_bzrdir, revision_id=None):
526
"""Create a new line of development from the branch, into to_bzrdir.
528
revision_id: if not None, the revision history in the new branch will
529
be truncated to end with revision_id.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id=revision_id)
533
result.set_parent(self.bzrdir.root_transport.base)
537
def copy_content_into(self, destination, revision_id=None):
538
"""Copy the content of self into destination.
540
revision_id: if not None, the revision history in the new branch will
541
be truncated to end with revision_id.
543
new_history = self.revision_history()
544
if revision_id is not None:
546
new_history = new_history[:new_history.index(revision_id) + 1]
548
rev = self.repository.get_revision(revision_id)
549
new_history = rev.get_history(self.repository)[1:]
550
destination.set_revision_history(new_history)
552
parent = self.get_parent()
553
except errors.InaccessibleParent, e:
554
mutter('parent was not accessible to copy: %s', e)
557
destination.set_parent(parent)
561
"""Check consistency of the branch.
563
In particular this checks that revisions given in the revision-history
564
do actually match up in the revision graph, and that they're all
565
present in the repository.
567
Callers will typically also want to check the repository.
569
:return: A BranchCheckResult.
571
mainline_parent_id = None
572
for revision_id in self.revision_history():
574
revision = self.repository.get_revision(revision_id)
575
except errors.NoSuchRevision, e:
576
raise errors.BzrCheckError("mainline revision {%s} not in repository"
578
# In general the first entry on the revision history has no parents.
579
# But it's not illegal for it to have parents listed; this can happen
580
# in imports from Arch when the parents weren't reachable.
581
if mainline_parent_id is not None:
582
if mainline_parent_id not in revision.parent_ids:
583
raise errors.BzrCheckError("previous revision {%s} not listed among "
585
% (mainline_parent_id, revision_id))
586
mainline_parent_id = revision_id
587
return BranchCheckResult(self)
589
def create_checkout(self, to_location, revision_id=None,
591
"""Create a checkout of a branch.
593
:param to_location: The url to produce the checkout at
594
:param revision_id: The revision to check out
595
:param lightweight: If True, produce a lightweight checkout, otherwise,
596
produce a bound branch (heavyweight checkout)
597
:return: The tree of the created checkout
600
t = transport.get_transport(to_location)
603
except errors.FileExists:
605
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
606
BranchReferenceFormat().initialize(checkout, self)
608
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
609
to_location, force_new_tree=False)
610
checkout = checkout_branch.bzrdir
611
checkout_branch.bind(self)
612
if revision_id is not None:
613
rh = checkout_branch.revision_history()
614
new_rh = rh[:rh.index(revision_id) + 1]
615
checkout_branch.set_revision_history(new_rh)
616
return checkout.create_workingtree(revision_id)
619
class BranchFormat(object):
620
"""An encapsulation of the initialization and open routines for a format.
622
Formats provide three things:
623
* An initialization routine,
627
Formats are placed in an dict by their format string for reference
628
during branch opening. Its not required that these be instances, they
629
can be classes themselves with class methods - it simply depends on
630
whether state is needed for a given format or not.
632
Once a format is deprecated, just deprecate the initialize and open
633
methods on the format class. Do not deprecate the object, as the
634
object will be created every time regardless.
637
_default_format = None
638
"""The default format used for new branches."""
641
"""The known formats."""
644
def find_format(klass, a_bzrdir):
645
"""Return the format for the branch object in a_bzrdir."""
647
transport = a_bzrdir.get_branch_transport(None)
648
format_string = transport.get("format").read()
649
return klass._formats[format_string]
651
raise NotBranchError(path=transport.base)
653
raise errors.UnknownFormatError(format=format_string)
656
def get_default_format(klass):
657
"""Return the current default format."""
658
return klass._default_format
660
def get_format_string(self):
661
"""Return the ASCII format string that identifies this format."""
662
raise NotImplementedError(self.get_format_string)
664
def get_format_description(self):
665
"""Return the short format description for this format."""
666
raise NotImplementedError(self.get_format_string)
668
def initialize(self, a_bzrdir):
669
"""Create a branch of this format in a_bzrdir."""
670
raise NotImplementedError(self.initialize)
672
def is_supported(self):
673
"""Is this format supported?
675
Supported formats can be initialized and opened.
676
Unsupported formats may not support initialization or committing or
677
some other features depending on the reason for not being supported.
681
def open(self, a_bzrdir, _found=False):
682
"""Return the branch object for a_bzrdir
684
_found is a private parameter, do not use it. It is used to indicate
685
if format probing has already be done.
687
raise NotImplementedError(self.open)
690
def register_format(klass, format):
691
klass._formats[format.get_format_string()] = format
694
def set_default_format(klass, format):
695
klass._default_format = format
698
def unregister_format(klass, format):
699
assert klass._formats[format.get_format_string()] is format
700
del klass._formats[format.get_format_string()]
703
return self.get_format_string().rstrip()
706
class BzrBranchFormat4(BranchFormat):
707
"""Bzr branch format 4.
710
- a revision-history file.
711
- a branch-lock lock file [ to be shared with the bzrdir ]
714
def get_format_description(self):
715
"""See BranchFormat.get_format_description()."""
716
return "Branch format 4"
718
def initialize(self, a_bzrdir):
719
"""Create a branch of this format in a_bzrdir."""
720
mutter('creating branch in %s', a_bzrdir.transport.base)
721
branch_transport = a_bzrdir.get_branch_transport(self)
722
utf8_files = [('revision-history', ''),
725
control_files = lockable_files.LockableFiles(branch_transport,
726
'branch-lock', lockable_files.TransportLock)
727
control_files.create_lock()
728
control_files.lock_write()
730
for file, content in utf8_files:
731
control_files.put_utf8(file, content)
733
control_files.unlock()
734
return self.open(a_bzrdir, _found=True)
737
super(BzrBranchFormat4, self).__init__()
738
self._matchingbzrdir = bzrdir.BzrDirFormat6()
740
def open(self, a_bzrdir, _found=False):
741
"""Return the branch object for a_bzrdir
743
_found is a private parameter, do not use it. It is used to indicate
744
if format probing has already be done.
747
# we are being called directly and must probe.
748
raise NotImplementedError
749
return BzrBranch(_format=self,
750
_control_files=a_bzrdir._control_files,
752
_repository=a_bzrdir.open_repository())
755
return "Bazaar-NG branch format 4"
758
class BzrBranchFormat5(BranchFormat):
759
"""Bzr branch format 5.
762
- a revision-history file.
764
- a lock dir guarding the branch itself
765
- all of this stored in a branch/ subdirectory
766
- works with shared repositories.
768
This format is new in bzr 0.8.
771
def get_format_string(self):
772
"""See BranchFormat.get_format_string()."""
773
return "Bazaar-NG branch format 5\n"
775
def get_format_description(self):
776
"""See BranchFormat.get_format_description()."""
777
return "Branch format 5"
779
def initialize(self, a_bzrdir):
780
"""Create a branch of this format in a_bzrdir."""
781
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
782
branch_transport = a_bzrdir.get_branch_transport(self)
783
utf8_files = [('revision-history', ''),
786
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
788
control_files.create_lock()
789
control_files.lock_write()
790
control_files.put_utf8('format', self.get_format_string())
792
for file, content in utf8_files:
793
control_files.put_utf8(file, content)
795
control_files.unlock()
796
return self.open(a_bzrdir, _found=True, )
799
super(BzrBranchFormat5, self).__init__()
800
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
802
def open(self, a_bzrdir, _found=False):
803
"""Return the branch object for a_bzrdir
805
_found is a private parameter, do not use it. It is used to indicate
806
if format probing has already be done.
809
format = BranchFormat.find_format(a_bzrdir)
810
assert format.__class__ == self.__class__
811
transport = a_bzrdir.get_branch_transport(None)
812
control_files = lockable_files.LockableFiles(transport, 'lock',
814
return BzrBranch5(_format=self,
815
_control_files=control_files,
817
_repository=a_bzrdir.find_repository())
820
return "Bazaar-NG Metadir branch format 5"
823
class BranchReferenceFormat(BranchFormat):
824
"""Bzr branch reference format.
826
Branch references are used in implementing checkouts, they
827
act as an alias to the real branch which is at some other url.
834
def get_format_string(self):
835
"""See BranchFormat.get_format_string()."""
836
return "Bazaar-NG Branch Reference Format 1\n"
838
def get_format_description(self):
839
"""See BranchFormat.get_format_description()."""
840
return "Checkout reference format 1"
842
def initialize(self, a_bzrdir, target_branch=None):
843
"""Create a branch of this format in a_bzrdir."""
844
if target_branch is None:
845
# this format does not implement branch itself, thus the implicit
846
# creation contract must see it as uninitializable
847
raise errors.UninitializableFormat(self)
848
mutter('creating branch reference in %s', a_bzrdir.transport.base)
849
branch_transport = a_bzrdir.get_branch_transport(self)
850
branch_transport.put_bytes('location',
851
target_branch.bzrdir.root_transport.base)
852
branch_transport.put_bytes('format', self.get_format_string())
853
return self.open(a_bzrdir, _found=True)
856
super(BranchReferenceFormat, self).__init__()
857
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
859
def _make_reference_clone_function(format, a_branch):
860
"""Create a clone() routine for a branch dynamically."""
861
def clone(to_bzrdir, revision_id=None):
862
"""See Branch.clone()."""
863
return format.initialize(to_bzrdir, a_branch)
864
# cannot obey revision_id limits when cloning a reference ...
865
# FIXME RBC 20060210 either nuke revision_id for clone, or
866
# emit some sort of warning/error to the caller ?!
869
def open(self, a_bzrdir, _found=False):
870
"""Return the branch that the branch reference in a_bzrdir points at.
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
876
format = BranchFormat.find_format(a_bzrdir)
877
assert format.__class__ == self.__class__
878
transport = a_bzrdir.get_branch_transport(None)
879
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
880
result = real_bzrdir.open_branch()
881
# this changes the behaviour of result.clone to create a new reference
882
# rather than a copy of the content of the branch.
883
# I did not use a proxy object because that needs much more extensive
884
# testing, and we are only changing one behaviour at the moment.
885
# If we decide to alter more behaviours - i.e. the implicit nickname
886
# then this should be refactored to introduce a tested proxy branch
887
# and a subclass of that for use in overriding clone() and ....
889
result.clone = self._make_reference_clone_function(result)
893
# formats which have no format string are not discoverable
894
# and not independently creatable, so are not registered.
895
__default_format = BzrBranchFormat5()
896
BranchFormat.register_format(__default_format)
897
BranchFormat.register_format(BranchReferenceFormat())
898
BranchFormat.set_default_format(__default_format)
899
_legacy_formats = [BzrBranchFormat4(),
902
class BzrBranch(Branch):
903
"""A branch stored in the actual filesystem.
905
Note that it's "local" in the context of the filesystem; it doesn't
906
really matter if it's on an nfs/smb/afs/coda/... share, as long as
907
it's writable, and can be accessed via the normal filesystem API.
910
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
911
relax_version_check=DEPRECATED_PARAMETER, _format=None,
912
_control_files=None, a_bzrdir=None, _repository=None):
913
"""Create new branch object at a particular location.
915
transport -- A Transport object, defining how to access files.
917
init -- If True, create new control files in a previously
918
unversioned directory. If False, the branch must already
921
relax_version_check -- If true, the usual check for the branch
922
version is not applied. This is intended only for
923
upgrade/recovery type use; it's not guaranteed that
924
all operations will work on old format branches.
927
self.bzrdir = bzrdir.BzrDir.open(transport.base)
929
self.bzrdir = a_bzrdir
930
self._transport = self.bzrdir.transport.clone('..')
931
self._base = self._transport.base
932
self._format = _format
933
if _control_files is None:
934
raise ValueError('BzrBranch _control_files is None')
935
self.control_files = _control_files
936
if deprecated_passed(init):
937
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
938
"deprecated as of bzr 0.8. Please use Branch.create().",
942
# this is slower than before deprecation, oh well never mind.
944
self._initialize(transport.base)
945
self._check_format(_format)
946
if deprecated_passed(relax_version_check):
947
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
948
"relax_version_check parameter is deprecated as of bzr 0.8. "
949
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
953
if (not relax_version_check
954
and not self._format.is_supported()):
955
raise errors.UnsupportedFormatError(format=fmt)
956
if deprecated_passed(transport):
957
warn("BzrBranch.__init__(transport=XXX...): The transport "
958
"parameter is deprecated as of bzr 0.8. "
959
"Please use Branch.open, or bzrdir.open_branch().",
962
self.repository = _repository
965
return '%s(%r)' % (self.__class__.__name__, self.base)
972
base = property(_get_base, doc="The URL for the root of this branch.")
974
def _finish_transaction(self):
975
"""Exit the current transaction."""
976
return self.control_files._finish_transaction()
978
def get_transaction(self):
979
"""Return the current active transaction.
981
If no transaction is active, this returns a passthrough object
982
for which all data is immediately flushed and no caching happens.
984
# this is an explicit function so that we can do tricky stuff
985
# when the storage in rev_storage is elsewhere.
986
# we probably need to hook the two 'lock a location' and
987
# 'have a transaction' together more delicately, so that
988
# we can have two locks (branch and storage) and one transaction
989
# ... and finishing the transaction unlocks both, but unlocking
990
# does not. - RBC 20051121
991
return self.control_files.get_transaction()
993
def _set_transaction(self, transaction):
994
"""Set a new active transaction."""
995
return self.control_files._set_transaction(transaction)
997
def abspath(self, name):
998
"""See Branch.abspath."""
999
return self.control_files._transport.abspath(name)
1001
def _check_format(self, format):
1002
"""Identify the branch format if needed.
1004
The format is stored as a reference to the format object in
1005
self._format for code that needs to check it later.
1007
The format parameter is either None or the branch format class
1008
used to open this branch.
1010
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1013
format = BranchFormat.find_format(self.bzrdir)
1014
self._format = format
1015
mutter("got branch format %s", self._format)
1018
def get_root_id(self):
1019
"""See Branch.get_root_id."""
1020
tree = self.repository.revision_tree(self.last_revision())
1021
return tree.inventory.root.file_id
1023
def is_locked(self):
1024
return self.control_files.is_locked()
1026
def lock_write(self):
1027
self.repository.lock_write()
1029
self.control_files.lock_write()
1031
self.repository.unlock()
1034
def lock_read(self):
1035
self.repository.lock_read()
1037
self.control_files.lock_read()
1039
self.repository.unlock()
1043
# TODO: test for failed two phase locks. This is known broken.
1045
self.control_files.unlock()
1047
self.repository.unlock()
1049
def peek_lock_mode(self):
1050
if self.control_files._lock_count == 0:
1053
return self.control_files._lock_mode
1055
def get_physical_lock_status(self):
1056
return self.control_files.get_physical_lock_status()
1059
def print_file(self, file, revision_id):
1060
"""See Branch.print_file."""
1061
return self.repository.print_file(file, revision_id)
1064
def append_revision(self, *revision_ids):
1065
"""See Branch.append_revision."""
1066
for revision_id in revision_ids:
1067
mutter("add {%s} to revision-history" % revision_id)
1068
rev_history = self.revision_history()
1069
rev_history.extend(revision_ids)
1070
self.set_revision_history(rev_history)
1073
def set_revision_history(self, rev_history):
1074
"""See Branch.set_revision_history."""
1075
self.control_files.put_utf8(
1076
'revision-history', '\n'.join(rev_history))
1077
transaction = self.get_transaction()
1078
history = transaction.map.find_revision_history()
1079
if history is not None:
1080
# update the revision history in the identity map.
1081
history[:] = list(rev_history)
1082
# this call is disabled because revision_history is
1083
# not really an object yet, and the transaction is for objects.
1084
# transaction.register_dirty(history)
1086
transaction.map.add_revision_history(rev_history)
1087
# this call is disabled because revision_history is
1088
# not really an object yet, and the transaction is for objects.
1089
# transaction.register_clean(history)
1092
def revision_history(self):
1093
"""See Branch.revision_history."""
1094
transaction = self.get_transaction()
1095
history = transaction.map.find_revision_history()
1096
if history is not None:
1097
# mutter("cache hit for revision-history in %s", self)
1098
return list(history)
1099
decode_utf8 = cache_utf8.decode
1100
history = [decode_utf8(l.rstrip('\r\n')) for l in
1101
self.control_files.get('revision-history').readlines()]
1102
transaction.map.add_revision_history(history)
1103
# this call is disabled because revision_history is
1104
# not really an object yet, and the transaction is for objects.
1105
# transaction.register_clean(history, precious=True)
1106
return list(history)
1109
def generate_revision_history(self, revision_id, last_rev=None,
1111
"""Create a new revision history that will finish with revision_id.
1113
:param revision_id: the new tip to use.
1114
:param last_rev: The previous last_revision. If not None, then this
1115
must be a ancestory of revision_id, or DivergedBranches is raised.
1116
:param other_branch: The other branch that DivergedBranches should
1117
raise with respect to.
1119
# stop_revision must be a descendant of last_revision
1120
stop_graph = self.repository.get_revision_graph(revision_id)
1121
if last_rev is not None and last_rev not in stop_graph:
1122
# our previous tip is not merged into stop_revision
1123
raise errors.DivergedBranches(self, other_branch)
1124
# make a new revision history from the graph
1125
current_rev_id = revision_id
1127
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1128
new_history.append(current_rev_id)
1129
current_rev_id_parents = stop_graph[current_rev_id]
1131
current_rev_id = current_rev_id_parents[0]
1133
current_rev_id = None
1134
new_history.reverse()
1135
self.set_revision_history(new_history)
1138
def update_revisions(self, other, stop_revision=None):
1139
"""See Branch.update_revisions."""
1142
if stop_revision is None:
1143
stop_revision = other.last_revision()
1144
if stop_revision is None:
1145
# if there are no commits, we're done.
1147
# whats the current last revision, before we fetch [and change it
1149
last_rev = self.last_revision()
1150
# we fetch here regardless of whether we need to so that we pickup
1152
self.fetch(other, stop_revision)
1153
my_ancestry = self.repository.get_ancestry(last_rev)
1154
if stop_revision in my_ancestry:
1155
# last_revision is a descendant of stop_revision
1157
self.generate_revision_history(stop_revision, last_rev=last_rev,
1162
def basis_tree(self):
1163
"""See Branch.basis_tree."""
1164
return self.repository.revision_tree(self.last_revision())
1166
@deprecated_method(zero_eight)
1167
def working_tree(self):
1168
"""Create a Working tree object for this branch."""
1170
from bzrlib.transport.local import LocalTransport
1171
if (self.base.find('://') != -1 or
1172
not isinstance(self._transport, LocalTransport)):
1173
raise NoWorkingTree(self.base)
1174
return self.bzrdir.open_workingtree()
1177
def pull(self, source, overwrite=False, stop_revision=None):
1178
"""See Branch.pull."""
1181
old_count = len(self.revision_history())
1183
self.update_revisions(source,stop_revision)
1184
except DivergedBranches:
1188
self.set_revision_history(source.revision_history())
1189
new_count = len(self.revision_history())
1190
return new_count - old_count
1194
def get_parent(self):
1195
"""See Branch.get_parent."""
1197
_locs = ['parent', 'pull', 'x-pull']
1198
assert self.base[-1] == '/'
1201
parent = self.control_files.get(l).read().strip('\n')
1204
# This is an old-format absolute path to a local branch
1205
# turn it into a url
1206
if parent.startswith('/'):
1207
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1209
return urlutils.join(self.base[:-1], parent)
1210
except errors.InvalidURLJoin, e:
1211
raise errors.InaccessibleParent(parent, self.base)
1214
def get_push_location(self):
1215
"""See Branch.get_push_location."""
1216
push_loc = self.get_config().get_user_option('push_location')
1219
def set_push_location(self, location):
1220
"""See Branch.set_push_location."""
1221
self.get_config().set_user_option('push_location', location,
1225
def set_parent(self, url):
1226
"""See Branch.set_parent."""
1227
# TODO: Maybe delete old location files?
1228
# URLs should never be unicode, even on the local fs,
1229
# FIXUP this and get_parent in a future branch format bump:
1230
# read and rewrite the file, and have the new format code read
1231
# using .get not .get_utf8. RBC 20060125
1233
self.control_files._transport.delete('parent')
1235
if isinstance(url, unicode):
1237
url = url.encode('ascii')
1238
except UnicodeEncodeError:
1239
raise bzrlib.errors.InvalidURL(url,
1240
"Urls must be 7-bit ascii, "
1241
"use bzrlib.urlutils.escape")
1243
url = urlutils.relative_url(self.base, url)
1244
self.control_files.put('parent', StringIO(url + '\n'))
1246
@deprecated_function(zero_nine)
1247
def tree_config(self):
1248
"""DEPRECATED; call get_config instead.
1249
TreeConfig has become part of BranchConfig."""
1250
return TreeConfig(self)
1253
class BzrBranch5(BzrBranch):
1254
"""A format 5 branch. This supports new features over plan branches.
1256
It has support for a master_branch which is the data for bound branches.
1264
super(BzrBranch5, self).__init__(_format=_format,
1265
_control_files=_control_files,
1267
_repository=_repository)
1270
def pull(self, source, overwrite=False, stop_revision=None):
1271
"""Updates branch.pull to be bound branch aware."""
1272
bound_location = self.get_bound_location()
1273
if source.base != bound_location:
1274
# not pulling from master, so we need to update master.
1275
master_branch = self.get_master_branch()
1277
master_branch.pull(source)
1278
source = master_branch
1279
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1281
def get_bound_location(self):
1283
return self.control_files.get_utf8('bound').read()[:-1]
1284
except errors.NoSuchFile:
1288
def get_master_branch(self):
1289
"""Return the branch we are bound to.
1291
:return: Either a Branch, or None
1293
This could memoise the branch, but if thats done
1294
it must be revalidated on each new lock.
1295
So for now we just don't memoise it.
1296
# RBC 20060304 review this decision.
1298
bound_loc = self.get_bound_location()
1302
return Branch.open(bound_loc)
1303
except (errors.NotBranchError, errors.ConnectionError), e:
1304
raise errors.BoundBranchConnectionFailure(
1308
def set_bound_location(self, location):
1309
"""Set the target where this branch is bound to.
1311
:param location: URL to the target branch
1314
self.control_files.put_utf8('bound', location+'\n')
1317
self.control_files._transport.delete('bound')
1323
def bind(self, other):
1324
"""Bind the local branch the other branch.
1326
:param other: The branch to bind to
1329
# TODO: jam 20051230 Consider checking if the target is bound
1330
# It is debatable whether you should be able to bind to
1331
# a branch which is itself bound.
1332
# Committing is obviously forbidden,
1333
# but binding itself may not be.
1334
# Since we *have* to check at commit time, we don't
1335
# *need* to check here
1338
# we are now equal to or a suffix of other.
1340
# Since we have 'pulled' from the remote location,
1341
# now we should try to pull in the opposite direction
1342
# in case the local tree has more revisions than the
1344
# There may be a different check you could do here
1345
# rather than actually trying to install revisions remotely.
1346
# TODO: capture an exception which indicates the remote branch
1348
# If it is up-to-date, this probably should not be a failure
1350
# lock other for write so the revision-history syncing cannot race
1354
# if this does not error, other now has the same last rev we do
1355
# it can only error if the pull from other was concurrent with
1356
# a commit to other from someone else.
1358
# until we ditch revision-history, we need to sync them up:
1359
self.set_revision_history(other.revision_history())
1360
# now other and self are up to date with each other and have the
1361
# same revision-history.
1365
self.set_bound_location(other.base)
1369
"""If bound, unbind"""
1370
return self.set_bound_location(None)
1374
"""Synchronise this branch with the master branch if any.
1376
:return: None or the last_revision that was pivoted out during the
1379
master = self.get_master_branch()
1380
if master is not None:
1381
old_tip = self.last_revision()
1382
self.pull(master, overwrite=True)
1383
if old_tip in self.repository.get_ancestry(self.last_revision()):
1389
class BranchTestProviderAdapter(object):
1390
"""A tool to generate a suite testing multiple branch formats at once.
1392
This is done by copying the test once for each transport and injecting
1393
the transport_server, transport_readonly_server, and branch_format
1394
classes into each copy. Each copy is also given a new id() to make it
1398
def __init__(self, transport_server, transport_readonly_server, formats):
1399
self._transport_server = transport_server
1400
self._transport_readonly_server = transport_readonly_server
1401
self._formats = formats
1403
def adapt(self, test):
1404
result = TestSuite()
1405
for branch_format, bzrdir_format in self._formats:
1406
new_test = deepcopy(test)
1407
new_test.transport_server = self._transport_server
1408
new_test.transport_readonly_server = self._transport_readonly_server
1409
new_test.bzrdir_format = bzrdir_format
1410
new_test.branch_format = branch_format
1411
def make_new_test_id():
1412
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1413
return lambda: new_id
1414
new_test.id = make_new_test_id()
1415
result.addTest(new_test)
1419
class BranchCheckResult(object):
1420
"""Results of checking branch consistency.
1425
def __init__(self, branch):
1426
self.branch = branch
1428
def report_results(self, verbose):
1429
"""Report the check results via trace.note.
1431
:param verbose: Requests more detailed display of what was checked,
1434
note('checked branch %s format %s',
1436
self.branch._format)
1439
######################################################################
1443
@deprecated_function(zero_eight)
1444
def is_control_file(*args, **kwargs):
1445
"""See bzrlib.workingtree.is_control_file."""
1446
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
